Skip to content

Add UptimeKuma module #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ docker:

## Screenshots

<img class="screenshot" src="/assets/modules/docker.png" width="275" height="320" alt="github screenshot" />
<img class="screenshot" src="/assets/modules/docker.png" width="275" height="320" alt="docker screenshot" />

## Attributes

Expand Down
44 changes: 44 additions & 0 deletions docs/modules/uptimekuma.md
Original file line number Diff line number Diff line change
@@ -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.

<i>This module is based on the similar widget for [Homepage](https://gethomepage.dev/widgets/services/uptime-kuma/).</i>

## Configuration

```yaml
uptimekuma:
enabled: true
url: https://uptimekuma.example.com/status/overview
position:
top: 0
left: 1
height: 2
width: 1
refreshInterval: 1m
```

## Screenshots

<img class="screenshot" src="/assets/modules/uptimekuma.png" width="275" height="320" alt="uptimekuma screenshot" />


## Attributes

<table>
{% include "attributes/table_header.md" %}

<tbody>
{% with name="url", desc="Full URL of the status page." %}
{% include "attributes/custom.md" %}
{% endwith %}
</tbody>
</table>

{% set src="uptimekuma" %}
{% include "src_path.md" %}
Binary file added site/assets/modules/uptimekuma.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.