Skip to main content

Integrate with Gatus

Support level: Community

What is Gatus?​

Gatus is a free and open source project for endpoint monitoring. It allows many types of monitoring from pings or http requests to DNS checking and certification expiration. This is all done through yaml files.

-- https://github.com/TwiN/gatus

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.
note

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​

Create an OIDC provider with the following settings:

Everything else is up to you and what you want, just don't forget to grab the client ID and secret!

Gatus configuration​

In the config.yaml file of Gatus, add the following:

security:
    oidc:
        issuer-url: https://authentik.company/application/o/gatus/
        client-id: "CLIENT_ID"
        client-secret: "CLIENT_SECRET"
        redirect-url: https://gatus.company/authorization-code/callback
        scopes: [openid]
note

Gatus auto-updates the configuration about every 30 seconds. However, if it does not pick up the changes, just restart the instance.