ghcr.io/advplyr/audiobookshelf:latest

文档 · 支持 · 演示

[!WARNING] 现有Vue前端的拉取请求（pull requests）将不再被审核或合并。前端目前正在重写并迁移至React，即将发布。

关于

Audiobookshelf 是一个自托管的有声书和播客服务器。

功能

• 完全开源，包括安卓和iOS应用（测试版）
• 实时流式传输所有音频格式
• 搜索并添加播客以下载剧集，支持自动下载
• 多用户支持，带有自定义权限
• 为每个用户保存进度并跨设备同步
• 自动检测库更新，无需重新扫描
• 上传书籍和播客，支持拖放文件夹批量上传
• 备份元数据及自动每日备份
• 渐进式Web应用（PWA）
• Web应用和安卓应用支持Chromecast
• 从多个来源获取元数据和封面图
• 章节编辑器和章节查找（使用Audnexus API）
• 将音频文件合并为单个m4b文件
• 将元数据和封面图嵌入音频文件
• 基本电子书支持和阅读器（Epub、pdf、cbr、cbz）
• 将电子书发送到设备（如Kindle）
• Epub、pdf、cbr、cbz
• 将电子书发送到设备（如Kindle）
• 播客和有声书的开放RSS订阅源

您是否在寻找某个功能？欢迎提出建议

加入我们的***

演示

查看Web客户端演示：[***]（感谢 @Vito0912 提供主机支持！）

用户名/密码：demo/demo（用户账户）

demo``demo

安卓应用（测试版）

可在Google Play商店试用

iOS应用（测试版）

测试版目前已满员。苹果对测试人员数量有10k的硬性限制。更新将在***中发布。

使用Test Flight：https://testflight.apple.com/join/wiic7QIW（测试版已满员）

媒体组织

[!IMPORTANT] 目录结构和文件夹名称对 Audiobookshelf 至关重要！

有关支持的目录结构、文件夹命名规范和音频文件元数据使用方法，请参见库文档。

安装

参见安装文档

反向代理设置

[!IMPORTANT] 重要！Audiobookshelf 需要 WebSocket 连接。

[!NOTE] 注意：支持使用子文件夹，无需额外更改，但路径必须为 /audiobookshelf（不可更改）。参见讨论

/audiobookshelf

参见反向代理文档

贡献

参见贡献文档

本地化

感谢Weblate免费为我们提供本地化基础设施。如果您希望看到Audiobookshelf支持您的语言，请帮助我们进行本地化。有关帮助翻译的更多信息，请点击此处。

从源码运行

此应用使用NodeJs构建。

开发容器设置

开始开发此项目的最简单方法是使用开发容器。VSCode中开发容器的介绍可在此处找到。

所需软件：

• Docker Desktop
• VSCode

注意：可以使用Docker以外的其他容器软件和VSCode以外的其他IDE。但这种设置更为复杂，此处不做介绍。

注意：这需要带有winget的PowerShell命令提示符。您应该可以复制粘贴代码块进行安装。如果使用 elevated PowerShell 命令提示符，安装过程中不会弹出UAC。

winget install -e --id Docker.DockerDesktop; `
winget install -e --id Microsoft.VisualStudioCode

brew install --cask docker visual-studio-code

sudo snap install docker; \
sudo snap install code --classic

安装这些软件包后，现在可以安装VSCode的Remote Development扩展。安装此扩展后，打开命令面板（ctrl+shift+p 或 cmd+shift+p）并选择命令 >Dev Containers: Rebuild and Reopen in Container。这将构建并启动开发环境容器。

ctrl+shift+p``cmd+shift+p``>Dev Containers: Rebuild and Reopen in Container

现在您已准备好开始开发！

手动环境设置

如果不想使用开发容器，您仍然可以开发此项目。首先，需要安装NodeJs（20版）和FFmpeg。

接下来，需要在项目根目录中创建一个dev.js文件。此文件包含特定于您开发环境的配置信息和路径。您可以在.devcontainer/dev.js中找到此文件的示例。

dev.js``.devcontainer/dev.js

现在您已准备好构建客户端：

npm ci
cd client
npm ci
npm run generate
cd ..

开发命令

设置好开发环境（无论是使用开发容器还是自定义环境）后，以下命令将帮助您运行服务器和客户端。

要运行服务器，可以使用命令npm run dev。这将使用在客户端目录中运行npm run generate时或启动开发容器时构建的客户端。如果对服务器进行更改，需要重启服务器。如果对客户端进行更改，需要运行命令(cd client; npm run generate)，然后重启服务器。默认情况下，客户端运行在localhost:3333，不过端口可以在dev.js中配置。

npm run dev``npm run generate``(cd client; npm run generate)``localhost:3333``dev.js

您也可以构建支持热重载的客户端版本。为此，先启动服务器，然后运行命令(cd client; npm run dev)。这将在localhost:3000运行一个单独的客户端实例，当您对客户端进行更改时，该实例将自动更新。

(cd client; npm run dev)``localhost:3000

如果使用VSCode，此项目包含几个预定义目标以加快此过程。首先，如果构建项目（ctrl+shift+b 或 cmd+shift+b），它将自动生成客户端。其次，有用于运行服务器和客户端的调试命令。您可以使用调试面板（通过ctrl+shift+d 或 cmd+shift+d打开）查看这些目标：

ctrl+shift+b``cmd+shift+b``ctrl+shift+d``cmd+shift+d

• Debug server—运行服务器。 Debug server- Debug client (nuxt)—运行带热重载的客户端。 Debug client (nuxt)- Debug server and client (nuxt)—运行上述两个调试目标。 Debug server and client (nuxt)