Skip to content

Uptime Kuma

Docker Apps Rating
U/GID TZ SSO/Users Existing FS Portable Subfolder Mobile
❎ ✅* ❌🤵 ✅ ✅ ❌ ✔

Install

Docker Compose

services:
  uptime-kuma:
    container_name: uptime-kuma
    image: louislam/uptime-kuma
    ports:

      - 3001:3001
    environment:
      - PUID=1001
      - PGID=1001
    volumes:
      - ~/docker/uptime-kuma:/app/data
    restart: unless-stopped

  • Container support non-root users via PUID/PGID
  • default port 3001

Monitoring

To add a monitor, follow the GUI

  • Friendly name is what is displayed on the dashboard
  • There is an option to define how often to check, recheck and how many times to recheck
  • Setup [notification]

HTTP


For HTTP monitoring, it will monitor a HTTP site and give out metrics as such up/down, and the response time.
- accepted response code: eg. 200-299 anything that is not accepted will be considered as down
- option to check HTTPS certificate expiration

Docker

Docker Health

Uptime Kuma does not notify if a Docker container is unhealthy, it will show as pending. No notification will be sent. Github Issue

Go to Settings -> Docker Hosts to create a Docker host.
Under Add a new monitor, select Docker container and choose the corresponding Docker host

Remote Hosts

By default, it requires mounted Docker sockets. It also supported socket over tcp or a socket proxy. For remote hosts it’s best to use tailscale and expose the appropriate docker socket to tailscale only.

Notification

Configured under Settings -> Notifications

  • it’s possible to apply a newly added notification to all existing monitors
  • when it’s set as default, all new monitors will have this notification

Tags

Tags can be added in Settings -> Tags, it can be applied to monitors. In the main page, tags can be filtered.
- tags cannot be used as a filter for status page or maintenance

Status Page

Status page
Maintenance
SSO
Monitor services behind Authelia
Remote Docker Hosts
Autokuma

Comments