Skip to content

ntfy ntfy

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
ntfy Host Port
ntfy /config Path

Build Status Last Commit OCI Pulls

Simple HTTP-based pub-sub notification service: send notifications to your phone or desktop from any script with a PUT or POST.
Port 8080
Registry ghcr.io/daemonless/ntfy
Daemonless daemonless/ntfy
Source binwiederhier/ntfy
Website ntfy.sh

Version Tags

Multi-arch manifests — resolve automatically to the right image for your platform.

Tag Description Best For
pkg FreeBSD Quarterly. Uses stable, tested packages. Most users — recommended.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
pkg-amd64 FreeBSD Quarterly. Uses stable, tested packages. Most users — recommended.
pkg-latest-amd64 FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
pkg-aarch64 FreeBSD Quarterly. Uses stable, tested packages. Most users — recommended.
pkg-latest-aarch64 FreeBSD Latest. Rolling package updates. Staying current.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
services:
  ntfy:
    image: "ghcr.io/daemonless/ntfy:pkg"
    container_name: ntfy
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      # - NTFY_BASE_URL=  # Public URL clients reach the server at; turns on attachments under /config/cache/attachments (or set base-url and attachment-cache-dir in server.yml)
    volumes:
      - "/containers/ntfy:/config"
    ports:
      - "8080:8080"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
# .env

DIRECTOR_PROJECT=ntfy
PUID=1000
PGID=1000
TZ=UTC

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  ntfy:
    name: ntfy
    options:
      - container: 'args:--pull'
      - expose: '8080:8080 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - NTFY_CONFIG_PATH: /config
volumes:
  NTFY_CONFIG_PATH:
    device: '/containers/ntfy'

1
2
3
4
5
6
7
# Makejail

ARG tag=pkg

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/ntfy:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
services:
  ntfy:
    name: ntfy
    image: "ghcr.io/daemonless/ntfy:pkg"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/ntfy:/config"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:8080 from another machine (the server's own browser can't use a published port).

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
NTFY_BASE_URL `` Public URL clients reach the server at; turns on attachments under /config/cache/attachments (or set base-url and attachment-cache-dir in server.yml)

Volumes

Path Description
/config server.yml, user.db, message cache and attachments

Ports

Port Protocol Description
8080 TCP Web UI and API

Implementation Details

  • Architectures: amd64, aarch64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.