gelbphoenix/autocaliweb

Autocaliweb

镜像概述和主要用途

Autocaliweb是一个基于Calibre数据库的Web应用，提供简洁直观的界面，用于浏览、阅读和下载电子书。该软件是Calibre-Web和Calibre-Web Automated的分支，采用GPL v3许可证授权，适合个人或团队管理电子书库，支持多用户访问及与电子书阅读器集成。

核心功能和特性

主要功能

• 现代响应式Bootstrap 3 HTML5界面
• 全图形化设置向导
• 全面的用户管理及细粒度权限控制
• 管理员界面
• 多语言支持（20+种语言）
• OPDS订阅源（支持电子书阅读器应用）
• 高级搜索和过滤选项
• 自定义图书集合（书架）创建
• 电子书元数据编辑和删除支持
• 多来源元数据下载（可通过插件扩展）
• 通过Calibre二进制文件进行电子书转换
• 仅允许登录用户下载电子书
• 支持公开用户注册
• 发送电子书到电子阅读器
• 与Kobo设备同步Calibre库
• 浏览器内支持多种格式电子书阅读
• 支持上传多种格式图书（含音频格式）
• Calibre自定义列支持
• 基于分类和自定义列内容的用户级内容隐藏
• 自我更新能力
• "魔法链接"登录（便于电子阅读器访问）
• LDAP、Google/GitHub OAuth及代理认证支持
• 自动摄取、转换、元数据和封面强制及备份服务
• 自动EPub修复服务
• 库自动检测
• 自动设置
• 服务器统计跟踪
• 主题切换
• 图书批量编辑
• ISBNDB、Amazon JP和Hardcover作为额外元数据提供器
• 与Hardcover.app同步阅读进度（仅支持Kobo电子阅读器）
• 拆分库支持
• 支持CLI兼容的Calibre插件
• 支持与KOReader文档查看器同步
• 自动合并选项设置
• 自动为新添加图书获取元数据
• 自动将新图书发送到电子阅读器

Autocaliweb独有特性

• 支持来自linuxserver.io等来源的DOCKER_MODS
• 从Goodreads或Hardcover列出并缓存作者信息及其他图书
• 用户可启用/禁用Kobo同步、Overdrive标签及Instapaper集成（使用Kobo同步时）
• 支持自定义OIDC提供器（支持/.well-known/openid-configuration）
• 支持手动安装（无Docker特定功能）
• LitRes作为元数据提供器
• 多***选择（发送电子书到电子阅读器功能）
• 重复图书管理系统
• 生成通用图书封面

使用场景和适用范围

• 个人电子书库管理：整理、浏览和阅读个人电子书收藏
• 小型团队/家庭共享：多用户权限控制，实现电子书共享
• 电子阅读器集成：与Kobo等设备同步，方便离线阅读
• 图书馆管理：支持元数据编辑、批量操作，适合管理大量电子书

详细的使用方法和配置说明

安装（推荐Docker方式）

快速安装

1. 下载Docker Compose模板文件到Autocaliweb数据目录（如/opt/autocaliweb）：

   bash
   curl -Lo ./docker-compose.yml https://raw.githubusercontent.com/gelbphoenix/autocaliweb/main/docker-compose.yml
   

2. 编辑模板文件，根据注释填写时区和挂载路径。

3. 导航到下载目录并启动容器：

   bash
   docker compose up -d
   

Docker Compose配置示例

yaml
services:
  autocaliweb:
    image: gelbphoenix/autocaliweb:latest
    container_name: autocaliweb
    restart: unless-stopped
    ports:
      - "8083:8083"  # 主机端口:容器端口
    environment:
      - TZ=Etc/UTC  # 更改为指定时区（如Europe/Berlin、America/Denver）
      - PUID=1000   # 运行容器的用户ID
      - PGID=1000   # 运行容器的用户组ID
    volumes:
      - /path/to/config:/config                # 配置文件目录
      - /path/to/book/ingest:/acw-book-ingest  # 图书摄取目录
      - /path/to/library:/calibre-library      # Calibre库目录
    stop_signal: SIGINT
    stop_grace_period: 15s

其他安装方式

手动安装（风险自负）

1. 下载安装脚本并检查：

   bash
   curl -Lo ./manual_install_acw.sh https://github.com/gelbphoenix/autocaliweb/raw/refs/heads/main/scripts/manual_install_acw.sh
   

