插件安装指南

听悦(Ting Reader)支持通过插件扩展功能。通过安装插件,您可以支持更多的音频格式或从更多的来源获取书籍元数据。

1. 准备工作

在安装插件之前,请确保您已经正确配置了插件目录的映射。

Docker 部署检查

检查您的 docker-compose.yml 文件,确保包含 /app/plugins 的映射:

volumes:
  - ./plugins:/app/plugins  # 必须映射此目录
  - ./data:/app/data
  - ./storage:/app/storage

如果未映射该目录,请添加映射并运行 docker-compose up -d 重启容器。

2. 下载插件

插件包由插件作者或官方渠道发布。请下载对应的 .tr 签名插件包后,在管理后台上传安装。

插件类型说明

通用插件 (JS / WASM)

例如 ximalaya-scraper-jsypshuo-scraper-wasm
这类插件通常与操作系统无关,下载后直接使用即可。

原生插件 (Native)

这类插件依赖于操作系统和 CPU 架构,必须下载对应的版本。

原生插件版本选择

文件名标识适用环境
linux-x86_64通用 Linux 服务器、群晖/威联通 NAS (Intel/AMD CPU)
linux-aarch64树莓派、群晖/威联通 NAS (ARM CPU)、Oracle Cloud ARM
windows-x86_64Windows 桌面版或服务器

3. 安装与生效

  1. 下载插件

    从插件作者或官方发布渠道下载所需的插件文件(.tr 签名插件包)。

  2. 上传安装

    登录听悦(Ting Reader) 管理后台,进入「后台管理」-「插件管理」。
    点击右上角的「安装插件」按钮,选择下载的插件文件进行上传。

    提示:听悦(Ting Reader)的插件系统支持热插拔,安装后立即生效,无需重启容器。
  3. 验证状态

    安装完成后,新插件将出现在插件列表中,状态应显示为 Active

  4. 配置插件

    如果插件需要填写参数,请在已下载插件卡片底部点击齿轮按钮打开配置面板。

4. 插件配置

进入「后台管理」-「插件管理」,在已下载的插件列表中找到需要配置的插件。卡片底部会展示仓库、配置、刷新、删除等操作按钮。

已下载插件卡片底部的配置按钮位置

图中箭头指向的齿轮按钮就是插件配置入口。

  1. 点击配置按钮

    在插件卡片底部点击齿轮图标,打开该插件的配置面板。

  2. 填写插件参数

    按插件说明填写必填项,例如接口地址、访问密钥、启用开关或自定义选项。不同插件显示的配置项可能不同。

  3. 保存配置

    点击保存后配置会立即写入,插件下次执行刮削、解析或其他任务时会使用新的参数。

如果插件卡片底部没有齿轮按钮,通常表示该插件没有声明可配置项,可以直接使用。