outbag/server
2
1
Fork
You've already forked server
0
Did you know that you can host your own outbag instance?
  • TypeScript 85.8%
  • JavaScript 14.1%
jusax23 b4e973d73c
All checks were successful
Outbag Tests / test (push) Successful in 34s
obfuscate fix, ota login fix
2024年08月21日 18:51:29 +02:00
.gitea/workflows test action 2024年02月25日 14:43:50 +01:00
.woodpecker better inviatations + clean up 2023年03月28日 19:23:03 +02:00
docs permission update 2024年03月11日 13:52:50 +01:00
src obfuscate fix, ota login fix 2024年08月21日 18:51:29 +02:00
tests obfuscate fix, ota login fix 2024年08月21日 18:51:29 +02:00
.gitignore remote passing 2023年03月20日 16:26:06 +01:00
genSelfSignedCert.sh tests 2023年03月10日 12:44:23 +01:00
package-lock.json bug fix 2024年02月22日 21:26:13 +01:00
package.json automatic cat order 2023年03月29日 21:23:31 +02:00
readme.md missing point 2024年03月02日 17:34:35 +01:00
test.juml small fixes 2024年02月25日 13:40:35 +01:00
tsconfig.json server framework 2023年02月28日 14:44:10 +01:00

Outbag Server

Did you know that you can host your own outbag instance?

This repo contains the official outbag server.

Setup

*Keep in mind that you need a valid SSL certificate for your domain

Using docker

Find docker instructions in the docker repo

Manually

Requirements

  • git
  • nodejs & npm
  • a MySQL database, we recommend mariadb

Setting up MariaDB

Set up the Maria Database. Create a new database and a new user and grand the user all privileges to this database. For more Instructions see: Setup MariaDB

Install

  1. Clone this git repo 
    git clone https://codeberg.org/outbag/server/ outbag-server
cd outbag-server
  2. Download & install the dependencies 
    npm install

Setup

The Setup can either be done with environment variables or a config file.

See: Configure Outbag

Choosing environment variables: Set all needed environment variables from the Configure Outbag Page.

Choosing a config file: Run the Server with: -c path/to/config.juml arguments. If the config does not exist, a setup cli tool will be triggered. Enter all asked Information and double-check your config file. The setup tool can be triggered with -s at any time.

Port Forwarding & .well-known

The Outback server requires at least one forwarded TCP port. The default port is 443 or 7223.

Each Server can be identified by a server tag.

  • Main-Tag: example.com
  • Secondary-Tag: example.com:port

The app will find the server by fetching the path: /.well-known/outbag/server on example.com or example.com:port. When the user enters no port and the first one is not available the second one will be tried with the port 7223. The /.well-known/outbag/server will be automatically hosted by the server.

If your server should be accessible with the Main-Tag and is not running on port 443 or 7223 and on the path / you need to create/proxy the Well-known File at example.com or example.com:7223.

Hosting the UI

As of writing, there is no official method of having the backend host the UI yet (we are working on it).

For the time being, just follow the manual guide.

API

A documentation can be found here.