2. 赋予执行权限并以root运行：

   bash
   sudo chmod +x ./manual_install_acw.sh && sudo ./manual_install_acw.sh
   

3. 按照安装成功后的提示完成后续步骤。

Proxmox VE脚本

可使用Proxmox VE Helper-Scripts团队维护的脚本：

bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/autocaliweb.sh)"

bash
bash -c "$(curl -fsSL https://git.community-scripts.org/community-scripts/ProxmoxVE/raw/branch/main/ct/autocaliweb.sh)"

安装后步骤

1. 访问Autocaliweb：在浏览器中导航至 http://localhost:8083（OPDS目录为 http://localhost:8083/opds）。

2. 使用默认管理员凭据登录：

   用户名：admin
   密码：admin123
   

3. 通过管理员页面配置实例：

   • 基础配置指南可参考https://github.com/janeczku/calibre-web/wiki/Configuration#basic-configuration
   • 确保在 设置 -> 基本配置 -> 功能配置 中启用"允许上传"

4. Google Drive集成：如将Calibre库托管在Google Drive，参考https://github.com/janeczku/calibre-web/wiki/G-Drive-Setup#using-google-drive-integration%E3%80%82

重要：如从Calibre-Web Automated迁移，请确保启动前将 cwa.db 重命名为 acw.db。

部署要求

Docker部署要求

• Docker版本：27.5.1（最低）
• Docker Compose版本：2.33.1（最低）

手动安装要求

详见https://github.com/gelbphoenix/autocaliweb/wiki/Manual-Installation#prerequisites

Proxmox VE脚本要求

• 已更新的Proxmox VE安装

故障排除

• 常见问题：

  • 应用启动问题：检查 logs 目录中的日志文件获取错误信息。
  • 图书加载失败：验证"Calibre数据库位置"设置正确且数据库文件可访问。

• 配置错误：确保Calibre数据库兼容且格式正确，参考Calibre文档维护数据库。

• 性能问题：

  • 如应用运行缓慢，考虑增加服务器资源（CPU/RAM）或优化Calibre数据库（删除重复项和不必要条目）。
  • 定期清除浏览器缓存以提高加载速度。

• 用户管理问题：用户无法登录或注册时，检查管理员界面中的用户权限设置，确保注册已启用且用户被分配适当角色。

文档和资源

• 官方文档：https://github.com/gelbphoenix/autocaliweb/wiki%EF%BC%88%E6%9C%AA%E5%AE%8C%E6%88%90%EF%BC%89
• 社区贡献：https://github.com/gelbphoenix/autocaliweb/pulls
• 问题反馈：https://github.com/gelbphoenix/autocaliweb/issues===SHORT_DESC=== 基于Calibre数据库的电子书管理Web应用，提供简洁直观的界面，用于浏览、阅读和下载电子书，支持用户管理、元数据编辑、多格式转换及设备同步等功能。 ===FULL_DESC===# Autocaliweb

镜像概述和主要用途

Autocaliweb是一个基于Calibre数据库的电子书管理Web应用，提供简洁直观的界面，用于浏览、阅读和下载电子书。作为Calibre-Web和Calibre-Web Automated的分支，采用GPL v3许可证授权，支持多用户访问、元数据管理及电子阅读器同步，适合个人或团队构建和维护数字图书馆。

核心功能和特性

主要功能

• 现代响应式Bootstrap 3 HTML5界面，适配多种设备
• 全图形化设置向导，简化初始配置
• 细粒度用户管理及权限控制，支持多角色配置
• 多语言界面（20+种语言），满足国际化需求
• OPDS订阅源，兼容主流电子书阅读器应用
• 高级搜索与过滤功能，快速定位图书
• 自定义书架功能，支持图书分类管理
• 电子书元数据编辑、删除及多来源下载（可通过插件扩展）
• 集成Calibre二进制工具，支持电子书格式转换
• 访问控制机制，限制未登录用户下载权限
• 支持公开注册及邀请机制
• 电子书推送至电子阅读器功能，支持Kobo设备同步
• 浏览器内阅读功能，兼容多种电子书格式
• 支持上传多种格式文件（含音频格式）
• 兼容Calibre自定义列，扩展元数据管理能力
• 基于分类和自定义列的内容访问控制
• 应用自我更新及服务器统计跟踪功能
• "魔法链接"登录，简化电子阅读器访问流程
• 支持LDAP、Google/GitHub OAuth及代理认证
• 自动图书摄取、转换、元数据修复及备份服务
• 批量编辑功能，高效管理图书信息
• 多源元数据支持（ISBNDB、Amazon JP、Hardcover等）
• 与Hardcover.app同步阅读进度（仅限Kobo设备）
• 支持库拆分及CLI兼容Calibre插件

