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-apiSpecification
- 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
- License
- Permissive license, MIT
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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| 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
-
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 -
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 | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get apprise-api -
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.
Docs and upstream
More in Communication
- Apache AnswerA Q&A platform for building a community knowledge base, in the style of a self-hosted Stack Overflow.
- CampfireBasecamp's open-source group chat app: rooms, direct messages, and file sharing, self-hosted as one container.
- ChatwootAn open-source customer support platform for live chat, email, and social messaging.
- ejabberdRobust, scalable XMPP chat and messaging server from ProcessOne. Runs with the default configuration and stores its database on a volume.
- Element WebThe Element Matrix web client, served as static files and pointed at the homeserver you choose, for example the Matrix Synapse template. AGPL-3.0 licensed client. No account lives here, sign in or register on your homeserver.
- FreeScoutA free, self-hosted help desk and shared mailbox, a lighter alternative to Zendesk or Help Scout.