ntfy¶

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.

Note

For this guide you should be familiar with the basic concepts of

Prerequisites¶

Your ntfy URL needs to be setup:

[isabell@stardust ~]$ uberspace web domain list
isabell.uber.space
[isabell@stardust ~]$

Installation¶

Like a lot of Go software, ntfy is distributed as a single binary, which in this case is the server and the client component. Download ntfy’s latest release, verify the checksum specified in the respective .sha256 file and finally extract the files.

[isabell@stardust ~]$ mkdir ~/ntfy
[isabell@stardust ~]$ wget -O ntfy.tar.gz https://github.com/binwiederhier/ntfy/releases/download/v1.28.0/ntfy_1.28.0_linux_x86_64.tar.gz
[...]
[isabell@stardust ~]$ tar --strip-components=1 -xzf ntfy.tar.gz -C ~/ntfy/
[isabell@stardust ~]$ rm ntfy.tar.gz
[isabell@stardust ~]$

Configuration¶

Create a configuration file¶

Use your favourite editor to create ~/ntfy/server.yml with the following content. Make sure to replace the base-url and <username> with your own.

 base-url: https://isabell.uber.space
 listen-http: ":8008"
 cache-file: /home/<username>/ntfy/cache.db
 cache-duration: "12h"
 auth-file: "/home/<username>/ntfy/auth.db"
 auth-default-access: "deny-all"
 behind-proxy: true
 attachment-cache-dir: "/home/<username>/ntfy/attachments"
 attachment-total-size-limit: "1G"
 attachment-file-size-limit: "1M"
 attachment-expiry-duration: "3h"
 keepalive-interval: "45s"
 manager-interval: "2m"
 web-root: app
 upstream-base-url: "https://ntfy.sh"
 visitor-subscription-limit: 30
 log-level: INFO

Configure web server¶

Note

ntfy will be running on port 8008.

To make the application accessible from the outside, configure a web backend:

[isabell@stardust ~]$ uberspace web backend set / --http --port <port>
Set backend for / to port <port>; please make sure something is listening!
You can always check the status of your backend using "uberspace web backend list".
[isabell@stardust ~]$

Setup daemon¶

To start ntfy automatically and run it in the background, create ~/etc/services.d/ntfy.ini with the following content:

[program:ntfy]
command=%(ENV_HOME)s/ntfy/ntfy serve --config %(ENV_HOME)s/ntfy/server.yml
startsecs=5

After creating the configuration, tell supervisord to refresh its configuration and start the service:

[isabell@stardust ~]$ supervisorctl reread
SERVICE: available
[isabell@stardust ~]$ supervisorctl update
SERVICE: added process group
[isabell@stardust ~]$ supervisorctl status
SERVICE                            RUNNING   pid 26020, uptime 0:03:14
[isabell@stardust ~]$

Finishing installation¶

Point your browser to the URL you set up, e. g. https://isabell.uber.space.

Add password¶

Warning

Without password everybody in the internet can load files from and to your uberspace account!

To protect access to your ntfy instance, the default configuration above permits no access. Add a user with role admin:

[isabell@stardust ~]$ cd ~/ntfy
[isabell@stardust ntfy]$ ./ntfy user --config server.yml add --role=admin isabell
[isabell@stardust ntfy]$ ./ntfy user --config server.yml list
user isabell (admin)
- read-write access to all topics (admin role)
user * (anonymous)
- no topic-specific permissions
- no access to any (other) topics (server config)

Updates¶

Note

Ntfy must be updated manually.

Tested with ntfy 1.28.0 Uberspace 7.2.14.0

Written by: jpmens <https://jpmens.net>