homepage/docs/widgets/services/uptime-kuma.md
Nuno Alexandre 595049f7fc
Documentation: clarify uptime kuma slug (#3345)
---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2024-04-22 12:33:35 -07:00

18 lines
661 B
Markdown

---
title: Uptime Kuma
description: Uptime Kuma Widget Configuration
---
Learn more about [Uptime Kuma](https://github.com/louislam/uptime-kuma).
As Uptime Kuma does not yet have a full API the widget uses data from a single "status page". As such you will need a status page setup with a group of monitored sites, which is where you get the slug (the url without the `/status/` portion). E.g. if your status page is URL http://uptimekuma.host/status/statuspageslug, insert `slug: statuspageslug`.
Allowed fields: `["up", "down", "uptime", "incident"]`.
```yaml
widget:
type: uptimekuma
url: http://uptimekuma.host.or.ip:port
slug: statuspageslug
```