Static Documentation

Getting Started

Version latest · Updated 2026-08-12
Interactive docs View on GitHub

Getting Started#

Choose the installation method that matches your environment.

Installation methods#

MethodUse whenGuide
Docker ComposeYou want the quickest start or a container-based deploymentDocker Installation
Kubernetes with HelmYou already run a cluster and want IncidentRelay managed the same wayKubernetes Installation
RPM packageYou use RHEL, Rocky Linux, AlmaLinux or CentOS StreamRPM Installation
Manual systemdYou want to run from source code or manage the Python environment yourselfManual systemd Installation

All methods use the same application model:

web service        -> HTTP API, UI, incoming integrations
scheduler service  -> reminders, escalations, periodic jobs

Common next steps#

After installation:

  • Review Configuration.
  • Run database migrations if your installation method did not run them automatically.
  • Create the first global admin user.
  • Open the web interface and follow First Login and Setup.
  • Configure at least one route and one notification channel.
  • Send a test alert.

After the first alert works, continue with:

Important path and environment names#

The config file is selected by:

INCIDENTRELAY_CONFIG_FILE

Use the exact name above. The older ONCALL_CONFIG_FILE name should not be used.

Recommended paths for non-container installations:

/etc/incidentrelay/incidentrelay.conf
/var/lib/incidentrelay
/var/log/incidentrelay
/usr/local/lib/incidentrelay/voice_providers