Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Uptime Kuma

Self-hosted uptime monitoring with a clean web UI. Monitors services via HTTP/HTTPS, TCP, DNS, and more, with alerting via a wide range of notification providers.

Overview

Setting Value
Image louislam/uptime-kuma:2
Access https://<UPTIME_KUMA_DOMAIN> (via Traefik)
Config /mnt/SSD/Containers/uptime-kuma

Prerequisites

Create the persistent storage directory before deploying:

mkdir -p /mnt/SSD/Containers/uptime-kuma

Uptime Kuma runs as root internally — no chown required.

Quick Start

1. Copy the environment template

cp .env.example .env

2. Edit the .env file

nano .env
Variable Description
UPTIME_KUMA_DOMAIN Hostname Traefik routes to Uptime Kuma (e.g. uptime-kuma.yourdomain.com)

3. Deploy

docker compose up -d

4. Add DNS record

In your Windows DNS server, add a CNAME pointing to the Traefik A record:

<UPTIME_KUMA_DOMAIN>  CNAME  traefik.yourdomain.com

5. Access

https://<UPTIME_KUMA_DOMAIN>

Create an admin account on first launch.

Storage

Data Path
Database, config /mnt/SSD/Containers/uptime-kuma

Maintenance

Update image

docker compose pull
docker compose up -d

Backup

docker compose down
tar -czf uptime-kuma-backup-$(date +%Y%m%d).tar.gz /mnt/SSD/Containers/uptime-kuma
docker compose up -d