linuxserver/apprise-api

LinuxServer.io docker-apprise-api 容器介绍

LinuxServer.io 团队容器特点

LinuxServer.io 团队推出的这款容器具有以下特点：

• 定期及时的应用更新
• 便捷的用户映射（PGID、PUID）
• 基于 s6 overlay 的自定义基础镜像
• 每周基础系统更新，全生态共享通用层，减少存储空间占用、 downtime 和带宽消耗
• 定期安全更新

Apprise-api 简介

Apprise-api 基于 Apprise 开发，通过网络提供易用的 API 接口，主要功能包括：

• 支持向 100 多种服务发送通知
• 轻量级 Apprise 网关，资源占用低
• 可直接用于生产环境的微服务
• 提供简单网页界面，方便验证和测试配置

Apprise API 设计简洁，可轻松集成到现有或新建的系统中，作为轻量通知解决方案使用。

支持的架构

本镜像通过 Docker 清单实现多平台支持，直接拉取 lscr.io/linuxserver/apprise-api:latest 即可自动匹配对应架构。也可通过标签指定特定架构，支持的架构如下：

使用方法

以下提供 docker-compose 和 docker cli 两种部署方式，帮助快速启动容器。

注意：除标记为“可选”的参数外，其余均为必填项，需提供具体值。

docker-compose（推荐）

创建 docker-compose.yml 文件，内容如下：

yaml
---
services:
  apprise-api:
    image: lscr.io/linuxserver/apprise-api:latest
    container_name: apprise-api
    environment:
      - PUID=1000          # 用户ID，详见下方说明
      - PGID=1000          # 组ID，详见下方说明
      - TZ=Etc/UTC         # 时区，参考时区列表（      - APPRISE_ATTACH_SIZE=0 # 可选，最大附件大小（MB），0表示禁用附件；需挂载/attachments卷才能设为正数
    volumes:
      - /path/to/apprise-api/config:/config        # 持久化配置文件目录
      - /path/to/apprise-api/attachments:/attachments # 可选，附件临时存储目录
    ports:
      - 8000:8000          # Apprise界面和API端口
    restart: unless-stopped

启动容器：

bash
docker-compose up -d

docker cli

直接执行以下命令启动容器：

bash
docker run -d \
  --name=apprise-api \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APPRISE_ATTACH_SIZE=0 `#可选，最大附件大小（MB）` \
  -p 8000:8000 \
  -v /path/to/apprise-api/config:/config \
  -v /path/to/apprise-api/attachments:/attachments `#可选，附件存储目录` \
  --restart unless-stopped \
  lscr.io/linuxserver/apprise-api:latest

参数说明

容器运行时通过参数配置，格式为 <外部>:<内部>。以下是主要参数说明：

环境变量（Docker secrets）

可通过文件设置环境变量，格式为 -e FILE__<变量名>=<文件路径>。例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

容器会读取 /run/secrets/mysecretvariable 文件内容，将其设为 MYVAR 环境变量的值。

Umask 设置

可通过 -e UMASK=022 覆盖容器内服务的默认 umask 权限（umask 是权限掩码，非直接设置权限，详见 说明）。

用户/组 ID（PUID/PGID）

使用卷（-v 参数）时，主机与容器可能存在权限冲突。通过设置 PUID（用户 ID）和 PGID（组 ID），确保卷目录的宿主用户与容器内用户一致，可避免权限问题。

获取当前用户的 PUID/PGID：

bash
id your_user

示例输出：

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

其中 uid=1000 即 PUID，gid=1000 即 PGID。

Docker Mods

可通过 Docker Mods 扩展容器功能。以下是相关资源：

• Apprise-api 专用 Mods
• 通用 Mods（适用于所有 LinuxServer 容器）

支持信息

容器内命令行访问

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

更新方法

通过 docker-compose 更新

1. 拉取最新镜像：

   bash
   # 更新所有镜像
   docker-compose pull
   # 仅更新当前容器镜像
   docker-compose pull apprise-api
   

2. 重启容器：

   bash
   # 重启所有容器
   docker-compose up -d
   # 仅重启当前容器
   docker-compose up -d apprise-api
   

3. 清理旧镜像：

   bash
   docker image prune
   

通过 docker run 更新

1. 拉取最新镜像：

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

2. 停止并删除旧容器：

   bash
   docker stop apprise-api && docker rm apprise-api
   

3. 用原参数重新创建容器（卷挂载正确的情况下，配置会保留）：

   bash
   # 复制前文 docker run 命令执行
   

4. 清理旧镜像：

   bash
   docker image prune
   

提示：推荐使用 Diun 接收镜像更新通知，不建议使用自动更新容器的工具。

本地构建

如需自定义镜像，可按以下步骤本地构建：

1. 克隆仓库：

   bash
   git clone []   cd docker-apprise-api
   

2. 构建镜像（默认 x86-64 架构）：

   bash
   docker build --no-cache --pull -t lscr.io/linuxserver/apprise-api:latest .
   

3. 构建 ARM 架构镜像（需先注册 qemu-static）：

   bash
   docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
   # 构建 arm64 镜像
   docker build -f Dockerfile.aarch64 --no-cache --pull -t lscr.io/linuxserver/apprise-api:latest .
   

版本历史

• 2025.07.05：基底镜像更新为 Alpine 3.22
• 2024.12.24：基底镜像更新为 Alpine 3.21
• 2024.06.24：基底镜像更新为 Alpine 3.20
• 2023.12.23：基底镜像更新为 Alpine 3.19
• 2023.07.10：基底镜像更新为 Alpine 3.18
• 2023.07.01：移除 armhf 架构支持
• 2023.02.11：基底镜像更新为 Alpine 3.17
• 2022.10.17：基底镜像更新为 Alpine 3.16，迁移至 S6V3
• 2021.02.28：基底镜像更新为 Alpine 3.15
• 2021.11.03：将 uWSGI 缓冲区大小增至 32kb
• 2021.05.16：添加 linuxserver wheel 索引
• 2021.02.26：初始发布

相关链接

• LinuxServer.io 官网
• 博客：容器使用指南与教程
• ：实时支持与社区聊天
• 论坛：社区讨论
• GitHub：源码仓库
• ***：Open Collective