Nomploy Nomad Packs

← All packs

uptime-kuma v0.1.0

Observability

Uptime Kuma — a self-hosted uptime/status monitoring tool (HTTP, TCP, ping, DNS, and more) with a slick dashboard and alerting. Deployed as a host-networked Nomad service with a persistent Docker volume.

nomad-pack run uptime-kuma --registry nomploy
…or one line (add registry + run)
curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- uptime-kuma

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 92.7k ⚑ Report an issue

1 task http 3001 1 volume image louislam/uptime-kuma:1 pinned :1 image bumped 1 mo ago
Replaces PingdomStatuspage / Better UptimeUptimeRobot
Pairs with apprisecheckclecheckmkgatushealthcheckskenernetalertxntfy
Alternatives gatushealthcheckskenerstatping
Variables 8
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run uptime-kuma -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "uptime-kuma"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Uptime Kuma container image.
image = "louislam/uptime-kuma:1"

# Host port for the Uptime Kuma web UI. Default 3001 is Uptime Kuma's own default — change it if it clashes with the grafana/monitoring packs on the same node.
port = 3001

# Docker named volume for /app/data (SQLite DB, config, uploaded icons). All of Uptime Kuma's state.
data_volume = "uptime_kuma_data"

# Placement constraints — pin to one node so the local volume stays put. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }
NameTypeDefaultDescription
job_name string 
"uptime-kuma"
 The name of the Nomad job.
namespace string 
"default"
 The Nomad namespace to deploy into.
datacenters list 
["*"]
 The datacenters to deploy to.
image string 
"louislam/uptime-kuma:1"
 The Uptime Kuma container image.
port number 
3001
 Host port for the Uptime Kuma web UI. Default 3001 is Uptime Kuma's own default — change it if it clashes with the grafana/monitoring packs on the same node.
data_volume string 
"uptime_kuma_data"
 Docker named volume for /app/data (SQLite DB, config, uploaded icons). All of Uptime Kuma's state.
constraints list 
[]
 Placement constraints — pin to one node so the local volume stays put. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object 
{
    cpu    = 300
    memory = 256
  }
 The task resources.
Back up this pack

This pack stores data in one Docker named volume: uptime_kuma_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/uptime_kuma_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/uptime_kuma_data/_data backup:<bucket>/uptime_kuma_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

uptime-kuma

Uptime Kuma — a self-hosted uptime monitoring tool: HTTP(s), TCP, ping, DNS, keyword and more, with a clean dashboard, status pages, and alerting to dozens of channels (Slack, Telegram, email, webhooks). Deployed as a host-networked Nomad service with a persistent Docker volume.

Usage

nomad-pack registry add nomploy github.com/Nomploy/nomad-packs
nomad-pack run uptime-kuma --registry nomploy

In nomploy: create a Compose service, type Nomad Pack, pack uptime-kuma, custom registry github.com/Nomploy/nomad-packs, then Deploy.

Open http://<node-ip>:3001 and create the admin account on first visit.

Key variables

Variable Default Notes
image louislam/uptime-kuma:1 Pin a tag in production.
port 3001 Web UI host port. Change it if the grafana/monitoring packs already use 3001 on this node.
data_volume uptime_kuma_data SQLite DB + config. Back it up.
constraints [] Pin to a node so the local volume stays put.
resources cpu 300 / mem 256 Lightweight.

Notes