Skip to content

mawoka-myblock/uptime-kuma-static

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

uptime-kuma-static

Demo

Online at uptime-kuma-static.mawoka.eu.org

Introduction

I really love Uptime Kuma by Louis Lam , but I wanted a status-page like Statuspage.io or similar, so I created this piece of software (which is also responsive). It fetches the data from Uptime Kuma and renders a HTML-Template with the data, which can look like this: Screenshot of the rendered template

Set up

With Docker

  1. Pull the image: docker pull ghcr.io/mawoka-myblock/uptime-kuma-static:latest
  2. Run the container:
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
  1. 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"?))
  2. (Optional) To tun the dokcer-image every x minutes, add the following line to your crontab, by entering crontab -e:
    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

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/)