dankhostself-host anything

ntfy with Docker Compose

ntfy is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, and/or using a REST API. In the project's words: ntfy.sh front page checked 2026-09-25

Runs on: amd64, arm64, arm/v7, arm/v6 from each image's registry manifest, checked 2026-09-25; a CPU counts only if every image has a build for it. Image by image

Add ntfy to the builder to use your own domain and combine it with other apps in one file.

What ntfy needs

Only figures ntfy's own documentation publishes, each linked to the page it is on. Where the project gives no number, this page does not invent one.

ResourceMinimumRecommended
RAMThe project publishes no figure
CPUThe project publishes no figure
DiskThe project publishes no figure

On top of this, Caddy (the reverse proxy in the file) is a single small container.

Which hardware ntfy has images for

Read from each image's manifest list in its registry (anonymous, read-only) when this page was built. An app counts for a CPU only if every one of its images lists it.

  • x86-64 PC or NAS (linux/amd64): every image has a build.
  • Raspberry Pi 4/5, 64-bit OS (linux/arm64): every image has a build.
  • Raspberry Pi 3 or Zero 2 W, 32-bit OS (linux/arm/v7): every image has a build.
ServiceImagePlatforms in the manifestDigestRegistryChecked
ntfybinwiederhier/ntfyamd64, arm64, arm/v6, arm/v7sha256:6ef4b819f722fccdc036af611c4774cfdc2de821ab74fdd48bbf4c9d6f8973daregistry-1.docker.io2026-09-25

A manifest says an image exists for a CPU, not how well ntfy runs on it: a build for arm64 or arm/v7 can still be too slow or need more memory than the board has. The RAM and disk ntfy publishes are in the table above and, for a whole set of apps against a Raspberry Pi, on Will it run on my machine?. A tag like latest can move to a new digest after the date checked.

docker-compose.yml

A self-hosted ntfy reaches an iPhone instantly only with help from a central server, ntfy's docs explain: “Unlike Android, iOS heavily restricts background processing, which sadly makes it impossible to implement instant push notifications without a central server.” “If upstream-base-url is not set, notifications will still eventually get to your device, but delivery can take hours, depending on the state of the phone.” ntfy docs: Configuring the ntfy server (Docker Compose with auth, cache and attachments; behind a proxy) checked 2026-10-09 Off, the file below is the builder's, without that setting. On, it has one more line, the one ntfy's own docker-compose example sets: your server then asks the public ntfy.sh server to wake the iPhone, and the phone fetches the message from your server.

The builder on the front page still writes the file with this switch off; copy the on file from this page.

Both files come below, off first; with JavaScript on, the switch shows only the one you pick.

This is exactly what the builder writes for ntfy alone on example.org: the official definition with its published ports removed and Caddy added in front.

# docker-compose.yml built at dankhost.com for: ntfy
# Each app block is its official compose definition. Only the names were prefixed with
# the app slug (services, containers, volumes, bind folders, .env variables) so any set of
# apps can share one file; other differences are listed under "Changed:" in each block.
# Only Caddy publishes ports. Secrets live in .env next to this file.

services:
  # ---- Caddy: the one reverse proxy, HTTPS certificates from Let's Encrypt ----
  # Source: https://caddyserver.com/docs/running (checked 2026-09-23)
  # Source: https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose (checked 2026-09-23)
  # Caddyfile goes in ./caddy/Caddyfile. Fixed address 172.30.0.2 so apps can trust it exactly.
  caddy:
    image: "caddy:2"
    container_name: "caddy"
    restart: "unless-stopped"
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - "./caddy:/etc/caddy"
      - "caddy-data:/data"
      - "caddy-config:/config"
    networks:
      proxy:
        ipv4_address: "172.30.0.2"

  # ---- ntfy (ntfy.example.org) ----
  # Source: https://docs.ntfy.sh/install/ (checked 2026-09-25)
  # Source: https://docs.ntfy.sh/config/ (checked 2026-09-25)
  # Changed: Removed the '80:80' port; Caddy reaches ntfy:80 on the proxy network.
  #          NTFY_BASE_URL is your https address instead of the example's ntfy.example.com.
  #          Removed NTFY_AUTH_USERS, which carries the example user's bcrypt hash; create your own user with the command in the notes.
  #          The documented './' data folder (the compose file's own folder) becomes ./data, so ntfy's databases do not sit next to docker-compose.yml.
  ntfy:
    image: "binwiederhier/ntfy"
    container_name: "ntfy"
    restart: "unless-stopped"
    environment:
      NTFY_BASE_URL: "https://ntfy.example.org"
      NTFY_CACHE_FILE: "/var/lib/ntfy/cache.db"
      NTFY_AUTH_FILE: "/var/lib/ntfy/auth.db"
      NTFY_AUTH_DEFAULT_ACCESS: "deny-all"
      NTFY_BEHIND_PROXY: "true"
      NTFY_ATTACHMENT_CACHE_DIR: "/var/lib/ntfy/attachments"
      NTFY_ENABLE_LOGIN: "true"
    volumes:
      - "./ntfy/data:/var/lib/ntfy"
    command: "serve"
    networks:
      proxy: {}

