MyBooks 文档

主题

系统设置说明 ​

系统管理 - 设置 页面按功能分为若干个可折叠的卡片分组，每个分组内是相关的配置项。本文按页面上的 分组顺序（即目录），逐项说明每个配置的作用。

保存与重启

页面底部提供「保存设置」和「重启服务」两个按钮。图标为红色的配置项修改后需要重启服务才能生效， 保存时会有相应提示；其余选项保存后刷新页面即可生效。

目录 ​

基础信息 ​

  • 网站标题：显示在浏览器标题栏及页面顶部的站点名称。
  • 网站图标：站点 favicon，默认第一个灰色图标表示不做变更。
  • 网站公告：显示在首页顶部的公告内容，支持富文本。
  • 网站脚注：显示在页面底部的说明文字。
  • 脚注水印：追加在脚注中的水印文字。
  • 隐藏脚注中的项目链接：勾选后，脚注中不再展示 MyBooks 项目相关链接。
  • 语言切换：站点默认语言（简体中文 / 繁體中文 / English）。
  • 首页类型：首页展示形式，可选「默认首页」「所有图书」「分类浏览」。
  • 首页 - 随机推荐图书数量：首页随机推荐区展示的图书数量，设为 0 时隐藏该模块。
  • 首页 - 新书推荐显示数量：首页新书推荐区展示的图书数量。
  • 书籍列表中分页大小：书籍列表页每页展示的数量，默认 60。

私人图书馆模式 ​

勾选「开启私人图书馆模式」后展开：

  • 访问码：访问站点需要输入的访问码。
  • 提示语：访问码输入框旁展示的提示信息。

浏览与阅读 ​

  • 阅读器：默认使用的在线阅读器，可选「EPUB Reader」（纯本地，仅支持 EPUB）或 「MyReader」（完整功能，支持多端数据同步，推荐）。
  • 启用 MyReader 数据同步功能：开启后，使用 MyReader 账号登录的用户可在多端同步阅读数据。
  • 启用动态封面：根据书籍信息自动生成封面图片。
  • 显示作者详情信息：在书籍详情页展示作者头像及简介。
  • 允许用户自行关闭阅读及下载数据采集：关闭该项时，默认采集所有用户的数据；开启后用户可自行选择是否被采集。
  • 在首页显示阅读统计 Banner：默认开启。
  • 在首页显示在读书籍：默认开启。
  • 在首页展示书单推荐：在首页展示书单推荐模块。
  • 允许用户对书籍进行评论及评分：开启书籍评论 / 评分功能。
  • 评论需要审核后才能展示：仅在开启评论功能时生效，评论需管理员审核后才对外可见。
  • 在首页展示其他用户评论过的书籍：将其他用户评论过的书籍展示在首页。
  • 阅读时支持查看其他用户的划线与笔记：开启后用户可在阅读界面查看他人公开的划线与笔记。

实体书 ​

勾选「启用添加实体书功能」后展开：

  • 允许直接转换类型，不做是否已有文件及 ISBN 等检查：放宽实体书转换电子书时的校验。

用户设置 ​

  • 允许访客在线阅读及播放有声书：无需注册登录即可在线阅读 / 听书。
  • 允许任意下载：访客无需注册登录即可下载书籍。
  • 允许访客上传书籍：访客无需注册登录即可上传书籍，请注意开启后的风险。
  • 允许访客推送到阅读设备：访客无需注册登录即可将书籍推送到阅读设备。
  • 新注册用户默认启用书籍管理权限：新用户注册后默认拥有上传、编辑、删除、下载权限。
  • 新注册用户默认启用推送到阅读设备权限：新用户注册后默认可以推送书籍到阅读设备。

阅读范围控制 ​

勾选「开启用户的阅读范围控制」后展开：

  • 设置新用户的默认阅读范围：通过弹窗设置新用户默认可见 / 不可见的分类或标签，访客仅能查看未设置分类及标签的书。开启该功能后，限制用户可见或不可见的分类或标签。

允许访客以邮箱注册账号 ​

勾选后展开：

  • 激活邮件标题 / 正文：新用户注册激活邮件的标题与正文模板。
  • 重置密码邮件标题 / 正文：找回密码邮件的标题与正文模板。
  • 启用新用户注册的自动审批：关闭后，新用户注册需要管理员手动审批才能登录使用。

下载配额 ​

