lsiodev/apprise-api

linuxserver/apprise-api

https://github.com/caronc/apprise-api 通过网络利用 https://github.com/caronc/apprise 提供用户友好的API接口。

• 支持向65+种服务发送通知
• 极其轻量级的Apprise网关
• 生产就绪的微服务

Apprise API 设计旨在轻松融入需要简单通知解决方案的现有（和新）生态系统。

!https://raw.githubusercontent.com/caronc/apprise-api/master/apprise_api/static/logo.png

支持的架构

我们利用docker manifest实现多平台支持。只需拉取 lscr.io/linuxserver/apprise-api:latest 即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构：

使用方法

您可以使用docker-compose或docker cli创建容器。

docker-compose（推荐，点击查看更多信息）

yaml
---
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（点击查看更多信息）

bash
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

参数

容器通过运行时传递的参数进行配置（如上所示）。这些参数用冒号分隔，表示 <外部>:<内部>。例如，-p 8080:80 会将容器内的端口 80 暴露到主机IP的 8080 端口。

来自文件的环境变量（Docker secrets）

您可以使用特殊前缀 FILE__ 从文件设置任何环境变量。

例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

这会根据 /run/secrets/mysecretvariable 文件的内容设置环境变量 MYVAR。

应用运行的Umask

对于所有镜像，我们提供通过可选的 -e UMASK=022 设置来覆盖容器内服务的默认umask设置。请注意，umask不是chmod，它基于其值减去权限而不是添加。请在请求支持前了解更多。

用户/组标识符

使用卷（-v 标志）时，主机OS和容器之间可能会出现权限问题，我们通过允许您指定用户 PUID 和组 PGID 来避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，任何权限问题都会迎刃而解。

在此示例中 PUID=1000 和 PGID=1000，要查找您的ID，请使用 id your_user：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=apprise-api&query=%24.mods%5B%27apprise-api%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看此容器的可用mods") https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看可用的通用mods")

我们发布各种 https://github.com/linuxserver/docker-mods 以启用容器内的附加功能。上述动态徽章可访问此镜像可用的Mods列表（如有）以及可应用于我们任何镜像的通用Mods。

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it apprise-api /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f apprise-api
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' apprise-api
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/apprise-api:latest
  

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部应用。除某些例外（如nextcloud、plex），我们不建议或支持在容器内更新应用。请参考上述应用设置部分，了解是否推荐对此镜像进行应用更新。

以下是更新容器的说明：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull apprise-api
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d apprise-api
    

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/apprise-api:latest
  

• 停止运行中的容器：

  bash
  docker stop apprise-api
  

• 删除容器：

  bash
  docker rm apprise-api
  

• 使用上述相同的docker run参数重新创建新容器（如果正确映射到主机文件夹，您的 /config 文件夹和设置将被保留）

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

通过Watchtower自动更新器（仅在忘记原始参数时使用）

• 拉取最新标签镜像并使用相同的环境变量替换：

  bash
  docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once apprise-api
  

• 您还可以删除旧的悬空镜像：docker image prune

警告：我们不认可使用Watchtower作为现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但是，对于您忘记原始参数的容器，这是一个有用的一次性手动更新工具。从长远来看，我们强烈建议使用 Docker Compose。

镜像更新通知 - Diun（Docker Image Update Notifier）

提示：我们推荐 Diun 用于更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

bash
git clone https://github.com/linuxserver/docker-apprise-api.git
cd docker-apprise-api
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/apprise-api:latest .

可以使用 multiarch/qemu-user-static 在x86_64硬件上构建ARM变体：

bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset

注册后，您可以使用 -f Dockerfile.aarch64 指定要使用的dockerfile。

版本历史

• 10.07.23: - 基于Alpine 3.18重建。
• 01.07.23: - 弃用armhf。如此处所宣布。
• 11.02.23: - 基于Alpine 3.17重建。
• 17.10.22: - 基于Alpine 3.16重建，迁移到S6V3。
• 28.02.21: - 基于Alpine 3.15重建。
• 03.11.21: - 将uWSGI缓冲区大小增加到32kb。
• 16.05.21: - 添加linuxserver wheel索引。
• 26.02.21: - 初始发布。