Skip to content

Commit

Permalink
actual budget cfg validation; bookstack upd; cfa add cfg validation; …
Browse files Browse the repository at this point in the history
…gatus revamp; component support multiline ex: yaml
  • Loading branch information
dominic-r committed Feb 3, 2025
1 parent 5580df5 commit 2d4c61f
Show file tree
Hide file tree
Showing 6 changed files with 85 additions and 56 deletions.
7 changes: 2 additions & 5 deletions website/integrations/services/actual-budget/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,6 @@ The first user to log into Actual Budget via OpenID will become the owner and ad
Users are not created automatically in Actual Budget. The owner must manually add users. To do this, go to **Server online** > **User Directory**, and create users matching their authentik usernames. Then, grant access to the budget via **User Access**.
:::

## Test the login
## Configuration validation

1. Open a browser and navigate to <kbd>https://<em>actual.company</em>/</kbd>.
2. Select the OpenID login method in the dropdown menu and click **Sign in with OpenID**.
3. You will be redirected to authentik to complete the login process, then back to Actual Budget.
4. If you reach the budget selection page, the integration is successful.
To confirm that authentik is properly configured with Actual Budget, visit your Actual Budget installation, select the OpenID login method from the dropdown menu, and click **Sign in with OpenID**.
4 changes: 4 additions & 0 deletions website/integrations/services/bookstack/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,7 @@ Once that’s done, the next step is to update your `.env` file to include the f

</TabItem>
</Tabs>

## Configuration validation

To confirm that authentik is properly configured with BookStack, visit your BookStack installation, and click **Login with authentik**.
4 changes: 4 additions & 0 deletions website/integrations/services/cloudflare-access/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,7 @@ In the authentik Admin Interface, navigate to **Applications** > **Applications*
- **JWKS URL** -> Certificate URL
4. Click **Save**.
5. Click **Test** to verify the login provider.

## Configuration verification

To confirm that authentik is properly configured with Cloudflare Access, click the **Test** button found right next-to the **Save** button from the previous step.
50 changes: 0 additions & 50 deletions website/integrations/services/gatus/index.md

This file was deleted.

74 changes: 74 additions & 0 deletions website/integrations/services/gatus/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: Integrate with Gatus
sidebar_label: Gatus
---

import IntegrationsMultilineCodeblock from "@site/src/components/Integrations/IntegrationsCodeblock";

# Integrate with Gatus

<span class="badge badge--secondary">Support level: Community</span>

## 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**

In the authentik Admin Interface, navigate to **Applications** > **Applications** and click **[Create with Provider](/docs/add-secure-apps/applications/manage_apps#add-new-applications)** to create an application and provider pair. (Alternatively you can create only an application, without a provider, by clicking **Create**.)

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

## 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.
:::

<IntegrationsMultilineCodeblock>
{`
OIDC_CLIENT_ID=<em>Your Client ID from authentik</em>
OIDC_CLIENT_SECRET=<em>Your Client Secret from authentik</em>
`}
</IntegrationsMultilineCodeblock>

<IntegrationsMultilineCodeblock>
{`
security:
oidc:
issuer-url: https://<em>authentik.company</em>/application/o/<em>your-slug</em>/
client-id: $\{OIDC_CLIENT_ID}
client-secret: $\{OIDC_CLIENT_SECRET}
redirect-url: https://<em>gatus.company</em>/authorization-code/callback
scopes: [openid]
`}
</IntegrationsMultilineCodeblock>

## 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 will redirect you to your status page.
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const IntegrationsMultilineCodeblock: React.FC<
},
);

return sanitizedText.replace(/\n\s+/g, "\n").trim();
return sanitizedText.trim();
};

const content: string = processContent(children);
Expand Down

0 comments on commit 2d4c61f

Please sign in to comment.