ntfy

https://docs.ntfy.sh
Admin
ntfy is a simple HTTP-based service that lets you send push notifications to your phone or desktop...
Tokens:230,015
Snippets:1,803
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Manually install ntfy .deb (arm64)

Source: https://docs.ntfy.sh/install

Downloads the ntfy .deb package for arm64 and installs it with dpkg, then enables and starts the systemd service.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_arm64.deb
sudo dpkg -i ntfy_*.deb
sudo systemctl enable ntfy
sudo systemctl start ntfy

```

--------------------------------

### Manually install ntfy .deb (amd64)

Source: https://docs.ntfy.sh/install

Downloads the ntfy .deb package for amd64 and installs it with dpkg, then enables and starts the systemd service.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_amd64.deb
sudo dpkg -i ntfy_*.deb
sudo systemctl enable ntfy
sudo systemctl start ntfy

```

--------------------------------

### Download and run ntfy server on Linux arm64

Source: https://docs.ntfy.sh/install

Downloads the ntfy server v2.28.0 for arm64, extracts it, copies the binary to /usr/bin/ntfy, copies the client and server YAML configs to /etc/ntfy, and starts the server with 'sudo ntfy serve'. This is a quick way to run the server but not a permanent installation.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_arm64.tar.gz
tar zxvf ntfy_2.28.0_linux_arm64.tar.gz
sudo cp -a ntfy_2.28.0_linux_arm64/ntfy /usr/bin/ntfy
sudo mkdir /etc/ntfy && sudo cp ntfy_2.28.0_linux_arm64/{client,server}/*.yml /etc/ntfy
sudo ntfy serve
```

--------------------------------

### Manually install ntfy .deb (armv7)

Source: https://docs.ntfy.sh/install

Downloads the ntfy .deb package for armv7 and installs it with dpkg, then enables and starts the systemd service.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_armv7.deb
sudo dpkg -i ntfy_*.deb
sudo systemctl enable ntfy
sudo systemctl start ntfy

```

--------------------------------

### Install ntfy server as a Windows service

Source: https://docs.ntfy.sh/install

Creates and starts the ntfy server as a Windows service using the sc command. Run in an elevated command prompt and adjust the path to ntfy.exe.

```bash
sc create ntfy binPath="C:\path\to\ntfy.exe serve" start=auto
sc start ntfy

```

--------------------------------

### Manually install ntfy .deb (armv6)

Source: https://docs.ntfy.sh/install

Downloads the ntfy .deb package for armv6 and installs it with dpkg, then enables and starts the systemd service.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_armv6.deb
sudo dpkg -i ntfy_*.deb
sudo systemctl enable ntfy
sudo systemctl start ntfy

```

--------------------------------

### Install GoReleaser

Source: https://docs.ntfy.sh/develop

Install GoReleaser using the go install command. Verify with goreleaser -v.

```bash
go install github.com/goreleaser/goreleaser@latest
goreleaser -v   # verifies that it worked

```

--------------------------------

### Download and run ntfy server on Linux x86_64/amd64

Source: https://docs.ntfy.sh/install

Downloads the ntfy server v2.28.0 for x86_64/amd64, extracts it, copies the binary to /usr/local/bin/ntfy, copies the client and server YAML configs to /etc/ntfy, and starts the server with 'sudo ntfy serve'. This is a quick way to run the server but not a permanent installation.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_amd64.tar.gz
tar zxvf ntfy_2.28.0_linux_amd64.tar.gz
sudo cp -a ntfy_2.28.0_linux_amd64/ntfy /usr/local/bin/ntfy
sudo mkdir /etc/ntfy && sudo cp ntfy_2.28.0_linux_amd64/{client,server}/*.yml /etc/ntfy
sudo ntfy serve
```

--------------------------------

### Download and run ntfy server on Linux armv6

Source: https://docs.ntfy.sh/install

Downloads the ntfy server v2.28.0 for armv6, extracts it, copies the binary to /usr/bin/ntfy, copies the client and server YAML configs to /etc/ntfy, and starts the server with 'sudo ntfy serve'. This is a quick way to run the server but not a permanent installation.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_armv6.tar.gz
tar zxvf ntfy_2.28.0_linux_armv6.tar.gz
sudo cp -a ntfy_2.28.0_linux_armv6/ntfy /usr/bin/ntfy
sudo mkdir /etc/ntfy && sudo cp ntfy_2.28.0_linux_armv6/{client,server}/*.yml /etc/ntfy
sudo ntfy serve
```

--------------------------------

### Download and run ntfy server on Linux armv7/armhf

Source: https://docs.ntfy.sh/install

Downloads the ntfy server v2.28.0 for armv7/armhf, extracts it, copies the binary to /usr/bin/ntfy, copies the client and server YAML configs to /etc/ntfy, and starts the server with 'sudo ntfy serve'. This is a quick way to run the server but not a permanent installation.

```bash
wget https://github.com/binwiederhier/ntfy/releases/download/v2.28.0/ntfy_2.28.0_linux_armv7.tar.gz
tar zxvf ntfy_2.28.0_linux_armv7.tar.gz
sudo cp -a ntfy_2.28.0_linux_armv7/ntfy /usr/bin/ntfy
sudo mkdir /etc/ntfy && sudo cp ntfy_2.28.0_linux_armv7/{client,server}/*.yml /etc/ntfy
sudo ntfy serve
```

--------------------------------

### Install ntfy via AUR helper (paru)

Source: https://docs.ntfy.sh/install

Installs ntfy using the AUR helper paru, which downloads, builds, and installs the ntfysh-bin package.

```bash
paru -S ntfysh-bin

```

--------------------------------

### Install Go on Ubuntu

Source: https://docs.ntfy.sh/develop

Install Go on Ubuntu. Requires sudo privileges. The export line adds Go binaries to PATH for the current session.

```bash
wget https://go.dev/dl/go1.25.8.linux-amd64.tar.gz
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.25.8.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin
go version   # verifies that it worked

```

--------------------------------

### Install ntfy on FreeBSD with pkg

Source: https://docs.ntfy.sh/install

Installs the ntfy port (sysutils/go-ntfy) using the FreeBSD package manager.

```bash
pkg install go-ntfy

```

--------------------------------

### Install ntfy with nix-env

Source: https://docs.ntfy.sh/install

Installs ntfy in the current user environment using nix-env.

```bash
nix-env -iA ntfy-sh

```

--------------------------------

### Enable and start ntfy-client system service

Source: https://docs.ntfy.sh/subscribe/cli

Enables and starts the ntfy-client systemd system service as root. The service runs as the ntfy user and is started at system boot. It cannot run commands in the user's X session.

```bash
sudo systemctl enable ntfy-client
sudo systemctl restart ntfy-client
```

--------------------------------

### Action buttons example - Go

Source: https://docs.ntfy.sh/publish

Example using Go's http.NewRequest to publish a notification with view and http actions via the Actions header.

```go
req, _ := http.NewRequest("POST", "https://ntfy.sh/myhome", strings.NewReader("You left the house. Turn down the A/C?"))
req.Header.Set("Actions", "view, Open portal, https://home.nest.com/, clear=true; http, Turn down, https://api.nest.com/, body='{\"temperature\": 65}'")
http.DefaultClient.Do(req)

```

--------------------------------

### Action buttons example - PHP

Source: https://docs.ntfy.sh/publish

Example using PHP's file_get_contents to publish a notification with view and http actions via the Actions header.

```php
file_get_contents('https://ntfy.sh/reddit_alerts', false, stream_context_create([
    'http' => [
        'method' => 'POST',
        'header' =>
            "Content-Type: text/plain\r\n" .
            "Actions: view, Open portal, https://home.nest.com/, clear=true; http, Turn down, https://api.nest.com/, body='{\"temperature\": 65}'",
        'content' => 'You left the house. Turn down the A/C?'
    ]
]));

```

--------------------------------

### Action buttons example - JavaScript

Source: https://docs.ntfy.sh/publish

Example using fetch in JavaScript to publish a notification with view and http actions via the Actions header.

```javascript
fetch('https://ntfy.sh/myhome', {
    method: 'POST',
    body: 'You left the house. Turn down the A/C?',
    headers: { 
        'Actions': 'view, Open portal, https://home.nest.com/, clear=true; http, Turn down, https://api.nest.com/, body=\'{"temperature": 65}\'' 
    }
})

```

--------------------------------

### Examples of ntfy subscribe with commands

Source: https://docs.ntfy.sh/subscribe/cli

Examples of using `ntfy subscribe` with commands. The command is executed for each message, with fields available as environment variables.

```bash
ntfy sub mytopic 'notify-send "$m"'
ntfy sub topic1 /my/script.sh
ntfy sub topic1 'echo "Message $m was received. Its title was $t and it had priority $p"'

```

--------------------------------

### Action buttons example - HTTP

Source: https://docs.ntfy.sh/publish

Example HTTP POST request with the Actions header to publish a notification with view and http actions.

```http
POST /myhome HTTP/1.1
Host: ntfy.sh
Actions: view, Open portal, https://home.nest.com/, clear=true; http, Turn down, https://api.nest.com/, body='{"temperature": 65}'

You left the house. Turn down the A/C?

```

--------------------------------

### Action buttons example - Python

Source: https://docs.ntfy.sh/publish

Example using Python's requests.post to publish a notification with view and http actions via the Actions header.

```python
requests.post("https://ntfy.sh/myhome",
    data="You left the house. Turn down the A/C?",
    headers={ "Actions": "view, Open portal, https://home.nest.com/, clear=true; http, Turn down, https://api.nest.com/, body='{\"temperature\": 65}'" })

```

--------------------------------

### Serve documentation with mkdocs serve

Source: https://docs.ntfy.sh/develop

Starts a local documentation server at `http://127.0.0.1:8000/` that rebuilds on every save. The output shows the server starting and the URL to navigate to.

```bash
$ mkdocs serve
INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 5.53 seconds
INFO     -  [16:28:14] Serving on http://127.0.0.1:8000/

```

--------------------------------

### substr - get substring

Source: https://docs.ntfy.sh/publish/template-functions

Extracts a substring from a string using start and end indices. Example: substr 0 5 "hello world" returns "hello".

```text
substr 0 5 "hello world"
```

--------------------------------

### Build documentation with make docs

Source: https://docs.ntfy.sh/develop

Builds the documentation from the `docs/` directory. Requires `mkdocs` to be installed. The output is truncated in the source.

```bash
$ make docs
...
```

--------------------------------

### Delete notification via HTTP (DELETE and GET)

Source: https://docs.ntfy.sh/publish

HTTP request examples to delete a notification using DELETE or GET methods.

```http
DELETE /mytopic/my-download-123 HTTP/1.1
Host: ntfy.sh

# Or using GET
GET /mytopic/my-download-123/delete HTTP/1.1
Host: ntfy.sh
```

--------------------------------

### Build, install, and run ntfy binary

Source: https://docs.ntfy.sh/develop

Builds the ntfy binary for Linux amd64, installs it to /usr/bin/ntfy, and runs the server. On a modern system, the build should take only 5-10 seconds.

```bash
$ make cli-linux-amd64 install-linux-amd64
$ ntfy serve

```

--------------------------------

### Creating a tier (full example) with ntfy tier add

Source: https://docs.ntfy.sh/config

Full example of creating a tier named 'pro' with various limits: message limit, message expiry duration, email limit, call limit, reservation limit, attachment file size limit, attachment total size limit, attachment expiry duration, attachment bandwidth limit, and Stripe price ID.

```bash
ntfy tier add \
  --name="Pro" \
  --message-limit=10000 \
  --message-expiry-duration=24h \
  --email-limit=50 \
  --call-limit=10 \
  --reservation-limit=10 \
  --attachment-file-size-limit=100M \
  --attachment-total-size-limit=1G \
  --attachment-expiry-duration=12h \
  --attachment-bandwidth-limit=5G \
  --stripe-price-id=price_123456 \
  pro
```

--------------------------------

### ntfy serve command usage and options

Source: https://docs.ntfy.sh/config

Shows the full help output for the ntfy serve command, including usage, description, and all available options with their environment variable equivalents.

```text
NAME:
   ntfy serve - Run the ntfy server

USAGE:
   ntfy serve [OPTIONS..]

CATEGORY:
   Server commands

DESCRIPTION:
   Run the ntfy server and listen for incoming requests

   The command will load the configuration from /etc/ntfy/server.yml. Config options can 
   be overridden using the command line options.

   Examples:
     ntfy serve                      # Starts server in the foreground (on port 80)
     ntfy serve --listen-http :8080  # Starts server with alternate port

OPTIONS:
   --debug, -d                                                                                                            enable debug logging (default: false) [$NTFY_DEBUG]
   --trace                                                                                                                enable tracing (very verbose, be careful) (default: false) [$NTFY_TRACE]
   --no-log-dates, --no_log_dates                                                                                         disable the date/time prefix (default: false) [$NTFY_NO_LOG_DATES]
   --log-level value, --log_level value                                                                                   set log level (default: "INFO") [$NTFY_LOG_LEVEL]
   --log-level-overrides value, --log_level_overrides value [ --log-level-overrides value, --log_level_overrides value ]  set log level overrides [$NTFY_LOG_LEVEL_OVERRIDES]
   --log-format value, --log_format value                                                                                 set log format (default: "text") [$NTFY_LOG_FORMAT]
   --log-file value, --log_file value                                                                                     set log file, default is STDOUT [$NTFY_LOG_FILE]
   --config value, -c value                                                                                               config file (default: "/etc/ntfy/server.yml") [$NTFY_CONFIG_FILE]
   --base-url value, --base_url value, -B value                                                                           externally visible base URL for this host (e.g. https://ntfy.sh) [$NTFY_BASE_URL]
   --listen-http value, --listen_http value, -l value                                                                     ip:port used as HTTP listen address (default: ":80") [$NTFY_LISTEN_HTTP]
   --listen-https value, --listen_https value, -L value                                                                   ip:port used as HTTPS listen address [$NTFY_LISTEN_HTTPS]
   --listen-unix value, --listen_unix value, -U value                                                                     listen on unix socket path [$NTFY_LISTEN_UNIX]
   --listen-unix-mode value, --listen_unix_mode value                                                                     file permissions of unix socket, e.g. 0700 (default: system default) [$NTFY_LISTEN_UNIX_MODE]
   --key-file value, --key_file value, -K value                                                                           private key file, if listen-https is set [$NTFY_KEY_FILE]
   --cert-file value, --cert_file value, -E value                                                                         certificate file, if listen-https is set [$NTFY_CERT_FILE]
   --firebase-key-file value, --firebase_key_file value, -F value                                                         Firebase credentials file; if set additionally publish to FCM topic [$NTFY_FIREBASE_KEY_FILE]
   --cache-file value, --cache_file value, -C value                                                                       cache file used for message caching [$NTFY_CACHE_FILE]
   --cache-duration since, --cache_duration since, -b since                                                               buffer messages for this time to allow since requests (default: "12h") [$NTFY_CACHE_DURATION]
   --cache-batch-size value, --cache_batch_size value                                                                     max size of messages to batch together when writing to message cache (if zero, writes are synchronous) (default: 0) [$NTFY_BATCH_SIZE]
   --cache-batch-timeout value, --cache_batch_timeout value                                                               timeout for batched async writes to the message cache (if zero, writes are synchronous) (default: "0s") [$NTFY_CACHE_BATCH_TIMEOUT]
   --cache-startup-queries value, --cache_startup_queries value                                                           queries run when the cache database is initialized [$NTFY_CACHE_STARTUP_QUERIES]
   --auth-file value, --auth_file value, -H value                                                                         auth database file used for access control [$NTFY_AUTH_FILE]
   --auth-startup-queries value, --auth_startup_queries value                                                             queries run when the auth database is initialized [$NTFY_AUTH_STARTUP_QUERIES]
```

--------------------------------

### Publish with auth using Go

Source: https://docs.ntfy.sh/config

Go example that creates an HTTP request with Basic Auth and sends it.

```go
req, _ := http.NewRequest("POST", "https://ntfy.example.com/mysecrets",
    strings.NewReader("Look ma, with auth"))
req.Header.Set("Authorization", "Basic cGhpbDpteXBhc3M=")
http.DefaultClient.Do(req)

```

--------------------------------

### Delete notification via JavaScript fetch (DELETE and GET)

Source: https://docs.ntfy.sh/publish

JavaScript examples using fetch to delete a notification via DELETE or GET methods.

```javascript
// Via DELETE method
await fetch('https://ntfy.sh/mytopic/my-download-123', {
  method: 'DELETE'
});

// Via GET method
await fetch('https://ntfy.sh/mytopic/my-download-123/delete');
```

--------------------------------

### Clear notification via JavaScript fetch (PUT and GET)

Source: https://docs.ntfy.sh/publish

JavaScript examples using fetch to clear a notification via PUT or GET methods.

```javascript
// Via PUT method
await fetch('https://ntfy.sh/mytopic/my-download-123/clear', {
  method: 'PUT'
});

// Via GET method
await fetch('https://ntfy.sh/mytopic/my-download-123/clear');
```

--------------------------------

### Clear notification via HTTP (PUT and GET)

Source: https://docs.ntfy.sh/publish

HTTP request examples to clear a notification using PUT or GET methods to the /clear endpoint.

```http
PUT /mytopic/my-download-123/clear HTTP/1.1
Host: ntfy.sh

# Or using GET
GET /mytopic/my-download-123/clear HTTP/1.1
Host: ntfy.sh
```

--------------------------------

### Windows client.yml example for ntfy subscribe --from-config

Source: https://docs.ntfy.sh/subscribe/cli

Example client.yml for Windows that subscribes to three topics and runs different commands for each. Uses notifu for alerts and calc for the calculator.

```yaml
default-host: https://ntfy.sh
default-user: phill
default-password: mypass

subscribe:
- topic: echo-this
  command: 'echo Message received: %message%'
- topic: alerts
  command: |
    notifu /m "%NTFY_MESSAGE%"
    exit 0
  if:
    priority: high,urgent
- topic: calc
  command: calc

```

--------------------------------

### Run server with web push enabled

Source: https://docs.ntfy.sh/develop

Starts the ntfy server with web push enabled. Requires web push keys obtained via `go run main.go webpush keys`. Set `--base-url` to `http://localhost` because web push only works when the server matches the base URL. The `--web-push-file` stores the web push state.

```bash
go run main.go \
  --log-level debug \
  serve \
    --base-url http://localhost \
    --web-push-public-key KEY \
    --web-push-private-key KEY \
    --web-push-email-address <email> \
    --web-push-file=/tmp/webpush.db

```

--------------------------------

### untilStep function

Source: https://docs.ntfy.sh/publish/template-functions

Generates a list of counting integers with a custom start, stop, and step. The example produces [3 5] by starting at 3 and adding 2 until equal or greater than 6.

```text
untilStep 3 6 2
```

--------------------------------

### Delete notification via curl (DELETE and GET)

Source: https://docs.ntfy.sh/publish

Command line examples to delete a notification using the DELETE method to /<topic>/<sequence_id> or the GET method to /<topic>/<sequence_id>/delete.

```bash
# Via DELETE method
curl -X DELETE ntfy.sh/mytopic/my-download-123

# Via GET method
curl ntfy.sh/mytopic/my-download-123/delete
```

--------------------------------

### Run web app development server

Source: https://docs.ntfy.sh/develop

Starts the web app development server, opening your browser at `http://127.0.0.1:3000`. Source files are recompiled and the browser refreshes automatically as you edit.

```bash
$ cd web
$ npm start

```

--------------------------------

### Reload systemd and start ntfy service

Source: https://docs.ntfy.sh/install

After installing the unit file, reloads systemd to recognize the new service and starts the ntfy service. This is required to launch the ntfy server as a systemd service.

```bash
sudo systemctl daemon-reload
sudo systemctl start ntfy
```

--------------------------------

### Build all targets with make build

Source: https://docs.ntfy.sh/develop

Builds the web app, documentation, and the ntfy binary for all supported architectures (amd64, armv7, arm64). Expect a slow build, especially on the first run.

```bash
$ make build
...
# This builds web app, docs, and the ntfy binary (for amd64, armv7 and arm64). 
# This will be SLOW (5+ minutes on my laptop on the first run). Maybe look at the other make targets?

```

--------------------------------

### Clear notification via curl (PUT and GET)

Source: https://docs.ntfy.sh/publish

Command line examples to clear a notification using the PUT method to /<topic>/<sequence_id>/clear or the GET method to /<topic>/<sequence_id>/clear.

```bash
# Via PUT method
curl -X PUT ntfy.sh/mytopic/my-download-123/clear

# Via GET method
curl ntfy.sh/mytopic/my-download-123/clear
```

--------------------------------

### substr

Source: https://docs.ntfy.sh/publish/template-functions

Gets a substring from a string. Takes three parameters: start (int), end (int), string (string).

```APIDOC
## substr

### Description
Gets a substring from a string. Takes three parameters: start (int), end (int), string (string).

### Usage
`substr 0 5 "hello world"`

### Example
`substr 0 5 "hello world"` returns `hello`.
```

--------------------------------

### any function

Source: https://docs.ntfy.sh/publish/template-functions

Returns true if any value is non-empty. The first example returns true. The second checks if the request method is GET, POST, or OPTIONS.

```Go template
any 0 1 2
```

```Go template
any (eq .Request.Method "GET") (eq .Request.Method "POST") (eq .Request.Method "OPTIONS")
```

--------------------------------

### seq function examples

Source: https://docs.ntfy.sh/publish/template-functions

Works like the bash seq command. Supports 1, 2, or 3 parameters to generate counting integers with optional start and step.

```text
seq 5       => 1 2 3 4 5
seq -3      => 1 0 -1 -2 -3
seq 0 2     => 0 1 2
seq 2 -2    => 2 1 0 -1 -2
seq 0 2 10  => 0 2 4 6 8 10
seq 0 -2 -5 => 0 -2 -4
```

--------------------------------

### Action buttons example - Command line (curl)

Source: https://docs.ntfy.sh/publish

Example using curl to publish a notification with view and http actions via the Actions header.

```bash
body='{"temperature": 65}'
curl \
    -d "You left the house. Turn down the A/C?" \
    -H "Actions: view, Open portal, https://home.nest.com/, clear=true; \
                 http, Turn down, https://api.nest.com/, body='$body'" \
    ntfy.sh/myhome

```

--------------------------------

### Send email via nc and sample response

Source: https://docs.ntfy.sh/config

Command to send the email using netcat, followed by an example SMTP server response. Lines starting with 451 indicate errors.

```bash
$ cat email.txt | nc -N ntfy.sh 25
220 ntfy.sh ESMTP Service Ready
250-Hello example.com
...
250 2.0.0 Roger, accepting mail from <phil@example.com>
250 2.0.0 I'll make sure <ntfy-mytopic@ntfy.sh> gets this

```

--------------------------------

### Install ntfy via Debian/Ubuntu repository (arm64)

Source: https://docs.ntfy.sh/install

Adds the official ntfy apt repository for arm64 architecture, installs ntfy, and enables/starts the systemd service. Requires sudo privileges.

```bash
sudo mkdir -p /etc/apt/keyrings
sudo curl -L -o /etc/apt/keyrings/ntfy.gpg https://archive.ntfy.sh/apt/keyring.gpg
sudo apt install apt-transport-https
echo "deb [arch=arm64 signed-by=/etc/apt/keyrings/ntfy.gpg] https://archive.ntfy.sh/apt stable main" \
    | sudo tee /etc/apt/sources.list.d/ntfy.list
sudo apt update
sudo apt install ntfy
sudo systemctl enable ntfy
sudo systemctl start ntfy

```

--------------------------------

### Declarative users in /etc/ntfy/server.yml

Source: https://docs.ntfy.sh/config

Example of provisioning users declaratively in the server.yml config file using the auth-users option. Users are automatically created/updated on server start; removing them from config deletes them from the database on restart.

```yaml
auth-file: "/var/lib/ntfy/user.db"
auth-users:
  - "phil:$2a$10$YLiO8U21sX1uhZamTLJXHuxgVC0Z/GKISibrKCLohPgtG7yIxSk4C:admin"
  - "ben:$2a$10$NKbrNb7HPMjtQXWJ0f1pouw03LDLT/WzlO9VAv44x84bRCkh19h6m:user"
```

--------------------------------

### Run server from source with go run

Source: https://docs.ntfy.sh/develop

Runs the ntfy server directly from source with `go run main.go serve`. Requires `CGO_ENABLED=1` and running `make cli-deps-static-sites` at least once to generate dummy files for embedded docs and web app.

```bash
$ export CGO_ENABLED=1
$ make cli-deps-static-sites
$ go run main.go serve
2022/03/18 08:43:55 Listening on :2586[http]
...

```

--------------------------------

### Get all values with values

Source: https://docs.ntfy.sh/publish/template-functions

Returns a list of all values from a single dictionary. Order is not guaranteed; use `sortAlpha` if ordering matters. The example returns `list["value1", "value2", "value 3"]`.

```plaintext
$vals := values $myDict
```

--------------------------------

### PostgreSQL database-url configuration examples

Source: https://docs.ntfy.sh/config

Four YAML configuration examples for the ntfy server's PostgreSQL database settings. The first is a simple connection string. The second adds SSL mode and connection pool tuning. The third uses a custom port and a CA certificate. The fourth configures read replicas with a primary and two replicas, each with SSL and pool settings.

```yaml
database-url: "postgres://user:pass@host:5432/ntfy"

```

```yaml
database-url: "postgres://user:pass@host:5432/ntfy?sslmode=require&pool_max_conns=50&pool_conn_max_idle_time=5m"

```

```yaml
database-url: "postgres://user:pass@host:25060/ntfy?sslmode=require&sslrootcert=/etc/ntfy/db-ca-cert.pem&pool_max_conns=30"

```

```yaml
database-url: "postgres://user:pass@primary:5432/ntfy?sslmode=require&sslrootcert=/etc/ntfy/db-ca-cert.pem&pool_max_conns=30"
database-replica-urls:
  - "postgres://user:pass@replica1:5432/ntfy?sslmode=require&sslrootcert=/etc/ntfy/db-ca-cert.pem&pool_max_conns=30"
  - "postgres://user:pass@replica2:5432/ntfy?sslmode=require&sslrootcert=/etc/ntfy/db-ca-cert.pem&pool_max_conns=30"

```

--------------------------------

### macOS client.yml example for ntfy subscribe --from-config

Source: https://docs.ntfy.sh/subscribe/cli

Example client.yml for macOS that subscribes to three topics and runs different commands for each. Uses osascript for alerts and opens Calculator for calc.

```yaml
default-host: https://ntfy.sh
default-user: phill
default-password: mypass

subscribe:
  - topic: echo-this
    command: 'echo "Message received: $message"'
  - topic: alerts
    command: osascript -e "display notification \"$message\""
    if:
      priority: high,urgent
  - topic: calc
    command: open -a Calculator

```

--------------------------------

### Linux client.yml example for ntfy subscribe --from-config

Source: https://docs.ntfy.sh/subscribe/cli

Example client.yml for Linux that subscribes to three topics and runs different commands for each. Uses notify-send for alerts and an inline script for print-temp. The default-host, default-user, and default-password are sent for each topic that does not have its own credentials, so ensure HTTPS is used.

```yaml
default-host: https://ntfy.sh
default-user: phill
default-password: mypass

subscribe:
- topic: echo-this
  command: 'echo "Message received: $message"'
- topic: alerts
  command: notify-send -i /usr/share/ntfy/logo.png "Important" "$m"
  if:
    priority: high,urgent
- topic: calc
  command: 'gnome-calculator 2>/dev/null &'
- topic: print-temp
  command: |
        echo "You can easily run inline scripts, too."
        temp="$(sensors | awk '/Pack/ { print substr($4,2,2) }')"
        if [ $temp -gt 80 ]; then
          echo "Warning: CPU temperature is $temp. Too high."
        else
          echo "CPU temperature is $temp. That's alright."
        fi

```

--------------------------------

### Install ntfy via Debian/Ubuntu repository (amd64)

Source: https://docs.ntfy.sh/install

Adds the official ntfy apt repository for amd64 architecture, installs ntfy, and enables/starts the systemd service. Requires sudo privileges.

```bash
sudo mkdir -p /etc/apt/keyrings
sudo curl -L -o /etc/apt/keyrings/ntfy.gpg https://archive.ntfy.sh/apt/keyring.gpg
sudo apt install apt-transport-https
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/ntfy.gpg] https://archive.ntfy.sh/apt stable main" \
    | sudo tee /etc/apt/sources.list.d/ntfy.list
sudo apt update
sudo apt install ntfy
sudo systemctl enable ntfy
sudo systemctl start ntfy

```

--------------------------------

### Build web app with make web

Source: https://docs.ntfy.sh/develop

Builds the web app using Create React App and copies the production build to the `server/site` folder, so that subsequent `make cli` builds include the web app in the ntfy binary.

```bash
$ make web
...

```

--------------------------------

### Scheduled Delivery Examples

Source: https://docs.ntfy.sh/publish

Examples of publishing messages with scheduled delivery using different delay headers.

```APIDOC
## [POST] /hello

### Description
Publish a message to a topic with a scheduled delivery time using the `At` header.

### Method
POST

### Endpoint
/hello

### Parameters
#### Headers
- **At** (string) - Required - Delivery time as a Unix timestamp, duration, or natural language time string.

#### Request Body
- **message** (string) - Required - The message content to be delivered.

### Request Example
```
curl -H "At: tomorrow, 10am" -d "Good morning" ntfy.sh/hello
```

### Response
#### Success Response (200)
- **id** (string) - Message identifier
- **time** (number) - Delivery timestamp
- **event** (string) - Event type
- **topic** (string) - Topic name
- **message** (string) - Message content

#### Response Example
```
{
  "id": "...",
  "time": 1639194738,
  "event": "message",
  "topic": "hello",
  "message": "Good morning"
}
```
```

```APIDOC
## [POST] /reminder

### Description
Publish a message with a relative delay using the `In` header.

### Method
POST

### Endpoint
/reminder

### Parameters
#### Headers
- **In** (string) - Required - Delay duration (e.g., `30m`, `3h`, `2 days`).

#### Request Body
- **message** (string) - Required - The message content.

### Request Example
```
curl -H "In: 30min" -d "It's 30 minutes later now" ntfy.sh/reminder
```

### Response
#### Success Response (200)
- **id** (string) - Message identifier
- **time** (number) - Delivery timestamp
- **event** (string) - Event type
- **topic** (string) - Topic name
- **message** (string) - Message content

#### Response Example
```
{
  "id": "...",
  "time": 1639194738,
  "event": "message",
  "topic": "reminder",
  "message": "It's 30 minutes later now"
}
```
```

```APIDOC
## [POST] /itsaunixsystem

### Description
Publish a message with a Unix timestamp delay using the `Delay` header.

### Method
POST

### Endpoint
/itsaunixsystem

### Parameters
#### Headers
- **Delay** (string) - Required - Unix timestamp (e.g., `1639194738`).

#### Request Body
- **message** (string) - Required - The message content.

### Request Example
```
curl -H "Delay: 1639194738" -d "Unix timestamps are awesome" ntfy.sh/itsaunixsystem
```

### Response
#### Success Response (200)
- **id** (string) - Message identifier
- **time** (number) - Delivery timestamp
- **event** (string) - Event type
- **topic** (string) - Topic name
- **message** (string) - Message content

#### Response Example
```
{
  "id": "...",
  "time": 1639194738,
  "event": "message",
  "topic": "itsaunixsystem",
  "message": "Unix timestamps are awesome"
}
```
```

--------------------------------

### Creating an access token with ntfy token add

Source: https://docs.ntfy.sh/config

Shows how to create an access token for user phil with a 30-day expiration and label 'backups', then lists tokens to verify. The output shows the generated token and its metadata.

```bash
$ ntfy token add --expires=30d --label="backups" phil
$ ntfy token list
user phil
- tk_7eevizlsiwf9yi4uxsrs83r4352o0 (backups), expires 15 Mar 23 14:33 EDT, accessed from 0.0.0.0 at 13 Feb 23 13:33 EST
```
Tokens:
Raw