networks:
  # Pinned so the trusted-proxy address given to each app (172.30.0.2) is exact.
  # If "docker compose up" reports "Pool overlaps", change 172.30.0 here, in Caddy's
  # ipv4_address and in every trusted-proxy value to a free 172.x.0 range.
  proxy:
    ipam:
      config:
        - subnet: "172.30.0.0/24"
          ip_range: "172.30.0.128/25"
          gateway: "172.30.0.1"

volumes:
  caddy-data:
  caddy-config:

With iPhone notifications on

The same file with one more line under environment:, NTFY_UPSTREAM_BASE_URL: https://ntfy.sh. Everything else, comments included, is the off file as the builder writes it for ntfy alone on example.org.

# docker-compose.yml built at dankhost.com for: ntfy
# Each app block is its official compose definition. Only the names were prefixed with
# the app slug (services, containers, volumes, bind folders, .env variables) so any set of
# apps can share one file; other differences are listed under "Changed:" in each block.
# Only Caddy publishes ports. Secrets live in .env next to this file.

services:
  # ---- Caddy: the one reverse proxy, HTTPS certificates from Let's Encrypt ----
  # Source: https://caddyserver.com/docs/running (checked 2026-09-23)
  # Source: https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose (checked 2026-09-23)
  # Caddyfile goes in ./caddy/Caddyfile. Fixed address 172.30.0.2 so apps can trust it exactly.
  caddy:
    image: "caddy:2"
    container_name: "caddy"
    restart: "unless-stopped"
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - "./caddy:/etc/caddy"
      - "caddy-data:/data"
      - "caddy-config:/config"
    networks:
      proxy:
        ipv4_address: "172.30.0.2"

  # ---- ntfy (ntfy.example.org) ----
  # Source: https://docs.ntfy.sh/install/ (checked 2026-09-25)
  # Source: https://docs.ntfy.sh/config/ (checked 2026-09-25)
  # Changed: Removed the '80:80' port; Caddy reaches ntfy:80 on the proxy network.
  #          NTFY_BASE_URL is your https address instead of the example's ntfy.example.com.
  #          Removed NTFY_AUTH_USERS, which carries the example user's bcrypt hash; create your own user with the command in the notes.
  #          The documented './' data folder (the compose file's own folder) becomes ./data, so ntfy's databases do not sit next to docker-compose.yml.
  ntfy:
    image: "binwiederhier/ntfy"
    container_name: "ntfy"
    restart: "unless-stopped"
    environment:
      NTFY_BASE_URL: "https://ntfy.example.org"
      NTFY_CACHE_FILE: "/var/lib/ntfy/cache.db"
      NTFY_AUTH_FILE: "/var/lib/ntfy/auth.db"
      NTFY_AUTH_DEFAULT_ACCESS: "deny-all"
      NTFY_BEHIND_PROXY: "true"
      NTFY_ATTACHMENT_CACHE_DIR: "/var/lib/ntfy/attachments"
      NTFY_ENABLE_LOGIN: "true"
      NTFY_UPSTREAM_BASE_URL: https://ntfy.sh
    volumes:
      - "./ntfy/data:/var/lib/ntfy"
    command: "serve"
    networks:
      proxy: {}

networks:
  # Pinned so the trusted-proxy address given to each app (172.30.0.2) is exact.
  # If "docker compose up" reports "Pool overlaps", change 172.30.0 here, in Caddy's
  # ipv4_address and in every trusted-proxy value to a free 172.x.0 range.
  proxy:
    ipam:
      config:
        - subnet: "172.30.0.0/24"
          ip_range: "172.30.0.128/25"
          gateway: "172.30.0.1"

volumes:
  caddy-data:
  caddy-config:

/check/ flags Image tag is latest, or missing (which means latest) in this file.