Autocaliweb独有特性

• 兼容linuxserver.io等来源的DOCKER_MODS扩展
• 从Goodreads或Hardcover缓存并展示作者信息及关联图书
• 可配置Kobo同步、Overdrive标签及Instapaper集成开关
• 支持自定义OIDC认证提供器（兼容/.well-known/openid-configuration）
• 提供LitRes元数据服务支持
• 多***选择功能（用于电子书推送）
• 重复图书检测与管理系统
• 自动生成通用图书封面

使用场景和适用范围

• 个人数字图书馆：集中管理电子书收藏，支持跨设备访问与阅读
• 家庭/小型团队共享：通过权限控制实现图书安全共享
• 电子阅读器用户：与Kobo等设备同步，自动推送新图书
• 图书馆或教育机构：构建在线图书目录，支持用户借阅管理

详细的使用方法和配置说明

安装（推荐Docker方式）

快速安装步骤

1. 下载Docker Compose模板至数据目录（如/opt/autocaliweb）：

   bash
   curl -Lo ./docker-compose.yml https://raw.githubusercontent.com/gelbphoenix/autocaliweb/main/docker-compose.yml
   

2. 编辑模板文件，配置时区（TZ）、用户ID（PUID）、用户组ID（PGID）及挂载路径。

3. 启动容器：

   bash
   docker compose up -d
   

Docker Compose配置示例

yaml
services:
  autocaliweb:
    image: gelbphoenix/autocaliweb:latest
    container_name: autocaliweb
    restart: unless-stopped
    ports:
      - "8083:8083"  # 主机端口:容器端口
    environment:
      - TZ=Asia/Shanghai  # 设置时区（如Europe/Berlin、America/New_York）
      - PUID=1000         # 运行用户ID
      - PGID=1000         # 运行用户组ID
    volumes:
      - /path/to/config:/config                # 配置文件存储路径
      - /path/to/ingest:/acw-book-ingest       # 图书上传/摄取目录
      - /path/to/library:/calibre-library      # Calibre数据库及图书存储路径
    stop_signal: SIGINT
    stop_grace_period: 15s

安装后配置步骤

1. 访问应用：在浏览器中打开 http://<服务器IP>:8083（OPDS目录：http://<服务器IP>:8083/opds）。

2. 初始登录：使用默认管理员凭据：

   用户名：admin
   密码：admin123
   

3. 基础配置：

   • 进入管理员界面（Admin Page）完成必要设置
   • 启用上传功能：设置 > 基本配置 > 功能配置 > 允许上传
   • 参考https://github.com/janeczku/calibre-web/wiki/Configuration#basic-configuration%E4%BA%86%E8%A7%A3%E8%AF%A6%E7%BB%86%E5%8F%82%E6%95%B0

4. Google Drive集成：如需将图书库托管至Google Drive，参考https://github.com/janeczku/calibre-web/wiki/G-Drive-Setup#using-google-drive-integration%E3%80%82

迁移注意：从Calibre-Web Automated迁移时，需将cwa.db重命名为acw.db后启动容器。

部署要求

Docker环境要求

• Docker ≥ 27.5.1
• Docker Compose ≥ 2.33.1

手动安装要求

详见https://github.com/gelbphoenix/autocaliweb/wiki/Manual-Installation#prerequisites

故障排除

• 启动失败：检查logs目录日志文件，确认挂载路径权限及数据库完整性。
• 图书无法加载：验证"Calibre数据库位置"配置正确，数据库文件（metadata.db）可访问。
• 性能优化：定期清理数据库冗余数据，增加容器内存分配（建议≥1GB）。
• 认证问题：LDAP/OAuth配置错误时，检查日志中认证流程详细信息。

资源与支持

• 官方文档：https://github.com/gelbphoenix/autocaliweb/wiki
• 问题反馈：https://github.com/gelbphoenix/autocaliweb/issues
• 社区贡献：https://github.com/gelbphoenix/autocaliweb/pulls