From fb18a10e612cede10894b2ebfc22d74be03b29c7 Mon Sep 17 00:00:00 2001 From: Lars Lehmann <33843261+larslehmann-net@users.noreply.github.com> Date: Tue, 23 Nov 2021 00:10:31 +0100 Subject: [PATCH] website/integrations: Add Provider/Uptime Kuma (#1831) * docs: add integration docs for uptime-kuma * docs: add integration docs for uptime-kuma --- .../services/uptime-kuma/index.md | 55 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 56 insertions(+) create mode 100644 website/integrations/services/uptime-kuma/index.md diff --git a/website/integrations/services/uptime-kuma/index.md b/website/integrations/services/uptime-kuma/index.md new file mode 100644 index 000000000..0ee075563 --- /dev/null +++ b/website/integrations/services/uptime-kuma/index.md @@ -0,0 +1,55 @@ +--- +title: Uptime Kuma +--- + +## What is Uptime Kuma + +From https://github.com/louislam/uptime-kuma + +:::note +It is a self-hosted monitoring tool like "Uptime Robot". +::: + +Uptime Kuma currently supports only a single user and no native SSO solution. To still use authentik, you can work with the Proxy Outpost and a Proxy Provider. + +## Preparation + +The following placeholders will be used: + +- `uptime-kuma.company` is the FQDN of the Uptime Kuma install. +- `authentik.company` is the FQDN of the authentik install. + +Create an application in authentik. Create a Proxy provider with the following parameters: + +- Internal host + + If Uptime Kuma is running in docker, and you're deploying the authentik proxy on the same host, set the value to `http://uptime-kuma:3001`, where uptime-kuma is the name of your container. + + If Uptime Kuma is running on a different server to where you are deploying the authentik proxy, set the value to `http://:3001`. + +- External host + + `https://uptime-kuma.company` + Set this to the external URL you will be accessing Uptime Kuma from. + +- Skip path regex + + Add the following regex rules to keep the public status page accessible without authentication. + ``` + ^/$ + ^/status + ^/assets/ + ^/assets + ^/icon.svg + ^/api/.* + ^/upload/.* + ^/metrics + ``` + +To avoid that all users get admin access to Uptime Kuma create a group in authentik for the admin user. Next set in authentik for the application under `Policy / Group / User Bindings` a group binding with the group created above. + +## Uptime Kuma + +Disble auth from Uptime Kuma, go to `Settings` > `Advanced` > `Disable Auth` + +To access the dashboard, open `https://uptime-kuma.company/dashboard`, this will start the login with authentik. You can also set this address as the Launch URL for the application. \ No newline at end of file diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 5c982fb4e..3aae6f1e5 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -50,6 +50,7 @@ module.exports = { "services/sonarr/index", "services/tautulli/index", "services/ubuntu-landscape/index", + "services/uptime-kuma/index", "services/veeam-enterprise-manager/index", "services/vikunja/index", "services/vmware-vcenter/index",