Caddyfile save as caddy/Caddyfile

Caddy gets and renews the HTTPS certificate for ntfy.example.org by itself once the DNS record points at your server and ports 80 and 443 reach it.

# Caddyfile built at dankhost.com. Save it as ./caddy/Caddyfile next to docker-compose.yml.
# Caddy gets and renews a Let's Encrypt certificate for each name below by itself,
# once the DNS records point at this server and ports 80 and 443 reach it.

# ntfy
ntfy.example.org {
	reverse_proxy ntfy:80
}

Already running nginx, Nginx Proxy Manager, Caddy or Traefik? The reverse-proxy settings ntfy needs, for all four, each cited to ntfy's own docs.

.env

ntfy needs no secret here; the builder adds nothing you have to fill in by hand.

# .env for ntfy, from dankhost.com/app/ntfy/. Nothing here is secret.
# Keep this file private (chmod 600).
# None of the chosen apps needs a variable here.

Changes from the official file

Besides prefixing every service, container, volume, folder and variable with ntfy (so any set of apps can share one file), these are all the differences from what the project documents:

  • Removed the '80:80' port; Caddy reaches ntfy:80 on the proxy network.
  • NTFY_BASE_URL is your https address instead of the example's ntfy.example.com.
  • Removed NTFY_AUTH_USERS, which carries the example user's bcrypt hash; create your own user with the command in the notes.
  • The documented './' data folder (the compose file's own folder) becomes ./data, so ntfy's databases do not sit next to docker-compose.yml.

Notes for ntfy behind the proxy

  • Access is deny-all, as in the documented file: nobody can publish or read until you add a user. Create an admin with: docker compose exec ntfy ntfy user add --role=admin yourname
  • In the ntfy phone app, add https://ntfy.example.org as the default server and log in with that user. iPhone push for a self-hosted server needs NTFY_UPSTREAM_BASE_URL set to the public ntfy.sh server's address (the config page's iOS example); turn on the iPhone notifications switch above the compose file to get the file with that line.
  • In the ntfy phone app, add https://ntfy.example.org as the default server and log in with that user. iPhone notifications is on: NTFY_UPSTREAM_BASE_URL is https://ntfy.sh, so your server asks ntfy.sh to wake an iPhone for each new message, and the phone then fetches the message from https://ntfy.example.org.
  • Publish from any script: curl -u yourname -d "Backup finished" https://ntfy.example.org/alerts

How to run it

  1. At your DNS provider, add an A record named ntfy on your domain pointing at the server's public IP address, and forward TCP 80, TCP 443 and UDP 443 to it.
  2. Save the three files in one folder: docker-compose.yml and .env side by side, the Caddyfile at ./caddy/Caddyfile. Replace example.org with your domain in the Caddyfile, the compose file and the .env, or let the builder do it.
  3. Nothing in .env needs filling in; chmod 600 .env all the same.
  4. Start it:
    docker compose up -d
    docker compose logs -f caddy   # watch the certificate arrive
  5. Open the new address (ntfy. plus your domain) in a browser and follow the notes above.

Back it up

ntfy publishes no backup procedure in its docs. Everything it keeps is in ./data: the message cache, the user database and attachments. The copy below follows Docker's generic method with ntfy stopped.

Below is the BACKUP.md the builder writes next to the compose file above: which of its folders and volumes hold data, what to copy with which container stopped, and a restore check. Pick more apps in the builder and it covers them all in one file.

# BACKUP.md built at dankhost.com for: ntfy

What to copy from the docker-compose.yml built with this file, the database dump each project documents (rewritten for the service names in that file), what to copy with which container stopped, and how to check the result. Run every command in the folder that holds docker-compose.yml.

The folders are owned by the containers' users: put sudo in front of tar if it says "Permission denied". Named volumes live under /var/lib/docker/volumes, not next to the compose file, so they are copied through a throwaway ubuntu container (Docker's documented --volumes-from method). tar makes a full copy each run; for large folders an incremental tool (restic, borg, rsync) saves time and space.

Never run "docker compose down -v" on this file: it deletes the named volumes of every app in it.

## Before you start

    BACKUP=/mnt/backup/selfhost   # change this: a disk or machine other than this server's system disk
    mkdir -p "$BACKUP"

## Every time: the three stack files

    tar czf "$BACKUP/stack-files.tar.gz" docker-compose.yml .env caddy

.env holds the database passwords and secret keys the apps were set up with; keep this archive as private as the data.

