ntfy v0.1.0

Notifications

ntfy — a simple pub/sub notification service: send push notifications to your phone or desktop from any script via a plain HTTP PUT/POST. Deployed as a host-networked Nomad service with a persistent Docker volume for its message cache and users.

nomad-pack run ntfy --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- ntfy

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

Source ↗ Project ↗ ★ 34.9k ⚑ Report an issue

1 task http 8090 1 volume image binwiederhier/ntfy:latest tracks :latest image bumped 1 mo ago

Variables 10

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run ntfy -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "ntfy"

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

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

# The ntfy container image. Pin a tag in production.
image = "binwiederhier/ntfy:latest"

# Host port for the ntfy HTTP server (web app + API).
port = 8090

# Public base URL ntfy is served at (e.g. https://ntfy.example.com). Recommended — the web app and mobile clients use it. Empty = leave unset.
base_url = ""

# Set true when running behind a reverse proxy (enables correct client IP handling for rate limits).
behind_proxy = false

# Docker named volume for /var/lib/ntfy (message cache, user/auth database, attachments). ntfy runs as root, so a fresh volume is writable.
data_volume = "ntfy_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    = 200
    memory = 128
  }

Name	Type	Default	Description
job_name	string	"ntfy"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"binwiederhier/ntfy:latest"	The ntfy container image. Pin a tag in production.
port	number	8090	Host port for the ntfy HTTP server (web app + API).
base_url	string	""	Public base URL ntfy is served at (e.g. https://ntfy.example.com). Recommended — the web app and mobile clients use it. Empty = leave unset.
behind_proxy	bool	false	Set true when running behind a reverse proxy (enables correct client IP handling for rate limits).
data_volume	string	"ntfy_data"	Docker named volume for /var/lib/ntfy (message cache, user/auth database, attachments). ntfy runs as root, so a fresh volume is writable.
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 = 200 memory = 128 }	The task resources.

Back up this pack

This pack stores data in one Docker named volume: ntfy_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/ntfy_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/ntfy_data/_data backup:<bucket>/ntfy_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

ntfy

ntfy — a simple pub/sub notification service. Send push notifications to your phone or desktop from any script with a plain HTTP PUT/POST. Great for alerting from cron jobs, CI, or the monitoring/uptime-kuma packs. Host-networked Nomad service with a persistent Docker volume.

Usage

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

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

Publish and subscribe:

curl -d "Backup finished" http://<node-ip>:8090/mytopic

Subscribe to mytopic in the web app (http://<node-ip>:8090) or the ntfy mobile app.

Key variables

Variable	Default	Notes
`image`	`binwiederhier/ntfy:latest`	Pin a tag in production.
`port`	`8090`	HTTP server host port.
`base_url`	`""`	Public URL — recommended; the web/mobile apps need it correct.
`behind_proxy`	`false`	Set true behind a reverse proxy (correct client IPs for rate limits).
`data_volume`	`ntfy_data`	cache.db + auth.db + attachments. Back it up.
`constraints`	`[]`	Pin to a node so the local volume stays put.
`resources`	`cpu 200 / mem 128`	Lightweight.

Notes

Single node. count is fixed to 1 (local volume). Pin with constraints.
ntfy runs as root in the image, so a fresh volume is writable (no chown).
For the mobile apps you must set base_url and serve over HTTPS (put it behind a reverse proxy). By default any topic is world-readable/writable; use ntfy's access control (auth.db) to lock it down.