Settings¤
Most of the settings are loaded through environment variables.
Other settings may be set using a custom settings module.
The exposed settings are not guaranteed to be stable. We may change them at any time. We will try to avoid breaking changes, but we may not be able to avoid them.
Settings reference¤
Database settings (required)¤
POSTGRES_DBPOSTGRES_USERPOSTGRES_PASSWORDPOSTGRES_HOSTPOSTGRES_PORT
Redis settings (required)¤
REDIS_HOSTREDIS_PORT
Redis DBs:
0for default1for sessions2for cache10for celery
FireFighter settings¤
BASE_URLFF_ROLE_REMINDER_MIN_DAYS_INTERVALFF_USER_ID_HEADERFF_OVERRIDE_MENUS_CREATIONFF_DEBUG_ERROR_PAGESFF_DEBUG_ERROR_PAGESFF_SKIP_SECRET_KEY_CHECKFF_EXPOSE_API_DOCSPLAUSIBLE_DOMAINPLAUSIBLE_SCRIPT_URL
SSO OIDC settings¤
See django-oauth2-codeflow documentation for more details.
OIDC_OP_DISCOVERY_DOCUMENT_URL: url to the well-known OIDC discovery documentOIDC_UNUSABLE_PASSWORD: default:FalseOIDC_RP_USE_PKCE: default:FalseOIDC_RP_CLIENT_ID: requiredOIDC_RP_CLIENT_SECRET: requiredOIDC_TIMEOUT: timeout in seconds for OIDC requests (default: 15s)
Debug settings¤
DEBUG_TOOLBAR
Slack integration¤
Required settings¤
SLACK_BOT_TOKENSLACK_SIGNING_SECRETSLACK_INCIDENT_COMMAND: default:/incident
Optional settings¤
SLACK_POSTMORTEM_HELP_URLSLACK_INCIDENT_COMMAND_ALIASES: default: ``SLACK_INCIDENT_HELP_GUIDE_URLSLACK_SEVERITY_HELP_GUIDE_URLSLACK_EMERGENCY_COMMUNICATION_GUIDE_URLSLACK_EMERGENCY_USERGROUP_IDSLACK_APP_EMOJIFF_SLACK_SKIP_CHECKS
Confluence integration¤
ENABLE_CONFLUENCE
Pagerduty integration¤
ENABLE_PAGERDUTY: default:FalsePAGERDUTY_API_KEYPAGERDUTY_ACCOUNT_EMAILPAGERDUTY_URL: default:https://api.pagerduty.com
Other settings¤
Django¤
Mapping environment variables¤
k/v pairs separated by , and :
FF_ENV_VAR_MAPPING=FIREFIGHTER_NAME:MY_CUSTOM_ENV_VAR_NAME,FIREFIGHTER_OTHER_NAME:MY_OTHER_CUSTOM_ENV_VAR_NAME
Useful for mapping environment variables to the ones used by FireFighter.
Warning
Content of the target environment variables will be overwritten.