Portainer Templates logo

Portainer Templates

Apprise-API (stack) Apprise-API (stack)

API

Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.70+ services

Configuration

Type
Compose
Platform
linux
Image
lscr.io/linuxserver/apprise-api
Volumes
/config : $DATA_LOCATION/$SERVICE/config
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

docker run -d --name apprise-api \
  -v $DATA_LOCATION/$SERVICE/config:/config \
  --restart=unless-stopped \
  lscr.io/linuxserver/apprise-api

If the stack expects env vars, set them or add them to a .env file first.

#& type: 3
#& title: Apprise API
#& description: Send notifications to more then 70+ services.
#& note: Website: <a href='https://github.com/caronc/apprise-api' target='_blank' rel='noopener'>Github.com</a>
#& categories: SelfHosted
#& platform: linux
#& logo: https://warehouse-camo.ingress.cmh1.psfhosted.org/a22d9206f80dfbb10748b6764fee932ff0ae1a8f/687474703a2f2f7265706f2e6e75787265662e636f6d2f7075622f696d672f6c6f676f2d617070726973652e706e67

#% SERVICE: Name of the service (No spaces or points) [apprise-api]
#% DATA_LOCATION: Data location (Example: /apps/service) [/portainer/Files/AppData/Config/apprise]
#% URL: Service URL (Example: service.com)
#% NETWORK: Your Traefik network (Example: proxy) [proxy]

# Work with Portainer
services:
  apprise-api:
    image: lscr.io/linuxserver/apprise-api
    container_name: $SERVICE
    volumes:
      - $DATA_LOCATION/$SERVICE/config:/config
    healthcheck:
      test: ["CMD", "bash", "-c", "exec 5<>/dev/tcp/127.0.0.1/8036 && echo -e 'GET /healthz HTTP/1.1\n\n' >&5 && cat <&5 | head -n 1 | grep 200"]
      interval: 1m
      timeout: 30s
      retries: 3
    restart: unless-stopped
    networks:
      - default
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.$SERVICE.entrypoints=https"
      - "traefik.http.routers.$SERVICE.rule=Host(`$URL`)"
      - "traefik.http.routers.$SERVICE.tls=true"
      - "traefik.http.routers.$SERVICE.tls.certresolver=http"
      - "traefik.http.services.$SERVICE.loadbalancer.server.port=8036"
      - "traefik.docker.network=$NETWORK"
networks:
  default:
    external:
      name: $NETWORK

Or, use the original compose file, straight from the template repo. Deploy with:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/apprise.yml up -d

Save this file as apprise-api-stack-stack.yml, then from a manager node, run docker stack deploy -c apprise-api-stack-stack.yml apprise-api-stack

version: '3.8'
services:
  apprise-api-stack:
    image: lscr.io/linuxserver/apprise-api
    volumes:
      - $DATA_LOCATION/$SERVICE/config:/config
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

apprise-api-stack-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: apprise-api-stack
  labels:
    app: apprise-api-stack
spec:
  replicas: 1
  selector:
    matchLabels:
      app: apprise-api-stack
  template:
    metadata:
      labels:
        app: apprise-api-stack
    spec:
      containers:
        - name: apprise-api-stack
          image: lscr.io/linuxserver/apprise-api
          volumeMounts:
            - name: apprise-api-stack-data-0
              mountPath: /config
      volumes:
        - name: apprise-api-stack-data-0
          hostPath:
            path: $DATA_LOCATION/$SERVICE/config

Save this file as ~/.config/containers/systemd/apprise-api-stack.container

[Unit]
Description=Apprise-API (stack)

[Container]
Image=lscr.io/linuxserver/apprise-api
ContainerName=apprise-api-stack
Volume=$DATA_LOCATION/$SERVICE/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start apprise-api-stack

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull lscr.io/linuxserver/apprise-api

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.