Self-host Apprise API with Levelrail

Verified

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

  • AuthorcaroncVerified by Levelrail
  • LicenceMIT
  • Memory128 MiB
  • Archarm64
  • Services1

How to self-host Apprise API

  1. Pull the images

    One image is pulled on your server.

    Show images
    • caronc/apprise:1.5.4
  2. Create the app

    One service starts in a single Compose app, with 2 named volume mounts for your data, on port 8000.

  3. Fill in the secrets

    You do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Apprise API requirements

Memory
About 128 MiB
Architectures
amd64 image published, arm64 tested
Ports
8000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Verified. Verified on arm64 with image tag 1.5.4. Our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 8000 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Apprise API. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Apprise API docs page.

Deploy Apprise API your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Apprise API from the CLI

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

Deploy Apprise API with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/apprise-api/deploy

Apprise API configuration

Apprise API services

ServiceImagePortsVolumes
apprise-api caronc/apprise:1.5.4 8000 apprise_config -> /configapprise_attach -> /attachments

Apprise API environment variables

The catalog lists no environment variables for this template.

Ports and volumes

Ports
8000
Volumes
2 named mounts: apprise_config -> /config, apprise_attach -> /attachments

Apprise API FAQ

How much memory does Apprise API need?

The catalog lists about 128 MiB of memory for Apprise API.

Does Apprise API run on arm64?

For Apprise API, arm64 is tested; amd64 is image published.

What licence is Apprise API under?

Apprise API is licensed under MIT, which is permissive, with few conditions on reuse.

Does Apprise API need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Apprise API use?

Apprise API listens on port 8000 inside the stack.

Where does Apprise API keep its data?

In named volumes: apprise_config mounted at /config and apprise_attach mounted at /attachments.

Can I deploy Apprise API on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id apprise-api for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image caronc/apprise:1.5.4 is what you deploy there.

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