website/integrations: Add Provider/Uptime Kuma (#1831)

* docs: add integration docs for uptime-kuma

* docs: add integration docs for uptime-kuma
This commit is contained in:
Lars Lehmann 2021-11-23 00:10:31 +01:00 committed by GitHub
parent 9bb0d04aeb
commit fb18a10e61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 56 additions and 0 deletions

View file

@ -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://<Other Host>: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.

View file

@ -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",