9e736f2838
* website: use "administrator" instead of "admin" for Admin interface * website: some manual touches --------- Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com> Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
73 lines
3.8 KiB
Plaintext
73 lines
3.8 KiB
Plaintext
---
|
|
title: Integrate with Gatus
|
|
sidebar_label: Gatus
|
|
support_level: community
|
|
---
|
|
|
|
## What is Gatus?
|
|
|
|
> Gatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS queries as well as evaluate the result of said queries by using a list of conditions on values like the status code, the response time, the certificate expiration, the body and many others. The icing on top is that each of these health checks can be paired with alerting via Slack, Teams, PagerDuty, Discord, Twilio and many more.
|
|
>
|
|
> -- 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 only lists the settings that have been changed from their default values. Please verify your changes carefully to avoid any issues accessing your application.
|
|
:::
|
|
|
|
## authentik configuration
|
|
|
|
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 **Create with Provider** 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.
|
|
- **Choose a Provider type**: select **OAuth2/OpenID Connect** 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**,**Client Secret**, and **slug** values because they will be required later.
|
|
- Set a `Strict` redirect URI to <kbd>https://<em>gatus.company</em>/authorization-code/callback</kbd>.
|
|
- Select any available signing key.
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.
|
|
|
|
3. 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.
|
|
|
|
:::note
|
|
Gatus automatically updates its configuration approximately every 30 seconds. If the changes are not reflected, restart the instance to ensure the changes are applied.
|
|
:::
|
|
|
|
```yaml showLineNumbers title=".env"
|
|
OIDC_CLIENT_ID=<Your Client ID from authentik>
|
|
OIDC_CLIENT_SECRET=<Your Client Secret from authentik>
|
|
```
|
|
|
|
```yaml showLineNumbers title="config.yaml"
|
|
security:
|
|
oidc:
|
|
issuer-url: https://authentik.company/application/o/<your-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, click the **Login with SSO** button found on the main page of your Gatus installation. A successful login should redirect you to your status page.
|
|
|
|
## Resources
|
|
|
|
- [Gatus Security documentation for OpenID Connect](https://github.com/TwiN/gatus?tab=readme-ov-file#oidc)
|