danonline/autopulse

autopulse 镜像文档

镜像概述与主要用途

autopulse 是一款轻量级自动化 Web 服务，作为媒体管理器与媒体服务器之间的桥梁，接收来自 Sonarr、Radarr、Lidarr 等媒体管理器（称为"触发器"）的通知，自动更新 Plex、Jellyfin、Emby 等媒体服务器（称为"目标"）中的媒体内容。其核心优势在于仅更新已变更的项目，而非对整个文件夹执行通用扫描，显著降低媒体服务器负载，提升更新效率。

与 https://github.com/Cloudbox/autoscan 相比：autoscan 是优秀的先驱项目，但已停止维护，且采用文件夹级扫描导致效率较低。autopulse 则直接定位对应媒体库项目并发送更新请求，更为高效。

核心功能与特性

术语说明

• 触发器（Trigger）：接收文件就绪通知的端点，支持类型：
  • 手动触发（默认端点：/triggers/manual）
  • Sonarr、Radarr、Lidarr、Readarr
  • 文件系统监控（Notify）：Linux（inotify）、MacOS（FSEvents）、Windows（ReadDirectoryChangesW）、轮询（polling， fallback）
• 目标（Target）：接收更新请求的媒体库，支持类型：
  • Plex、Jellyfin、Emby
  • 命令行（Command）
  • Sonarr、Radarr、Tdarr、FileFlows
  • 其他 autopulse 实例

主要功能

• 路径重写：将触发器提供的文件路径转换为目标媒体服务器可识别的路径
• 多平台集成：支持主流媒体管理器（Sonarr/Radarr等）和媒体服务器（Plex/Jellyfin等）
• 文件检查：验证文件存在性，可选等待文件哈希匹配后再更新
• 状态可靠性：通过数据库（SQLite/Postgres）存储扫描请求状态
• 通知机制：支持 *** 等 Webhook 发送处理状态通知
• Web 界面：提供简易 UI 查看和添加扫描请求

使用场景与适用范围

适用于需要自动化同步媒体内容的个人或家庭媒体中心环境：

• 已部署 Sonarr/Radarr/Lidarr 等媒体管理工具，用于自动下载和整理影视/音乐
• 使用 Plex/Jellyfin/Emby 等媒体服务器，需要及时更新新添加或变更的媒体内容
• 希望减少媒体服务器扫描负载，避免全文件夹扫描导致的性能问题

使用方法与配置说明

Docker 部署

镜像标签

• latest：完整镜像，支持 Postgres/SQLite
• latest-postgres：仅支持 Postgres 的轻量镜像
• latest-sqlite：仅支持 SQLite 的轻量镜像
• stable：最新版本化发布镜像
• ui：自托管 UI 镜像（需配合 autopulse 后端）

基础部署命令

使用 Postgres 数据库

bash
# 创建网络
docker network create autopulse

# 启动 Postgres
docker run -d --net autopulse --name postgres \
  -e POSTGRES_PASSWORD=autopulse \
  -e POSTGRES_DB=autopulse \
  postgres

# 启动 autopulse
docker run -d --net autopulse --name autopulse \
  -e AUTOPULSE__APP__DATABASE_URL=postgres://postgres:autopulse@postgres/autopulse \
  ghcr.io/dan-online/autopulse

使用 SQLite 数据库

bash
# 文件存储 SQLite
docker run -d --net autopulse --name autopulse \
  -e AUTOPULSE__APP__DATABASE_URL=sqlite://database.db \
  -v $(pwd)/data:/app/data \  # 挂载目录持久化数据库
  ghcr.io/dan-online/autopulse

# 内存 SQLite（数据不持久化）
docker run -d --net autopulse --name autopulse \
  -e AUTOPULSE__APP__DATABASE_URL=sqlite://:memory: \
  ghcr.io/dan-online/autopulse

Docker Compose 示例

yaml
version: '3'
services:
  autopulse:
    image: ghcr.io/dan-online/autopulse
    container_name: autopulse
    environment:
      - AUTOPULSE__APP__DATABASE_URL=sqlite:///data/database.db
      - AUTOPULSE__AUTH__USERNAME=admin
      - AUTOPULSE__AUTH__PASSWORD=securepassword  # 建议修改默认密码
    volumes:
      - ./autopulse-data:/app/data
    ports:
      - "2875:2875"  # 默认端口
    restart: unless-stopped

配置说明

配置方式

autopulse 支持通过配置文件（支持 json/toml/yaml/json5/ron/ini 格式）或环境变量配置，环境变量格式为 AUTOPULSE__{SECTION}__{KEY}（如 AUTOPULSE__APP__DATABASE_URL）。默认读取当前目录下的 config.toml。

核心配置参数

授权配置

默认用户名/密码为 admin/password，强烈建议通过配置文件或环境变量修改：

yaml
auth:
  username: 自定义用户名
  password: 强密码

示例配置

配置文件示例（yaml 格式）

yaml
triggers:
  my_sonarr:
    type: "sonarr"
    rewrite:  # 路径重写：将 Sonarr 中的 /downloads 路径转换为媒体服务器的 /tvshows
      from: "/downloads"
      to: "/tvshows"

  my_radarr:
    type: "radarr"
    rewrite:
      from: "/downloads"
      to: "/movies"

  my_notify:  # 监控文件系统变化
    type: "notify"
    paths:
      - "/watch"  # 监控 /watch 目录
    rewrite:
      from: "/watch"
      to: "/media"

targets:
  my_plex:
    type: "plex"
    url: "http://plex:32400"
    token: "你的 Plex Token"

  my_jellyfin:
    type: "jellyfin"
    url: "http://jellyfin:8096"
    token: "你的 Jellyfin API 密钥"

webhooks:
  my_discord:  # 发送通知到 Discord
    type: "discord"
    url: "https://discord.com/api/webhooks/你的webhook地址"

手动触发扫描

通过默认手动触发器端点触发扫描：

bash
# 使用用户名密码认证
curl -u '用户名:密码' 'http://localhost:2875/triggers/manual?path=/media/movies/新电影.mkv&hash=文件哈希值'

# 使用 Basic Auth 头认证
curl -H 'Authorization: Basic base64编码的用户名密码' 'http://localhost:2875/triggers/manual?path=/media/tv/新剧集.mkv'

配置模板 API

通过 API 动态生成配置模板：

bash
# 获取基础模板
curl -u "用户名:密码" "http://localhost:2875/api/config-template"

# 指定数据库类型、触发器和目标类型，输出 JSON 格式
curl -u "用户名:密码" "http://localhost:2875/api/config-template?database=postgres&triggers=sonarr,radarr&targets=plex,jellyfin&output=json"

UI 部署（可选）

autopulse 提供 Web UI 用于管理扫描请求，可通过 Docker 部署：

bash
docker run -d --name autopulse-ui \
  -e DEFAULT_SERVER_URL=http://autopulse:2875 \  # 连接后端地址
  -p 2885:2885 \
  ghcr.io/dan-online/autopulse:ui

UI 支持通过环境变量配置默认服务器地址、强制认证等，详细参数见官方文档。

注意事项

• 默认用户名/密码（admin/password）仅适用于测试，生产环境必须修改
• 路径重写配置需确保触发器和目标的路径映射正确，避免文件找不到
• 数据库持久化：使用 SQLite 时建议挂载数据卷，防止容器重启丢失数据
• 网络配置：确保 autopulse 容器能访问媒体管理器和媒体服务器的 API 端口