Docker

Installation Process on Docker

The installation process involves downloading the github repository, modifying the docker-compose.yaml and deploying the services.

Configure the services

Replace <YOUR SERVER HERE> on line 10 in docker-compose.yaml with your FQDN. Replace <YOUR SERVER HERE> on line 32 in docker-compose.yaml with your FQDN wrapped in either http:// and :8000 if you use as-is without a reverse proxy or in https:// and nothing after if you use a reverse proxy for ssl. Replace <DEFAULT ADMIN USERNAME> on line 33 in docker-compose.yaml with the usernane you want for the administrator account's username. Replace <DEFAULT ADMIN PASSWORD> on line 34 in docker-compose.yaml with the usernane you want for the administrator account's password.

Deploy the services

you can run this command to start the services:

docker compose up -d --build

This will deploy the api on http://:8000/, you'll probably want to instead use a reverse proxy such as nginx to handle ssl.

Huge thanks to Apostolis-Triantafyllou for adding Docker