https://github.com/mawoka-myblock/uptime-kuma-static
Generate static HTML-Pages from Uptime-Kuma
https://github.com/mawoka-myblock/uptime-kuma-static
bulma jinja2 python uptime-kuma
Last synced: 8 months ago
JSON representation
Generate static HTML-Pages from Uptime-Kuma
- Host: GitHub
- URL: https://github.com/mawoka-myblock/uptime-kuma-static
- Owner: mawoka-myblock
- Created: 2021-09-10T19:27:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T15:16:05.000Z (over 2 years ago)
- Last Synced: 2025-02-01T20:25:59.530Z (10 months ago)
- Topics: bulma, jinja2, python, uptime-kuma
- Language: Jinja
- Homepage: https://uptime-kuma-static.mawoka.eu.org?utm_source=RepoDetails&utm_medium=Github
- Size: 49.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# uptime-kuma-static
## Demo
Online
at [uptime-kuma-static.mawoka.eu.org](https://uptime-kuma-static.mawoka.eu.org?utm_source=Readme&utm_medium=Github)
## Introduction
I really love [Uptime Kuma](https://github.com/louislam/uptime-kuma) by **[Louis Lam
](https://github.com/louislam)**, but I wanted a status-page like [Statuspage.io](https://statuspage.io) or similar,
so I created this piece of software (which is also **responsive**). It fetches the data
from [Uptime Kuma](https://github.com/louislam/uptime-kuma) and
renders a HTML-Template with the data, which can look like this:
## Set up
### With Docker
1. Pull the image: `docker pull ghcr.io/mawoka-myblock/uptime-kuma-static:latest`
2. Run the container:
```bash
docker run --rm \
-e "PASSWORD_LOGIN=true" \
-e "UTKUMA_PASSWORD=YOUR_PASSWORD" \
-e "UTKUMA_USERNAME=YOUR_USERNAME" \
-e "UTKUMA_URL=YOUR_URL" \
-v "$(pwd)"/out:/app/out \
--name utkuma-static ghcr.io/mawoka-myblock/uptime-kuma-static:latest
```
3. Just serve the `index.html` in the `out/`-directory with your favourite
webserver (I prefer nginx (Btw: Did you know that `nginx` is pronounced
`"engine-x"`?))
4. (Optional) To tun the dokcer-image every x minutes,
add the following line to your crontab, by entering `crontab -e`:
```bash
0 */1 * * * docker run --rm -e "PASSWORD_LOGIN=true" -e "UTKUMA_PASSWORD=YOUR_PASSWORD" -e "UTKUMA_USERNAME=YOUR_USERNAME" -e "UTKUMA_URL=YOUR_URL" -v /nginx/out:/app/out --name utkuma-static ghcr.io/mawoka-myblock/uptime-kuma-static:latest
```
[Crontab explanation](https://crontab.guru/#0_*/1_*_*_*)
## Config-options
| Environment-Variable | Value | Explanation | Standard |
|----------------------|-----------|-----------------------------------------------------------------------------------------------------------|----------|
| `PASSWORD_LOGIN` | `boolean` | If set to `true` login over `UTKUMA_PASSWORD` and `UTKUMA_TOKEN`, otherwise `UTKUMA_TOKEN` has to be set. | ❌ |
| `UTKUMA_PASSWORD` | `string` | The password for your account (Necessary if `PASSWORD_LOGIN` is set to `true`) | ❌ |
| `UTKUMA_USERNAME` | `string` | The username of your account (Necessary if `PASSWORD_LOGIN` is set to `true`) | ❌ |
| `UTKUMA_TOKEN` | `string` | The token for your account (Necessary if `PASSWORD_LOGIN` is set to `false`) | ❌ |
| `UTKUMA_URL` | `string` | The base-url of your uptime-kuma-instance (eg. `https://demo.uptime.kuma.pet:27000/`) | ❌ |