Ntfy

Overview

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, cost or setup. It's also open source if you want to run your own. Publishing a message to a topic is as simple as: curl -d "Backup successful 😀" ntfy.sh/mytopic By default, the ntfy server is open for everyone, meaning everyone can read and write to any topic (this is how ntfy.sh is configured). To restrict access to your own server, you can optionally configure authentication and authorization using NTFY_AUTH_FILE and NTFY_AUTH_DEFAULT_ACCESS. After that, simply create an admin user: ntfy user add --role=admin phil password: mypass confirm: mypass user phil added with role admin Once you've done that, you can publish and subscribe using Basic Auth with the given username/password.

Runtime arguments

Web UI: http://[IP]:[PORT:80]/
Network: bridge
Shell: sh
Privileged: false
Extra Params: --restart unless-stopped

Template configuration

Host Port 1Porttcp

Target: 80
Value: 8080

NTFY_BASE_URLVariable

Value: https://ntfy.israndom.win

NTFY_WEB_ROOTVariable

Sets web root to landing page (home), web app (app) or disables the web app entirely (disable).

Default: app
Value: app

NTFY_UPSTREAM_BASE_URLVariable

Forward poll request to an upstream server, this is needed for iOS push notifications for self-hosted servers.

Default: https://ntfy.sh
Value: https://ntfy.sh

NTFY_CACHE_FILEVariable

If set, messages are cached in a local SQLite database instead of only in-memory. This allows for service restarts without losing messages in support of the since= parameter.

Default: /config/cache.db
Value: /config/cache.db

NTFY_CACHE_DURATIONVariable

Duration for which messages will be buffered before they are deleted (e.g. 30s, 20m, 20h). This is required to support the since=... and poll=1 parameter. Set this to 0 to disable the cache entirely.

Default: 12h
Value: 12h

NTFY_AUTH_FILEVariable

Auth database file used for access control. If set, enables authentication and access control.

Default: /config/user.db
Value: /config/user.db

NTFY_AUTH_DEFAULT_ACCESSVariable

Default permissions if no matching entries in the auth database are found. Default is read-write.

Default: read-write
Value: deny-all

NTFY_ATTACHMENT_CACHE_DIRVariable

Cache directory for attached files. To enable attachments, this has to be set. NOTE: If NTFY_ATTACHMENT_CACHE_DIR is set then NFTY_BASE_URL is also required.

Default: /config/attachments
Value: /config/attachments

NTFY_ATTACHMENT_TOTAL_SIZE_LIMITVariable

Limit of the on-disk attachment cache directory (e.g. 300k, 2M, 100M). If the limits is exceeded, new attachments will be rejected.

Default: 5G
Value: 5G

NTFY_ATTACHMENT_FILE_SIZE_LIMITVariable

Per-file attachment size limit (e.g. 300k, 2M, 100M). Larger attachment will be rejected.

Default: 15M
Value: 15M

NTFY_ATTACHMENT_EXPIRY_DURATIONVariable

Duration after which uploaded attachments will be deleted (e.g. 30s, 20m, 20h).

Default: 3h
Value: 3h

NTFY_SMTP_SENDER_ADDRVariable

SMTP server address to allow email sending.

NTFY_SMTP_SENDER_USERVariable

SMTP user; only used if e-mail sending is enabled.

NTFY_SMTP_SENDER_PASSVariable

SMTP password; only used if e-mail sending is enabled.

NTFY_SMTP_SENDER_FROMVariable

SMTP sender e-mail address; only used if e-mail sending is enabled.

NTFY_SMTP_SERVER_ADDR_PREFIXVariable

Optional prefix for the e-mail addresses to prevent spam, e.g. ntfy-.

NTFY_LOG_LEVELVariable

Set log level. Options: INFO, WARN, ERROR, DEBUG or TRACE

Default: info
Value: info

AppdataPathrw

Target: /config
Default: /mnt/user/appdata/ntfy
Value: /mnt/user/appdata/ntfy

Links

Template Support Docker Hub Project

Details

Repository

binwiederhier/ntfy

Registry

https://hub.docker.com/r/binwiederhier/ntfy

Last Updated2026-04-21

First Seen2022-11-13

Run Ntfy on Unraid.

Ntfy is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS