205hlab-mirrors/authentik
2
0
Fork 0
mirror of https://github.com/goauthentik/authentik.git synced 2026-06-17 19:09:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

website/integrations: Gatus: cleanup

Browse Source 
Agent-thread: https://sdko.org/internal/thr/ak/019ed1b8-ddad-7110-b9ba-64ce4a352b28
A7k-product: product
A7k-product-repo: 3
Co-authored-by: Agent <gptagent@svc.sdko.net>
This commit is contained in:
Dominic R
2026-06-16 14:41:16 -04:00
parent 52674afa8a
commit 2a8973cffc
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/integrations/monitoring/gatus/index.mdx
+11 -11
View File
@@ -8,9 +8,9 @@ import RedirectURI20265Note from "../../_redirect-uri-2026-5-note.mdx";
## 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.
> Gatus is an automated, developer-oriented status page for monitoring services with HTTP, ICMP, TCP, and DNS checks.
>
> -- https://github.com/TwiN/gatus
> -- https://gatus.io/
## Preparation
@@ -20,7 +20,7 @@ The following placeholders are used in this guide:
- `authentik.company` is the FQDN of the authentik installation.
:::info
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.
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
@@ -34,10 +34,10 @@ To support the integration of Gatus with authentik, you need to create an applic
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.
- **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type.
- **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**, **Client Secret**, and **slug** values because they will be required later.
- 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](/docs/add-secure-apps/bindings-overview/) (policy, group, or user) to manage the listing and access to applications on a user's **Application Dashboard** page.
@@ -48,11 +48,11 @@ To support the integration of Gatus with authentik, you need to create an applic
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.
:::info
:::info 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.
:::
```yaml showLineNumbers title=".env"
```ini showLineNumbers title=".env"
OIDC_CLIENT_ID=<Your Client ID from authentik>
OIDC_CLIENT_SECRET=<Your Client Secret from authentik>
```
@@ -61,15 +61,15 @@ OIDC_CLIENT_SECRET=<Your Client Secret from authentik>
security:
oidc:
issuer-url: "https://authentik.company/application/o/<application_slug>/"
client-id: "OIDC_CLIENT_ID"
client-secret: "OIDC_CLIENT_SECRET"
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.
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