Installation

Configure the settings and start Orlok with Docker Compose.

From the folder of the installation package, copy the example settings:

cp .env.production.example .env.production

Then fill in .env.production (all settings are listed in Environment variables):

Setting	Value
`ORLOK_PUBLIC_URL`	The address people use to open Orlok, e.g. `https://orlok.example.com`
`ORLOK_PORT`	Host port published by the app, `8080` by default
`ORLOK_SECRET_KEY`	Key that encrypts provider keys and credentials
`POSTGRES_PASSWORD`	Password of the database user
`ORLOK_RUNNER_TOKEN`	Shared token between the app and the runner

Generate the three secrets with:

openssl rand -base64 32   # ORLOK_SECRET_KEY
openssl rand -hex 24      # POSTGRES_PASSWORD
openssl rand -hex 32      # ORLOK_RUNNER_TOKEN

Store ORLOK_SECRET_KEY somewhere safe, outside the server. Without it, saved provider keys and credentials cannot be decrypted. Never commit .env.production.

Start Orlok

docker compose --env-file .env.production up -d --build

The images are built on the server, then the database starts, migrations are applied and the app begins answering on ORLOK_PORT. Check the containers with:

docker compose --env-file .env.production ps

Then put it behind HTTPS and complete the first-run setup.