Skip to main content

Integrate with Gatus

Support level: Community

What is Gatus?​

Gatus is an automated, developer-oriented status page for monitoring services with HTTP, ICMP, TCP, and DNS checks.

-- https://gatus.io/

Preparation​

The following placeholders are used in this guide:

  • gatus.company is the FQDN of the Gatus installation.
  • authentik.company is the FQDN of the authentik installation.
info

This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.

authentik configuration​

Redirect URI changes in authentik 2026.5

In authentik versions earlier than 2026.5, all Redirect URIs are automatically treated as Authorization type. If you are using one of these older authentik versions, add only the Authorization URL to your Redirect URIs and do not configure a Post Logout URI.

To support the integration of Gatus with authentik, you need to create an application/provider pair in authentik.

Create an application and provider in authentik​

  1. Log in to authentik as an administrator and open the authentik Admin interface.
  2. Navigate to Applications > Applications and click New Application to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.)
  • Application: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. Note the application slug because it will be required later.
  • Choose a Provider type: select OAuth2/OpenID as the provider type.
  • Configure the Provider: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
    • Note the Client ID and Client Secret values because they will be required later.
    • Add a Redirect URI of type Strict Authorization as https://gatus.company/authorization-code/callback.
    • Select any available signing key.
  • Configure Bindings (optional): you can create a binding (policy, group, or user) to manage the listing and access to applications on a user's Application Dashboard page.
  1. Click Submit to save the new application and provider.

Gatus configuration​

To enable OIDC in Gatus, update your config.yaml file, typically found at /config/config.yaml or the location specified by the GATUS_CONFIG_PATH environment variable. Additionally, set the following variables in your .env file. If your setup does not support environment variables, you can use hard-coded values, but this is not recommended for security reasons.

Configuration reload

Gatus automatically updates its configuration approximately every 30 seconds. If the changes are not reflected, restart the instance to ensure the changes are applied.

.env
OIDC_CLIENT_ID=<Your Client ID from authentik>
OIDC_CLIENT_SECRET=<Your Client Secret from authentik>
config.yaml
security:
    oidc:
        issuer-url: "https://authentik.company/application/o/<application_slug>/"
        client-id: "$OIDC_CLIENT_ID"
        client-secret: "$OIDC_CLIENT_SECRET"
        redirect-url: "https://gatus.company/authorization-code/callback"
        scopes: ["openid"]

Configuration verification​

To confirm that authentik is properly configured with Gatus, open Gatus and click Login with OIDC. A successful login should redirect you to your status page.

Resources​