Skip to content

Configuration ​

OpenSCRUM is configured entirely through environment variables. With Docker Compose, put them in a .env file next to docker-compose.yml and apply changes with:

bash
docker compose up -d

Settings ​

SettingRequiredDefaultPurpose
AUTH_SECRETYes—Random value of at least 32 characters that protects sign-in sessions.
PUBLIC_URLNohttp://localhost:3000The address people open in their browser.
POSTGRES_PASSWORDNoopenscrumPassword for the bundled database. Set before the first start.
MULTI_TENANTNofalseWhether anyone may sign up and create their own organisation.
COMPOSE_FILENo—Set to docker-compose.yml:docker-compose.https.yml to switch on built-in HTTPS.

AUTH_SECRET ​

Keep this value private and do not change it once people are using OpenSCRUM. Changing it signs everyone out, and makes the stored tokens for Jira and Linear unreadable, so each tracker has to be connected again. Installation shows how to generate one.

PUBLIC_URL ​

Must exactly match the address in the browser's address bar, including http:// or https:// and any port. Sign-in requests from any other address are refused.

With built-in HTTPS switched on, this is also the address the certificate is obtained for.

POSTGRES_PASSWORD ​

Only applied when the database is first created. To change it later you must also change the password inside PostgreSQL.

MULTI_TENANT ​

  • false — Community / self-hosted behaviour. There is one organisation. The first person to sign up creates it, and everyone else joins by invitation.
  • true — Hosted service behaviour. Anyone can sign up and create their own organisation. Each organisation only sees its own data.

WARNING

Only switch MULTI_TENANT on if you intend to run a public service. OpenSCRUM does not yet verify email addresses, which a public service should have.

Running without the bundled database ​

If you run the app container yourself rather than through the provided docker-compose.yml, it reads these variables directly:

VariableRequiredDefaultPurpose
DATABASE_URLYes—PostgreSQL connection string, e.g. postgres://user:password@host:5432/openscrum.
AUTH_SECRETYes—As above.
PUBLIC_URLYes—As above. There is no default outside Docker Compose.
MULTI_TENANTNofalseAs above.
HOSTNo0.0.0.0Network interface the server listens on.
PORTNo3000Port the server listens on.