快速开始

Ting Reader 是一个自托管的有声书平台。你只需要把自己的有声书音频文件放在 NAS/网盘 (支持 WebDAV) 里,就可以在手机/电脑上随时在线播放、续播与同步进度。

🚀 部署方式

推荐: 如果您使用的是飞牛 NAS (fnOS),推荐使用 FPK 安装包进行一键部署,简单快捷。

1. 飞牛 NAS (fnOS) 应用商店安装

步骤一:导入安装包

进入「应用中心」,在右下角点击「手动安装」,导入下载好的 FPK 文件。

导入安装包

步骤二:选择安装位置

选择安装位置,点击「下一步」。

选择安装位置

步骤三:应用配置

  • JWT 密钥:可以在命令行输入 openssl rand -base64 32 生成密钥填入。
  • 存储路径:填入有声书本地存储路径(可选)。

配置完成点击「下一步」,最后点击「确定」等待安装即可(容器镜像较大,首次安装请耐心等待)。

应用配置

进阶原生应用权限配置

如果您使用的是原生版 (Native) FPK 且自定义了有声书本地存储路径,需要手动授予文件夹读写权限:

  1. 打开应用设置: 在「应用中心」-「已安装」找到 Ting Reader,点击应用图标进入详情页。
    打开应用设置
  2. 进入权限管理: 点击「应用设置」按钮。
    进入权限管理
  3. 添加文件夹权限: 点击「文件夹」,添加您自定义的有声书存储目录,并勾选「读写」权限,最后点击确定保存。
    添加文件夹权限

2. Docker 容器部署 (通用)

适用于所有支持 Docker 的系统 (群晖、威联通、Linux 服务器等)。

Docker Compose

services:
  ting-reader:
    image: dqsq2e2/ting-reader:latest
    container_name: ting-reader
    ports:
      - "3000:3000"
    volumes:
      - /path/to/data:/app/data
      - /path/to/plugins:/app/plugins
      - /path/to/temp:/app/temp
      - /path/to/storage:/app/storage
    restart: always
    environment:
      - RUST_LOG=info
      - TING_SERVER__HOST=0.0.0.0
      - TING_SERVER__PORT=3000
      - TING_SECURITY__JWT_SECRET=ting_reader_jwt_secret_change_me_in_prod
      - TEMP_DIR=/app/temp
      - DATA_DIR=/app/data
      - STORAGE_DIR=/app/storage

📂 存储映射 (Volumes)

容器路径说明宿主机路径示例
/app/data存放数据库文件 (sqlite) 及配置文件,请务必持久化./data
/app/plugins存放插件文件,如 scraper 等./plugins
/app/storage有声书音频文件的存放目录,应用会扫描此目录下的书籍/mnt/audiobooks
/app/temp存放封面图片缓存及转码后的临时文件./temp

⚙️ 环境变量 (Environment)

  • TING_SECURITY__JWT_SECRET: 必须修改! 用于生成登录 Token 的加密密钥。请使用复杂的随机字符串,例如在终端运行 openssl rand -base64 32 生成。
  • TING_SERVER__PORT: 容器内部监听的端口,默认为 3000。通常无需修改,只需修改 ports 映射即可(如 "8080:3000")。
  • DATA_DIR: 数据存储目录,默认为 /app/data

🧩 插件安装

系统支持安装插件以扩展功能(如刮削源等)。

  1. 访问 插件中心 下载所需插件。
  2. 登录管理后台,在「系统设置」-「插件管理」中上传安装即可。
  3. 插件支持热插拔,安装后立即生效。

保存为 docker-compose.yml 并运行 docker-compose up -d 即可启动。

3. 首次登录

默认账号信息

访问地址:http://ip:3000

账号:admin

密码:admin123

* 为了您的安全,请登录后立即修改密码。

4. 远程访问与 SSL 配置 (推荐)

为了获得更好的体验(特别是移动端 PWA 和音频播放),建议配置 HTTPS 访问。

  • 反向代理:推荐使用 Nginx Proxy Manager 或 Lucky 等工具进行反向代理。
  • 证书申请:可以通过 Let's Encrypt 申请免费的 SSL 证书。
  • 端口映射:在路由器上将外网端口映射到 NAS 的反向代理端口。