Skip to main content

Install

1. Get the operator package​

You need no source code. Every release has a small package attached: the compose file (pinned to this version), the script update.sh, the database scripts and the .env.example.

mkdir study-manager && cd study-manager
curl -fsSL https://github.com/erik1g/study-manager/releases/latest/download/study-manager.tar.gz | tar xz --strip-components=1
cat VERSION

For a specific version, use the address download/v0.1.0/study-manager-0.1.0.tar.gz instead of latest/download/study-manager.tar.gz. The checksums (study-manager.sha256) and a provenance attestation are on the same release; how you check them is under Security.

2. Create the settings​

The file .env holds the secrets of your installation. A script in the image creates it with fresh keys:

docker run --rm \
-e ADMIN_EMAIL=you@example.org \
-e DOMAIN=study.example.org \
docker.io/erik1g/study-manager-server:$(cat VERSION) \
node /app/infra/scripts/setup.mjs --stdout > .env
chmod 600 .env
  • ADMIN_EMAIL is your address: the first setup link is for it.
  • DOMAIN is the public address without https://. Change it later only with care: passkeys are bound to the domain and are lost when it changes.

Open .env and check it; all settings are explained under Configuration. Back up the file (especially BACKUP_PASSPHRASE) in a second place, for example in your password manager: without it, backups cannot be read.

3. Start​

docker compose up -d
docker compose logs server

On the first start, the server creates the database and prints a link to set up the admin account in one line (No admin yet. Set up … with: https://…). Open it as soon as your reverse proxy runs (next step) and set a password and a passkey or authenticator app. Admins need a second factor.

If you need the link again later:

docker compose exec server node --import tsx src/cli/admin-link.ts

4. Set up the reverse proxy​

By default the app only listens on 127.0.0.1:8080 of your server. How your proxy makes it reachable under your domain with HTTPS is described under Reverse proxy.

5. Check​

  • https://<your-domain>/api/health answers with {"ok":true}.
  • The start page shows the sign-in.
  • docker compose ps shows all four containers as running (the database and auth also as healthy).

Next: Operations.