Environment Variables
Full documentation of all environment variables that can be used to configure Scrumlr.
Frontend
Section titled “Frontend”Show legal documents
Section titled “Show legal documents”Toggle visibility of cookie policy, privacy policy, and terms & conditions in the footer. Recommended for public instances.
SCRUMLR_SHOW_LEGAL_DOCUMENTS=''Server URL
Section titled “Server URL”Override the server address for API calls. This is the URL of the backend server.
SCRUMLR_SERVER_URL=''Websocket URL
Section titled “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.
SCRUMLR_WEBSOCKET_URL=''Frontend Listen Port
Section titled “Frontend Listen Port”The port on which the frontend should listen for incoming connections.
SCRUMLR_LISTEN_PORT='8080'Analytics variables
Section titled “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.
SCRUMLR_ANALYTICS_DATA_DOMAIN=''SCRUMLR_ANALYTICS_SRC=''Clarity id
Section titled “Clarity id”The clarity id to use Clarity.
SCRUMLR_CLARITY_ID=''Backend
Section titled “Backend”Server Port
Section titled “Server Port”The port on which the backend should listen for incoming connections.
SCRUMLR_SERVER_PORT='8080'NATS URL
Section titled “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.
SCRUMLR_SERVER_NATS_URL=''Redis Variables
Section titled “Redis Variables”You can either use a NATS server or a Redis server for the backend communication. Only configure one of the two.
SCRUMLR_SERVER_REDIS_HOST=''SCRUMLR_SERVER_REDIS_USERNAME=''SCRUMLR_SERVER_REDIS_PASSWORD=''Insecure Mode
Section titled “Insecure Mode”Uses the insecure private key for JWT token signing. Do not use in production!
SCRUMLR_INSECURE=''Private Key
Section titled “Private Key”The private key used to sign the JWT tokens. Please generate a new key for production use and keep it secure.
SCRUMLR_PRIVATE_KEY=''Database URL
Section titled “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.
SCRUMLR_SERVER_DATABASE_URL='postgres://user:password@host:port/database'Base Path
Section titled “Base Path”The base path of the API. The default is /.
SCRUMLR_BASE_PATH=''Disable Anonymous Login
Section titled “Disable Anonymous Login”If set to true, users won’t be able to log in anonymously, forcing them to use a provider (any OAuth or OIDC).
Note that if this is set to true, and no valid providers are available, login won’t be possible at all.
Default is false.
SCRUMLR_DISABLE_ANONYMOUS_LOGIN=falseEnable Experimental File System Store
Section titled “Enable Experimental File System Store”Enables an experimental file store for session cookies, which is used during OAuth authentication to store session info
while on the provider page.
Required for some OIDC providers, since their session cookies exceed the size limit of 4KB.
Default is false.
SCRUMLR_ENABLE_EXPERIMENTAL_AUTH_FILE_SYSTEM_STORE=falseAuth Callback Host
Section titled “Auth Callback Host”The host to which the OAuth callback should redirect.
SCRUMLR_AUTH_CALLBACK_HOST=''Google OAuth
Section titled “Google OAuth”Required Google OAuth credentials. Only configure if you wish to use Google OAuth.
SCRUMLR_AUTH_GOOGLE_CLIENT_ID=''SCRUMLR_AUTH_GOOGLE_CLIENT_SECRET=''GitHub OAuth
Section titled “GitHub OAuth”Required GitHub OAuth credentials. Only configure if you wish to use GitHub OAuth.
SCRUMLR_AUTH_GITHUB_CLIENT_ID=''SCRUMLR_AUTH_GITHUB_CLIENT_SECRET=''Microsoft OAuth
Section titled “Microsoft OAuth”Required Microsoft OAuth credentials. Only configure if you wish to use Microsoft OAuth.
SCRUMLR_AUTH_MICROSOFT_CLIENT_ID=''SCRUMLR_AUTH_MICROSOFT_CLIENT_SECRET=''Azure AD OAuth
Section titled “Azure AD OAuth”Required Azure AD OAuth credentials. Only configure if you wish to use Azure AD OAuth.
SCRUMLR_AUTH_AZURE_AD_TENANT_ID=''SCRUMLR_AUTH_AZURE_AD_CLIENT_ID=''SCRUMLR_AUTH_AZURE_AD_CLIENT_SECRET=''Apple OAuth
Section titled “Apple OAuth”Required Apple OAuth credentials. Only configure if you wish to use Apple OAuth.
SCRUMLR_AUTH_APPLE_CLIENT_ID=''SCRUMLR_AUTH_APPLE_CLIENT_SECRET=''OpenID Connect OAuth
Section titled “OpenID Connect OAuth”Required OIDC credentials. Only configure if you wish to use generic OpenID Connect Authentication.
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=''Note: Might require larger session store to be active, see SCRUMLR_ENABLE_EXPERIMENTAL_AUTH_FILE_SYSTEM_STORE
Session Secret
Section titled “Session Secret”The secret for the session. This secret is used by gothic. This needs to be configured if you are using an authentication provider.
SESSION_SECRET=''Feedback Webhook URL
Section titled “Feedback Webhook URL”A webhook URL to which feedback should be sent. This is not required.
SCRUMLR_FEEDBACK_WEBHOOK_URL=''Scrumlr Config Path
Section titled “Scrumlr Config Path”The path to the Scrumlr configuration file.
SCRUMLR_CONFIG_PATH=''