apprise v0.1.0

Notifications

Apprise — a single notification gateway that relays push notifications to 100+ services (Telegram, Discord, Slack, ntfy, email, Matrix, and more) through one simple HTTP API. Point all your apps at it and manage destinations centrally. Deployed as a host-networked Nomad service with a persistent config volume.

nomad-pack run apprise --registry nomploy

…or one line (add registry + run)

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

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

Source ↗ Project ↗ ★ 1.3k ⚑ Report an issue

1 task http 8000 1 volume image caronc/apprise:latest tracks :latest image bumped today

Variables 10

values.hcl

Save as values.hcl, edit, then run:

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

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

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

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

# The Apprise API container image. Pin a tag in production.
image = "caronc/apprise:latest"

# Host port for the Apprise API / web UI. The container listens on 8000.
port = 8000

# Persistent config storage mode (APPRISE_STATEFUL_MODE): 'simple', 'hash', or 'disabled'.
stateful_mode = "simple"

# Number of API workers (APPRISE_WORKER_COUNT).
worker_count = 1

# Named volume for saved notification configs (/config).
config_volume = "apprise_config"

# Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# Resources for the Apprise task.
resources = {
    cpu    = 300
    memory = 256
  }

Name	Type	Default	Description
job_name	string	"apprise"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"caronc/apprise:latest"	The Apprise API container image. Pin a tag in production.
port	number	8000	Host port for the Apprise API / web UI. The container listens on 8000.
stateful_mode	string	"simple"	Persistent config storage mode (APPRISE_STATEFUL_MODE): 'simple', 'hash', or 'disabled'.
worker_count	number	1	Number of API workers (APPRISE_WORKER_COUNT).
config_volume	string	"apprise_config"	Named volume for saved notification configs (/config).
constraints	list	[]	Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 300 memory = 256 }	Resources for the Apprise task.

Back up this pack

This pack stores data in one Docker named volume: apprise_config

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/apprise_config/_data

rclone (sync to S3/R2)

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

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

apprise

Apprise — one notification gateway for everything. It relays messages to 100+ services (Telegram, Discord, Slack, ntfy, Matrix, email, Pushover, webhooks, and many more) through a single HTTP API, so your apps only ever need to know about Apprise.

Single host-networked Nomad service with a persistent /config volume for saved destinations.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run apprise --registry=nomploy

Configure

Variable	Default	Description
`port`	`8000`	API / web UI port. The container listens on 8000 — keep this unless you also change the image.
`stateful_mode`	`simple`	`APPRISE_STATEFUL_MODE` — how saved configs are stored (`simple` / `hash` / `disabled`).
`worker_count`	`1`	`APPRISE_WORKER_COUNT` — API workers.
`config_volume`	`apprise_config`	`/config` — saved notification configurations.
`image`	`caronc/apprise:latest`	Container image. Pin a tag in production.
`resources`	`{ cpu = 300, memory = 256 }`	Task resources.

Add a configuration in the web UI under a key, then trigger it from anywhere:

curl -X POST -d '{"body":"Deploy finished"}' -H "Content-Type: application/json" \
  http://<node-ip>:8000/notify/<your-config-key>

The API has no authentication — keep it internal or behind a reverse proxy. Pin the job to the node holding the volume with constraints.