Skip to content
Scrumlr Docs

Environment Variables

Full documentation of all environment variables that can be used to configure Scrumlr.

Frontend

Toggle visibility of cookie policy, privacy policy, and terms & conditions in the footer. Recommended for public instances.

Terminal window
SCRUMLR_SHOW_LEGAL_DOCUMENTS=''

Server URL

Override the server address for API calls. This is the URL of the backend server.

Terminal window
SCRUMLR_SERVER_URL=''

Websocket URL

Override the websocket address for API calls. This is the URL of the backend server but beginning with the ws or wss protocol.

Terminal window
SCRUMLR_WEBSOCKET_URL=''

Frontend Listen Port

The port on which the frontend should listen for incoming connections.

Terminal window
SCRUMLR_LISTEN_PORT='8080'

Analytics variables

We provide the option to use Plausible for analytics. If you want to use Plausible, you need to set the following environment variables.

Terminal window
SCRUMLR_ANALYTICS_DATA_DOMAIN=''
SCRUMLR_ANALYTICS_SRC=''

Backend

Server Port

The port on which the backend should listen for incoming connections.

Terminal window
SCRUMLR_SERVER_PORT='8080'

NATS URL

The URL of the NATS server. You can either use a NATS server or a Redis server for the backend communication. Only configure one of the two.

Terminal window
SCRUMLR_SERVER_NATS_URL=''

Redis Variables

You can either use a NATS server or a Redis server for the backend communication. Only configure one of the two.

Terminal window
SCRUMLR_SERVER_REDIS_HOST=''
SCRUMLR_SERVER_REDIS_USERNAME=''
SCRUMLR_SERVER_REDIS_PASSWORD=''

Insecure Mode

Uses the insecure private key for JWT token signing. Do not use in production!

Terminal window
SCRUMLR_INSECURE=''

Private Key

The private key used to sign the JWT tokens. Please generate a new key for production use and keep it secure.

Terminal window
SCRUMLR_PRIVATE_KEY=''

Database URL

The URL of the PostgreSQL database. Credentials are passed in the URL. If you havent configured postgres for TLS, you can use the ?sslmode=disable parameter.

Terminal window
SCRUMLR_SERVER_DATABASE_URL='psql://user:password@host:port/database'

Base Path

The base path of the API. The default is /.

Terminal window
SCRUMLR_BASE_PATH=''

Auth Callback Host

The host to which the OAuth callback should redirect.

Terminal window
SCRUMLR_AUTH_CALLBACK_HOST=''

Google OAuth

Required Google OAuth credentials. Only configure if you wish to use Google OAuth.

Terminal window
SCRUMLR_AUTH_GOOGLE_CLIENT_ID=''
SCRUMLR_AUTH_GOOGLE_CLIENT_SECRET=''

GitHub OAuth

Required GitHub OAuth credentials. Only configure if you wish to use GitHub OAuth.

Terminal window
SCRUMLR_AUTH_GITHUB_CLIENT_ID=''
SCRUMLR_AUTH_GITHUB_CLIENT_SECRET=''

Microsoft OAuth

Required Microsoft OAuth credentials. Only configure if you wish to use Microsoft OAuth.

Terminal window
SCRUMLR_AUTH_MICROSOFT_CLIENT_ID=''
SCRUMLR_AUTH_MICROSOFT_CLIENT_SECRET=''

Azure AD OAuth

Required Azure AD OAuth credentials. Only configure if you wish to use Azure AD OAuth.

Terminal window
SCRUMLR_AUTH_AZURE_AD_TENANT_ID=''
SCRUMLR_AUTH_AZURE_AD_CLIENT_ID=''
SCRUMLR_AUTH_AZURE_AD_CLIENT_SECRET=''

Apple OAuth

Required Apple OAuth credentials. Only configure if you wish to use Apple OAuth.

Terminal window
SCRUMLR_AUTH_APPLE_CLIENT_ID=''
SCRUMLR_AUTH_APPLE_CLIENT_SECRET=''

OpenID Connect OAuth

Required OIDC credentials. Only configure if you wish to use generic OpenID Connect Authentication.

Terminal window
SCRUMLR_AUTH_OIDC_CLIENT_ID
SCRUMLR_AUTH_OIDC_CLIENT_SECRET
SCRUMLR_AUTH_OIDC_DISCOVERY_URL
SCRUMLR_AUTH_OIDC_USER_IDENT_SCOPE
SCRUMLR_AUTH_OIDC_USER_NAME_SCOPE

Feedback Webhook URL

A webhook URL to which feedback should be sent. This is not required.

Terminal window
SCRUMLR_FEEDBACK_WEBHOOK_URL=''

Scrumlr Config Path

The path to the Scrumlr configuration file.

Terminal window
SCRUMLR_CONFIG_PATH=''