## Caddy (the reverse proxy)

Caddy's docs: 'The data directory must not be treated as a cache.' It holds the TLS certificates and their private keys; without it Caddy has to ask Let's Encrypt for every certificate again.

- caddy-data (named volume, /data in caddy)
  BACK UP: TLS certificates, private keys, OCSP staples.
- caddy-config (named volume, /config in caddy)
  SKIP: the last active configuration, kept for 'caddy run --resume', which this setup does not use: it starts from the Caddyfile.
- ./caddy (/etc/caddy in caddy)
  IN stack-files.tar.gz: the Caddyfile, copied with the stack files above.

Copy (Caddy keeps serving while you copy):

    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu tar cvf /backup/caddy-data.tar /data

Restore check:

    tar tf "$BACKUP/caddy-data.tar" > /dev/null && echo OK
    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu bash -c "cd /data && tar xvf /backup/caddy-data.tar --strip 1"

Sources:
- Caddy docs: Conventions, Data directory: https://caddyserver.com/docs/conventions#data-directory (checked 2026-09-24)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-24)

## ntfy

ntfy publishes no backup procedure in its docs. Everything it keeps is in ./data: the message cache, the user database and attachments. The copy below follows Docker's generic method with ntfy stopped.

What this compose mounts:
- ./ntfy/data (/var/lib/ntfy in ntfy)
  BACK UP: auth.db (users and access rules), cache.db (recent messages) and attachments/.

1. Stop ntfy. Stopping it keeps the SQLite databases from changing mid-copy.

    docker compose stop ntfy

2. Copy while ntfy is stopped:

    tar czf "$BACKUP/ntfy-data.tar.gz" ./ntfy/data

3. Start it again:

    docker compose start ntfy

Restore check:

    tar tzf "$BACKUP/ntfy-data.tar.gz" > /dev/null && echo OK

Put a copy back (with ntfy stopped):

    tar xzf "$BACKUP/ntfy-data.tar.gz"   # recreates ./ntfy/data; move the old folder aside first

Stop it, put ./ntfy/data back, start it. Without auth.db every user has to be created again.

Sources:
- ntfy docs: Configuring the ntfy server (Docker Compose with auth, cache and attachments; behind a proxy): https://docs.ntfy.sh/config/ (checked 2026-09-25)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-25)

Update it

What docker compose pull does depends only on how each image line in the compose file above is tagged. For ntfy as this page writes it:

ServiceImageHow it is pinnedWhat docker compose pull does
caddycaddy:2Major version only (tag 2)Takes the newest image tagged 2: minor and patch releases of 2, never 3. A new major version needs a tag edit.
ntfybinwiederhier/ntfyNot pinned: no tag, which means latestMoves to the newest image published as latest, which can be a new major version.

What ntfy's docs say about updating

ntfy publishes no update procedure for this setup; the steps below are Docker's generic method.

The steps

  1. Back up first, as in Back it up above. An update can migrate ntfy's data on its first start; the copy is the way back.
  2. Download the new images. Running containers are not touched yet:
    docker compose pull
  3. Recreate the containers whose image changed. Volumes and bind-mounted folders stay as they are:
    docker compose up -d
  4. Watch ntfy start (Ctrl+C stops following the log, not the app):
    docker compose logs -f ntfy
  5. Optional: remove the old images the pull left without a tag. This covers every stack on the machine, not only this one:
    docker image prune

Docker's reference for these commands: Docker docs: docker compose pull checked 2026-09-30; Docker docs: docker compose up (recreates changed containers, keeps volumes) checked 2026-09-30; Docker docs: docker image prune checked 2026-09-30

Locked out? Reset the admin password

Changes the password of a user in ntfy's user database (/var/lib/ntfy/auth.db here, set by NTFY_AUTH_FILE).

  1. List the users: Source: ntfy docs: Configuring the ntfy server, Users and roles read 2026-10-03
    docker compose exec ntfy ntfy user list
  2. Change the password: Source: ntfy docs: Configuring the ntfy server, Users and roles read 2026-10-03
    docker compose exec ntfy ntfy user change-pass '<admin user>'

Run the commands in the folder that holds docker-compose.yml. Words in angle brackets are placeholders: replace them, brackets included. docker compose exec runs the command in the container that is already running: Docker docs: docker compose exec read 2026-10-03

Sources

Every page below was fetched on the date shown.

Add ntfy to the builder All one hundred apps

Made with AI tools. · Privacy