Skip to content
homelab-docs

Uptime Kuma

Uptime Kuma is a self-hosted status monitoring solution that allows you to monitor the uptime of your services. It provides a web interface to track the availability of your applications and services, making it easy to identify issues and ensure your systems are running smoothly.

compose.yaml
services:
  uptime-kuma:
    image: louislam/uptime-kuma:latest
    container_name: uptime-kuma
    # ports:
    #   - 3001:3001
    volumes:
      - uptimekuma-data:/app/data
      - /var/run/docker.sock:/var/run/docker.sock
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.uptimekuma-https.tls=true"
      - "traefik.http.routers.uptimekuma-https.entrypoints=websecure"
      - "traefik.http.routers.uptimekuma-https.tls.certresolver=cloudflare"
      - "traefik.http.routers.uptimekuma-https.rule=Host(`kuma.nixlab.ch`)"
      - "traefik.http.services.uptimekuma.loadbalancer.server.port=3001"
    networks:
      - traefik_proxy
    restart: unless-stopped


volumes:
  uptimekuma-data:
    driver: local


networks:
  traefik_proxy:
    external: true

Configuration

Section titled “Configuration”

You can access Uptime Kuma by navigating to your FQDN, in this example https://kuma.nixlab.ch in your web browser. The interface allows you to add services to monitor, configure notification settings, and view the status of your monitored services.

Usage

Section titled “Usage”

To use Uptime Kuma, follow these steps:

  1. Start the Uptime Kuma container using the provided compose.yaml configuration.

  2. Open your web browser and go to https://kuma.nixlab.ch.

  3. Create an account or log in if you already have one.

  4. Add services to monitor by clicking on the “Add Monitor” button.

  5. Configure the monitoring settings for each service, including the URL to check, the check interval, and notification settings.

  6. Save the configuration and Uptime Kuma will start monitoring the specified services.

References