勾选「开启用户每日下载配额限制」后展开：

  • 全局每日下载配额：用户未单独设置配额时使用的默认值，0 表示不限制。

书栈服务 ​

书栈所提供的均为网上公开信息，开启后支持获取作者信息及书籍标签信息。

  • 启用书栈服务：开启 / 关闭书栈相关能力。
  • 授权 Token：书栈服务鉴权令牌，只读展示。
  • 获取 Token：申请 / 刷新授权 Token。

AI 助手 ​

配置 AI 助手相关功能（Beta）。

  • 启用 AI 助手：开启后才能使用下方的 AI 相关配置与功能。
  • API 密钥：前往模型服务商注册账号并获取的 API 密钥。
  • AI 接口地址：模型服务商 OpenAI 兼容接口地址。
  • AI 模型：选择使用的 AI 模型，部分功能可能需要特定模型支持。
  • MCP 访问令牌：只读展示，可点击刷新按钮重新生成。
  • 测试 AI 设置：使用当前配置发起一次测试请求，验证连通性。
  • 使用 AI 生成的书籍分类：允许 AI 助手为书籍自动生成 / 建议分类。

社交网络登录 ​

所启用的社交网络将会在登录页面自动显示按钮。

  • 选择要启用的社交网络账号：多选启用的第三方登录方式，每个选中的网络需要额外填写：
    • Key / AppID：第三方平台分配的应用 Key（或 AppID）。
    • Secret：第三方平台分配的应用密钥。

邮件服务 ​

邮箱注册、推送 Kindle 依赖此配置（SMTP 服务器地址可带端口，或不带端口，默认为 465 号）。

  • SMTP 服务器：例如 smtp.126.com。
  • SMTP 用户名：例如 user@126.com。
  • SMTP 密码：SMTP 账号密码。
  • SMTP 安全性：加密方式，可选 SSL 或 TLS。
  • 测试邮件：使用当前配置发送一封测试邮件，验证配置是否正确。

书籍分类 ​

配置自定义书籍分类，每行一个分类；也可以以 分类=标签1/标签2 的形式配置分类对应的标签， 对应分类的标签会在标签分类中分组显示。

  • 分类导航：以卡片形式维护每个分类及其下的标签，支持新增 / 删除分类、新增 / 删除标签； 分类名称重复时会给出错误提示，需修改后才能保存。

友情链接 ​

维护首页展示的友情链接列表，每条包含：

  • 名称：链接展示文字。
  • 链接：跳转地址，可通过末尾的删除图标移除该条链接。

全局设备管理 ​

管理全局阅读设备，所有用户均可使用。用户也可在「我的账户」中配置自己的私人设备。 每台设备可配置：

  • 名称：设备名称。
  • 类型：多看、掌阅、汉王、文石 Boox、KoReader、当当、Kindle、PureLibro 或 FTP 服务器。
  • 根据类型不同，还需填写：
    • Kindle：邮箱地址（需以 @kindle.com 结尾，可在 Kindle 设备的「您的账户」中查看）。
    • FTP 服务器：IP 地址、端口、用户名（留空为匿名）、密码、目标路径。
    • 其他类型：IP 地址、端口、访问协议（HTTP / HTTPS）。

互联网书籍信息源 ​

  • 自动从互联网拉取新书的书籍信息：导入 / 添加新书时自动联网获取书籍元数据。
  • 选择书籍信息来源：多选启用的信息源，可选豆瓣、百度百科、Google、Amazon、新华书店、 优书网、豆瓣 V2、悠久小说网、NeoDB 等。
  • 豆瓣插件 API 地址：自建豆瓣插件服务地址，例如 http://10.0.0.1:8080。
  • 豆瓣插件 API 密钥：可用的 key 数量有限，可自行查找替换。
  • 豆瓣插件 API 查询结果数量：单次查询返回的结果条数。

TIP

若需要启用豆瓣插件，请参阅安装文档的说明；若出现失败，可尝试更换镜像，例如 poxenstudio/douban-api-rs。

