From 6f31c802c2bc373e31926803f3e7972d023d0b12 Mon Sep 17 00:00:00 2001 From: Connor Beard Date: Wed, 3 Jul 2024 16:31:45 -0500 Subject: [PATCH] website/integrations: add Gatus (#10074) * added Gatus docs * ran make website * changed order of configuration and added clarity * Update index.md Co-authored-by: Tana M Berry Signed-off-by: Connor Beard --------- Signed-off-by: Connor Beard Co-authored-by: Tana M Berry --- website/integrations/services/gatus/index.md | 45 ++++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 46 insertions(+) create mode 100644 website/integrations/services/gatus/index.md diff --git a/website/integrations/services/gatus/index.md b/website/integrations/services/gatus/index.md new file mode 100644 index 0000000000..026770ca40 --- /dev/null +++ b/website/integrations/services/gatus/index.md @@ -0,0 +1,45 @@ +--- +title: 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 will be used: + +- `gatus.company` is the FQDN of the Gatus install. +- `authentik.company` is the FQDN of the authentik install. + +## authentik configuration + +Create an OIDC provider with the following settings: + +- Name: 'gatus' +- Redirect URL: 'https://gatus.company/authorization-code/callback' + +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: + +```yml +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. +::: diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 15bbd5c416..16322f0766 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -134,6 +134,7 @@ module.exports = { type: "category", label: "Monitoring", items: [ + "services/gatus/index", "services/glitchtip/index", "services/grafana/index", "services/sentry/index",