diff --git a/docs/modules/docker.md b/docs/modules/docker.md index 852858d0..85dade18 100644 --- a/docs/modules/docker.md +++ b/docs/modules/docker.md @@ -21,7 +21,7 @@ docker: ## Screenshots -github screenshot +docker screenshot ## Attributes diff --git a/docs/modules/uptimekuma.md b/docs/modules/uptimekuma.md new file mode 100644 index 00000000..97ae6941 --- /dev/null +++ b/docs/modules/uptimekuma.md @@ -0,0 +1,44 @@ +# UptimeRobot + +Learn more about [Uptime Kuma](https://github.com/louislam/uptime-kuma). + +As Uptime Kuma does not yet have a full API the module 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 URL to specify in the configuration. + +It's recommended to give this module 2 rows of space in the dashboard, as a second line may appear to display any incident. + +This module is based on the similar widget for [Homepage](https://gethomepage.dev/widgets/services/uptime-kuma/). + +## Configuration + +```yaml +uptimekuma: + enabled: true + url: https://uptimekuma.example.com/status/overview + position: + top: 0 + left: 1 + height: 2 + width: 1 + refreshInterval: 1m +``` + +## Screenshots + +uptimekuma screenshot + + +## Attributes + + + {% include "attributes/table_header.md" %} + + + {% with name="url", desc="Full URL of the status page." %} + {% include "attributes/custom.md" %} + {% endwith %} + +
+ +{% set src="uptimekuma" %} +{% include "src_path.md" %} \ No newline at end of file diff --git a/site/assets/modules/uptimekuma.png b/site/assets/modules/uptimekuma.png new file mode 100644 index 00000000..632f3f86 Binary files /dev/null and b/site/assets/modules/uptimekuma.png differ