Self-host Apprise API on a VPS

A single HTTP endpoint that fans a notification out to 100+ services such as Slack, Discord, and email.

levelrail-cli templates deploy apprise-api --name my-apprise-api

Specification

Status
Verified on arm64 with image tag 1.5.4
Category
Communication
Services
apprise-api
Ports
8000
Volumes
2
Memory
about 128 MiB
arm64
tested
amd64
image published
Settings to fill in
none

About Apprise API

A single HTTP endpoint that fans a notification out to 100+ services such as Slack, Discord, and email. Runs as a single container from the apprise image, listening on port 8000; data is kept in named volumes.

What it deploys

Apprise API runs as one service in a single Compose app, listening on port 8000, with 2 named volume mounts.

ServiceImageTagPortsVolumes
apprise-api caronc/apprise 1.5.4 8000 apprise_config -> /configapprise_attach -> /attachments

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Verified. Verified on arm64 with image tag 1.5.4. Verified means our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 8000 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

The catalog lists no environment variables for this template.

Install Apprise API on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get apprise-api
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy apprise-api --name my-apprise-api

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Apprise API.

More in Communication

All Communication templates