导入与上传 ​

  • 批量导入扫描目录：用于批量导入的监控 / 扫描目录路径。
  • 文件上传字节数限制（需重启）：例如 100MB 或 100KB。
  • 分片上传阈值：默认 0 表示不启用分片上传；大于 0 时，超出该大小的文件将分片上传， 每个分片最小 20MB，例如 50MB。
  • 默认语言：新导入书籍在未识别到语言信息时使用的默认语言。
  • 添加 PDF 文件时书名直接使用文件名：适用于导入的 PDF 元数据中书名不是真实书名的情况（如扫描件）。
  • 启用 TXT 转 TXTZ 插件（需重启）：将 TXT 格式书籍转换为内部 TXTZ 格式，启用后导入 TXT 耗时较长。
  • 导入完成后删除源文件：开启「监控导入目录，自动进行导入」后该选项将失效。
  • 上传后保留暂存源文件：默认上传入库后自动删除暂存源文件，开启后保留。
  • 在上传及导入后发送邮箱提醒：新书入库后发送邮件通知，15 分钟内合并发送。
  • 批量添加实体书时，强制添加无法识别的 ISBN 书籍：即使无法从互联网获取书籍信息， 也以 [无效]:<ISBN> 作为书名强制入库。
  • 使用第一级目录为自定义类别名称：例如导入目录下 a/b/c.epub 导入后类别为 a； 目录名不要有特殊字符，超过 10 个字符会被忽略。
  • 忽略根据书名和作者的同书检查：书库中将允许存在重复书籍，同书时不会自动添加新格式。

自动导入 ​

勾选「监控导入目录，自动进行导入」后展开（只处理新增入库，删除文件没有影响； 文件不完整时会被忽略；建议尽量保留导入记录，避免重复处理）：

  • 监控导入目录后，重命名第一级目录或文件移动到新目录时更新已导入书籍的类别： 按最新的一级目录名同步更新已导入书籍的分类。

高级配置项 ​

以下标红图标的配置项修改后需要重启服务才能生效。

  • CDN 域名（需重启）：静态资源使用的 CDN 域名。
  • 目录和文件名模式（需重启）：可选「使用拼音字母目录名」（兼容性高）或 「使用中文目录名」（UTF8 编码，更美观）。
  • COOKIE 随机密钥（需重启）：用于会话 Cookie 加密的随机密钥。
  • 邮件推送的标题 / 内容：推送到 Kindle 等设备的邮件标题与正文模板。
  • 书籍转换格式的最大超时时间：单位为秒，超时后转换任务判定失败。
  • 启用 WebDAV 服务：允许阅读器通过 WebDAV 协议访问书库。
  • WebDAV 中支持阅读器可写目录：用于阅读器同步，文件保存在 reader 目录下。
  • 启用 OPDS 目录服务：允许阅读器通过 OPDS 协议访问书库。
  • 启用 OPDS 目录服务认证：开启后访问 OPDS 需要输入用户名和密码。
  • 启用 Podcast 订阅服务：允许播放器通过 Podcast 协议访问有声书。
  • 启用工具箱开发者模式：允许在工具箱管理页手动上传 zip 安装 / 更新工具。
  • 启用工具箱商店：从 MyBooks 网站获取可安装工具列表与更新。
  • 更新配置后自动重启服务器：勾选后，保存需要重启才能生效的配置时会自动重启容器； 未勾选时保存后需手动重启。
  • 启用调试日志记录（需重启）：默认关闭，开启后记录详细的调试信息。
  • 启用有声书转换日志记录：默认关闭，开启后记录转换的详细日志。
  • 转换有声书时生成同名字幕文件：生成与有声书同名的字幕文件。
  • 自动检测更新：默认开启，关闭后将不再检查新版本。

扩展功能 ​

  • 启用封面加盖图章功能：开启后，可为书籍封面叠加自定义图章图片。开启后可继续设置：
    • 图章图片：上传图章图片，仅支持 PNG 格式，图片尺寸不超过 480×480 像素， 文件大小不超过 128KB，建议使用带透明背景的 PNG 图片以获得更好效果。

SSL 证书管理 ​

管理站点使用的 SSL 证书（申请、更新、查看有效期等），具体操作参见页面内的证书管理组件。

文件清理 ​

Calibre 回收站（library/.caltrash）用于存放已删除的书籍文件，默认删除后 7 天自动清理。 上传目录（upload）下是上传时创建的文件，入库完成后仍然存在；两者合计少于 10M 时不需要清理。

  • 页面展示当前 Calibre 回收站 与 上传目录 各自占用的大小。
  • 清理文件：清空回收站及上传目录中的临时文件，此操作不可恢复（合计大于 10M 时按钮才可用）。
  • 查看 / 恢复已删除书籍：跳转到回收站书籍管理页面，可单独恢复某本已删除的书籍。

MyBooks 文档

Copyright © PoxenStudio