| 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 disabled authentication set DISPATCH_AUTHENTICATION_PROVIDER=""
{% endhint %}
DISPATCH_AUTHENTICATION_DEFAULT_USER ['default': dispatch@example.com]
Used when authentication is disable as the default anonymous user.
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 open id connect endpoint.
The client id to send to the open id 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.
Used for incident cost modeling, specifies the total
all-incost for an average employee working on incidents.
Used for incident cost modeling, specifies the number of hours in an employee's work week.
Controls which plugin will be used to resolve incident participant email addresses. The plugin will also be used to gather additional participant information such as name, team, location, etc.
Controls which plugin will be used for incident conversations.
Controls which plugin will be used for incident document creation.
Controls which plugin will be used to recommend documents to be automatically included for a given incident.
Controls which plugin will be used to create a conference.
Controls which plugin will be used to send incident email notifications.
Controls which plugin will be used to create incident participant groups (DLs).
Controls which plugin will be used to determine which participants should be automatically included for a given incident.
Controls which plugin will be used for incident storage.
Controls the plugin to use for creating external tickets. The ticket number is used as incident name.
Controls the plugin to use for creation of incident tasks.
Controls which document id to use as the FAQ.
Controls which document id to use for the conversation commands reference document.
Controls the folder where to archive incident information.
Controls whether a set of restrictions and capabilities to prevent content sharing need to be applied.
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 that is included in the daily incidents summary.
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.