Configuration
Everything about a deployment is set in the compose.yaml you wrote during the quickstart — image, port, database and volumes. There is no hidden configuration file; docker compose config shows you exactly what will run.
Pre-1.0
Variable names may still change between pre-release versions. This page describes today's prototype; the note on every page applies here most of all.
The knobs
| Purpose | Setting | Notes |
|---|---|---|
| Application image + version | services.app.image |
Always pin an explicit version tag (e.g. …/lecture:2026.11.14); never rely on a floating tag if you want reproducible updates. |
| HTTP port | services.app.ports |
"5080:8080" publishes the app (which always listens on 8080 inside the container) on host port 5080. Change the left side freely; bind to 127.0.0.1:5080:8080 when a reverse proxy runs on the same host. |
| Database connection | services.app.environment.ConnectionStrings__Lecture |
Host=<db host>;Database=lecture;Username=lecture;Password=<secret>. With the bundled database, the host is the service name postgres. |
| Database credentials | POSTGRES_DB / POSTGRES_USER / POSTGRES_PASSWORD on the database service |
Must match the connection string. They only take effect when the data volume is first initialised — change a password later, and you must change it inside the database as well. |
| Database data | services.postgres.volumes |
The named volume mounted at /var/lib/postgresql/data holds all of Lecture's data. Back it up; never down -v it. |
| Backups directory | optional bind mount, e.g. ./backups:/backups |
Give the container (or a sidecar with the postgres:17 image) a writable directory and write pg_dump output and workspace exports there — see below. |
| Restart behaviour | restart: unless-stopped on both services |
Keeps the stack up across reboots once Docker itself starts on boot. |
Keeping secrets out of the file
Compose reads a .env file next to compose.yaml; reference its values with ${VARIABLE}:
LECTURE_IMAGE=registry.example.com/lecture/lecture:2026.11.14
LECTURE_PORT=5080
POSTGRES_PASSWORD=at-least-24-random-characters
Use the same variable in the connection string (Password=${POSTGRES_PASSWORD}). Never commit .env to version control, and give the file restrictive permissions (chmod 600 .env).
Backups
Two layers, both cheap:
- Database — a scheduled
pg_dumpinto your backups directory:
docker compose exec -T postgres \
pg_dump -U lecture -d lecture -Fc > backups/lecture-$(date +%F).dump
- In-app exports — workspaces can be exported from the app's settings as a portable file. Do this before risky operations and keep one copy off the server.
Store backups where a full-disk accident cannot reach them, and test a restore before you need it.
Behind a reverse proxy
Serve Lecture over HTTPS with your existing proxy (Caddy, nginx, Traefik — anything that forwards WebSockets). Two things to get right: enable the WebSocket upgrade for the app's routes, and forward X-Forwarded-Proto/X-Forwarded-For headers so the app knows it is behind HTTPS. Bind the app port to 127.0.0.1 (or an internal network) so plain HTTP is never reachable from outside.