8.8 KiB

Executable File

Czysty Wina Historia

title
apprise-api

linuxserver/apprise-api

Apprise-api Takes advantage of Apprise through your network with a user-friendly API.

Send notifications to more then 65+ services.
An incredibly lightweight gateway to Apprise.
A production ready micro-service at your disposal.

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

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/apprise-api:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  apprise-api:
    image: lscr.io/linuxserver/apprise-api:latest
    container_name: apprise-api
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/config:/config
    ports:
      - 8000:8000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=apprise-api \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 8000:8000 \
  -v /path/to/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/apprise-api:latest

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (`-p`)

Parameter	Function
`8000`	Port for apprise's interface and API.

Environment Variables (`-e`)

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Etc/UTC`	specify a timezone to use, see this list.

Volume Mappings (`-v`)

Volume	Function
`/config`	Where config is stored.

Miscellaneous Options

Parameter	Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:
- docker exec -it apprise-api /bin/bash
To monitor the logs of the container in realtime:
- docker logs -f apprise-api
Container version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' apprise-api
Image version number
- docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/apprise-api:latest

Versions

10.07.23: - Rebase to Alpine 3.18.
01.07.23: - Deprecate armhf. As announced here
11.02.23: - Rebase to Alpine 3.17.
17.10.22: - Rebase to alpine 3.16, migrate to S6V3
28.02.21: - Rebase to alpine 3.15.
03.11.21: - Increase uWSGI buffer size to 32kb.
16.05.21: - Add linuxserver wheel index.
26.02.21: - Initial Release.

8.8 KiB Executable File Czysty Wina Historia