Portainer Templates logo

Portainer Templates

ntfy ntfy

Container

NotificationsMessaging

Simple HTTP-based pub-sub notification service. Send push notifications to your phone or desktop via PUT/POST. Source: https://github.com/binwiederhier/ntfy

Image details

Pulls: 20.9M
Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 34 MB
Latest: v2.27
User: binwiederhier
Created: Oct 24, 2021
Updated: 11 days ago
Status: active

Source details

Repo: binwiederhier/ntfy
Stars: 33.5k
Forks: 2k
Language: Go
License: Apache-2.0
Latest: v2.27.0 · 11 days ago
Updated: 4 days ago
Website: ntfy.sh/

Configuration

Type
Container
Platform
linux
Image
binwiederhier/ntfy:latest
Command
serve --cache-file /var/cache/ntfy/cache.db
Ports
8080:80/tcp
Volumes
/var/cache/ntfy/etc/ntfy
Env vars
NTFY_BASE_URL=http://localhost:8080TZ=UTC
Restart
unless-stopped

Standalone Install

Select an install method, to see config/commands for deploying ntfy

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select ntfy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see binwiederhier/ntfy for app-specific guidance.

ntfy

ntfy.sh | Send push notifications to your phone or desktop via PUT/POST

Release Go Reference Tests Go Report Card codecov Discord Matrix Healthcheck
ntfy (pronounce: notify) 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, entirely without signup or cost. It's also open source (as you can plainly see) if you want to run your own.
I run a free version of it at ntfy.sh, and there's an open source Android app too.

Docker image

This is the Docker image for ntfy. The image contains both server and a CLI to publish and subscribe to topics. It is available for amd64, armv7 and arm64. It should be pretty straight forward to use. Check out up-to-date instructions in the documentation.
The server exposes its web UI and the API on port 80, so you need to expose that in Docker. To use the persistent message cache, you also need to map a volume to /var/cache/ntfy. To change other settings, you should map /etc/ntfy, so you can edit /etc/ntfy/server.yml.
Basic usage (no cache or additional config): 
docker run -p 80:80 -it binwiederhier/ntfy serve

With persistent cache (configured as command line arguments): 
docker run \
  -v /var/cache/ntfy:/var/cache/ntfy \
  -p 80:80 \
  -it \
  binwiederhier/ntfy \
    --cache-file /var/cache/ntfy/cache.db \
    serve

With other config options (configured via /etc/ntfy/server.yml, see configuration for details): 
docker run \
  -v /etc/ntfy:/etc/ntfy \
  -p 80:80 \
  -it \
  binwiederhier/ntfy \
  serve

Alternatively, you may wish to build a customized Docker image that can be run with fewer command-line arguments and without delivering the configuration file separately. 
FROM binwiederhier/ntfy
COPY server.yml /etc/ntfy/server.yml
ENTRYPOINT ["ntfy", "serve"]
This image can be pushed to a container registry and shipped independently. All that's needed when running it is mapping ntfy's port to a host port.

Serve ntfy on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying ntfy.example.com to http://ntfy:80

Add this to your Caddyfile

ntfy.example.com {
	reverse_proxy http://ntfy:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs ntfy
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8080
  • Stop the other service, or pick a different host port. In 8080:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, ntfy can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Image won't pull

Test the pull directly on the host: docker pull binwiederhier/ntfy:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect ntfy --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

ntfy runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything ntfy needs bundled into one download. This template pulls binwiederhier/ntfy:latest, which Docker fetches once (about 34 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. ntfy's comes from Docker Hub, published by binwiederhier.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v2.27. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8080:80 means it's reachable on port 8080 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8080 in a browser. It opens:

  • 8080:80, likely the web interface

Volumes

A volume is where ntfy keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/cache/ntfy as a volume Docker manages for you
  • /etc/ntfy as a volume Docker manages for you

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. ntfy takes 2 of them, all with defaults you can leave alone or tweak:

  • NTFY_BASE_URL, defaults to http://localhost:8080. Public base URL (e.g. https://ntfy.example.com) — needed for attachments and links
  • TZ, defaults to UTC. Timezone (affects scheduled delivery)

Restart policy

The restart policy here is unless-stopped, so Docker restarts ntfy after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so ntfy sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container ntfy. That's what you'll spot in the containers list and use in commands like docker logs ntfy.

Startup command

The command is what runs the moment the container starts. This template sets its own, serve --cache-file /var/cache/ntfy/cache.db, in place of the image's default.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

ntfy is open source, released under the Apache-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set ntfy up. Add the template list to Portainer once, then deploying ntfy is a click rather than a wall of config.