| description | Describes additional configuration options available for the Dispatch server itself. Additional plugin-specific configuration can be found in the plugin's documentation. |
|---|
Dispatch uses the same configuration system as Starlette.
By default, the config will be read from environment variables and/or .env files.
{% hint style="info" %}
All config items prefixed with VUE_APP are envvars for the Vue frontend. These variables are used only during the building of the javascript bundle. See here for details.
{% endhint %}
{% hint style="info" %} In general, do not include any quotation marks when adding configuration values. {% endhint %}
Controls the level of logging the application will perform during operations.
Controls where static content for the Dispatch Web UI should be served from. This can also be explicitly set to
''if you wish to serve static content outside of the Dispatch server.
A comma separated list of metric providers Dispatch will send key system metrics to.
Optional configuration for using Sentry to report Dispatch errors.
Optional configuration for using Sentry to report Dispatch errors.
Email address to be used by Dispatch when a help message is created.
Slack channel name to be used by Dispatch when a help message is created.
URL being used for Dispatch's Admin UI. Used in messaging to refer to the Admin UI.
Used by Dispatch to determine which authentication provider to use, by default Dispatch ships with a PKCE authentication provider.
{% hint style="info" %}
If you wish to disable authentication set DISPATCH_AUTHENTICATION_PROVIDER_SLUG=
{% endhint %}
{% hint style="warning" %} Today, basic authentication allows self registration without approval. {% endhint %}
{% hint style="warning" %}
In order for this plugin to work, you need to set DISPATCH_JWT_SECRET.
{% endhint %}
Used by the basic auth provider to mint JWT tokens.
Used by the basic auth provider to mint JWT tokens.
Used by the basic auth provider to mint JWT tokens and set their expiration.
Override what the
Audienceis expected to be in the PKCE JWT decode
Override where Dispatch should find the user email in the idtoken.
DISPATCH_AUTHENTICATION_DEFAULT_USER ['default': dispatch@example.com]
Used as the default anonymous user when authentication is disabled.
Used by Dispatch's authentication backend to pull the JSON Web Key Set (JWKS) public key from the specified provider.
Used by the Dispatch Web UI send the user via Proof Key Code Exchange (PKCE) to a correct OpenID Connect endpoint.
The client id to send to the OpenID Connect endpoint.
Dispatch relies on a
Postgresdatabase. This host name should point to a supporter version ofPostgres (9.6+).
Credentials specified in
username:passwordformat to be used to authenticate to thepostgresdatabase.
Allows the user to specify the database name for the
Dispatchbackend.
Allows the user to specify the database port for the
Dispatchbackend.
Dispatch calculates the cost of an incident by adding up the time participants have spent on each incident role (e.g. Incident Commander) and applying an engagement multiplier that's based on the incident role. It also includes time spent on incident review related activities. Dispatch calculates and published the cost for all incidents every 5 minutes.
Used for incident cost modeling, specifies the total
all-inaverage cost for an employee working on incidents.
Used for incident cost modeling, specifies the number of hours in an employee's work year.
Top level folder where all incident data is stored. Note: viewing actual incident data is still on a per-sub folder basis.
After an incident is closed, Netflix as an organization, tries to be transparent and allow others within the organization to view incident data. This is may not desirable in all organizations. This controls whether to open up incident data on incident close.
Comma separated list of conversations (e.g. Slack channels) to be notified of new incidents.
Comma separated list of email addresses to be notified of new incidents.
Specifies the oncall service id to use to resolve the oncall person.
Controls the resource type to use for incident tasks.
Controls the resource type to use for the incident faq document.
Controls the resource type to use for tactical groups.
Controls the resource type to use for notification groups.
Controls the resource type to use for the investigation document.
Controls the resource type to use for the investigation sheet.
Controls the resource type to use for the incident review document.