Skip to main content

Configuration

Find below a list of all environment variables that can be set at launch to configure different portions of the application:

General

keytyperequired
BASE_URLstringtrue
PORTnumbertrue
APP_SECRETstringtrue

Database

keytyperequired
DB_HOSTstringtrue
DB_USERNAMEstringtrue
DB_PORTnumbertrue
DB_DATABASEstringtrue

Queue

keytyperequired
QUEUE_DRIVER'sqs' or 'memory'true
AWS_SQS_QUEUE_URLstringIf driver is SQS
AWS_REGIONstringIf driver is SQS
AWS_ACCESS_KEY_IDstringIf driver is SQS
AWS_SECRET_ACCESS_KEYstringIf driver is SQS

Storage

keytyperequired
STORAGE_BASE_URLstringtrue
STORAGE_DRIVER's3' or 'local'true
STORAGE_S3_BUCKETstringIf driver is S3
STORAGE_S3_ENDPOINTstringfalse
STORAGE_S3_FORCE_PATH_STYLEbooleanfalse
AWS_REGIONstringIf driver is S3
AWS_ACCESS_KEY_IDstringIf driver is S3
AWS_SECRET_ACCESS_KEYstringIf driver is S3

Auth

keytyperequired
AUTH_DRIVER'basic', 'google', 'openid', 'saml'true
AUTH_BASIC_EMAILstringIf driver is Basic
AUTH_BASIC_PASSWORDstringIf driver is Basic
AUTH_BASIC_NAMEstringfalse
AUTH_SAML_CALLBACK_URLstringIf driver is SAML
AUTH_SAML_ENTRY_POINT_URLstringIf driver is SAML
AUTH_SAML_ISSUERstringIf driver is SAML
AUTH_SAML_CERTstringIf driver is SAML
AUTH_SAML_IS_AUTHN_SIGNEDbooleanIf driver is SAML
AUTH_SAML_NAMEstringfalse
AUTH_OPENID_ISSUER_URLstringIf driver is OpenID
AUTH_OPENID_CLIENT_IDstringIf driver is OpenID
AUTH_OPENID_CLIENT_SECRETstringIf driver is OpenID
AUTH_OPENID_REDIRECT_URIstringIf driver is OpenID
AUTH_OPENID_DOMAIN_WHITELISTstringIf driver is OpenID
AUTH_OPENID_NAMEstringfalse
AUTH_GOOGLE_ISSUER_URLstringIf driver is Google
AUTH_GOOGLE_CLIENT_IDstringIf driver is Google
AUTH_GOOGLE_CLIENT_SECRETstringIf driver is Google
AUTH_GOOGLE_NAMEstringfalse

Tracking

keytyperequired
TRACKING_LINK_WRAPbooleanfalse
TRACKING_DEEPLINK_MIRROR_URLstringfalse