lsiodev/calibre-web

linuxserver/calibre-web

https://github.com/janeczku/calibre-web 是一个Web应用，提供干净的界面用于浏览、阅读和下载电子书，使用现有的Calibre数据库。还可以集成谷歌驱动器，并通过应用本身编辑元数据和Calibre库。该软件是library的分支，基于GPL v3许可证。

LinuxServer.io团队提供的此容器具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带有s6 overlay的自定义基础镜像
• 每周基础OS更新，整个LinuxServer.io生态系统共享公共层，以最小化空间占用、停机时间和带宽
• 定期安全更新

!https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/calibre-web-icon.png

支持的架构

我们利用docker manifest实现多平台支持。只需拉取 lscr.io/linuxserver/calibre-web:latest 即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构：

版本标签

此镜像提供多种版本，可通过标签获取。使用不稳定或开发标签时请谨慎。

应用设置

Web界面可通过 http://your-ip:8083 访问。

在初始设置页面，输入 /books 作为Calibre库位置。

默认管理员登录：

• 用户名：admin
• 密码：admin123

如果锁定自己或忘记密码，需指定app.db，命令如下： docker exec -it calibre-web python3 /app/calibre-web/cps.py -p /config/app.db -s <user>:<pass> 若未指定正确的数据库，命令看似成功但实际无效。

默认包含unrar，需在Calibre-Web管理页面（基本配置：外部二进制文件）中设置路径为 /usr/bin/unrar。

仅64位系统 我们实现了可选功能，可拉取依赖以启用Calibre电子书转换功能。如需此功能，添加docker-mods部分所示的可选环境变量以拉取额外的docker层，然后在Calibre-Web管理页面（基本配置：外部二进制文件）中将Calibre电子书转换器路径设置为 /usr/bin/ebook-convert。

此镜像包含 kepubify 电子书转换工具（MIT许可证），用于将epub转换为kepub。在Calibre-Web管理页面（基本配置：外部二进制文件）中将Kepubify电子书转换器路径设置为 /usr/bin/kepubify。

使用方法

以下提供docker-compose和docker cli两种方式创建容器。

docker-compose（推荐，点击查看更多信息）

yaml
---
version: "2.1"
services:
  calibre-web:
    image: lscr.io/linuxserver/calibre-web:latest
    container_name: calibre-web
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DOCKER_MODS=linuxserver/mods:universal-calibre #可选
      - OAUTHLIB_RELAX_TOKEN_SCOPE=1 #可选
    volumes:
      - /path/to/data:/config
      - /path/to/calibre/library:/books
    ports:
      - 8083:8083
    restart: unless-stopped

docker cli（点击查看更多信息）

bash
docker run -d \
  --name=calibre-web \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DOCKER_MODS=linuxserver/mods:universal-calibre `#optional` \
  -e OAUTHLIB_RELAX_TOKEN_SCOPE=1 `#optional` \
  -p 8083:8083 \
  -v /path/to/data:/config \
  -v /path/to/calibre/library:/books \
  --restart unless-stopped \
  lscr.io/linuxserver/calibre-web:latest

参数

容器通过运行时传递的参数进行配置（如上所示）。参数以冒号分隔，表示 <外部>:<内部>。例如，-p 8080:80 表示将容器内的80端口映射到主机的8080端口。

来自文件的环境变量（Docker secrets）

可使用特殊前缀 FILE__ 从文件设置任何环境变量。

示例：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

将根据 /run/secrets/mysecretvariable 文件内容设置环境变量 MYVAR。

应用运行的Umask

所有镜像都支持使用可选的 -e UMASK=022 设置覆盖容器内服务的默认umask。请注意，umask不是chmod，它基于其值减去权限而非添加。请在请求支持前了解。

用户/组标识符

使用卷（-v 标志）时，主机OS和容器之间可能出现权限问题。通过指定用户 PUID 和组 PGID 可避免此问题。

确保主机上的任何卷目录都由您指定的用户拥有，权限问题将迎刃而解。

此处 PUID=1000 和 PGID=1000，使用 id your_user 命令获取您的ID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker模块

https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=calibre-web&query=%24.mods%5B%27calibre-web%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看此容器的可用模块") https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看可用的通用模块")

我们发布了各种 https://github.com/linuxserver/docker-mods 以启用容器内的附加功能。上述动态徽章可访问此镜像的可用模块（如有）以及可应用于任何LinuxServer.io镜像的通用模块。

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it calibre-web /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f calibre-web
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre-web
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre-web:latest
  

更新信息

大多数镜像都是静态、版本化的，需要更新镜像并重新创建容器以更新内部应用。除部分例外（如nextcloud、plex），不建议或支持在容器内更新应用。请参阅上文应用设置部分了解是否推荐更新。

以下是更新容器的说明：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull calibre-web
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d calibre-web
    

• 移除旧的悬空镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/calibre-web:latest
  

• 停止运行中的容器：

  bash
  docker stop calibre-web
  

• 删除容器：

  bash
  docker rm calibre-web
  

• 使用上述相同的docker run参数重新创建容器（若正确映射到主机文件夹，/config 文件夹和设置将保留）

• 移除旧的悬空镜像：

  bash
  docker image prune
  

通过Watchtower自动更新器（仅在忘记原始参数时使用）

• 拉取最新标签镜像并使用相同环境变量替换：

  bash
  docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once calibre-web
  

• 移除旧的悬空镜像：docker image prune

警告：我们不认可使用Watchtower作为现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但对于忘记原始参数的容器，这是一个有用的一次性手动更新工具。长期来看，强烈建议使用 Docker Compose。

镜像更新通知 - Diun（Docker镜像更新通知器）

提示：推荐使用 Diun 获取更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如需为开发或自定义逻辑修改这些镜像：

bash
git clone https://github.com/linuxserver/docker-calibre-web.git
cd docker-calibre-web
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/calibre-web:latest .

可使用 multiarch/qemu-user-static 在x86_64硬件上构建ARM变体：

bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset

注册后，可使用 -f Dockerfile.aarch64 指定dockerfile。

版本历史

• 07.10.23: - 从 https://github.com/linuxserver/docker-unrar 安装unrar。切换到Python虚拟环境。
• 13.04.23: - 弃用armhf。
• 27.03.23: - 添加cmake作为Levenshtein的构建依赖。
• 27.12.22: - 添加ghostscript、libxtst6、libxkbfile-dev。
• 20.12.22: - 改进初始化脚本并防止无害错误。
• 19.10.22: - 基于jammy重建。升级到s6v3。清理构建依赖。
• 04.11.21: - 更新pip参数以忽略发行版安装的包。
• 24.06.21: - 添加关于可选OAUTHLIB_RELAX_TOKEN_SCOPE以支持Google OAUTH的说明。
• 17.05.21: - 添加linuxserver wheel索引。
• 10.02.21: - 添加libxrandr2。
• 25.01.21: - 添加nightly标签。
• 19.01.21: - 添加python3-pkg-resources。
• 13.01.21: - 基于Ubuntu Focal重建，故障排除armhf参见此处。
• 12.10.20: - 添加libxi6。
• 12.07.20: - 为arm64v8添加kepubify。
• 05.06.20: - 为x86-64和arm32v7添加kepubify。
• 06.05.20: - 添加libxslt1.1并更新ImageMagick策略。
• 19.01.20: - 添加LDAP库。
• 13.10.19: - 迁移到Python3。
• 01.08.19: - 添加libxcomposite1。
• 13.06.19: - 添加docker模块以在x86-64上启用可选电子书转换。添加unrar。
• 02.06.19: - 基于Ubuntu Bionic重建并添加Gdrive支持。
• 23.03.19: - 切换到新基础镜像，使用arm32v7标签。
• 23.02.19: - 基于alpine 3.9重建，使用repo版本的imagemagick。
• 11.02.19: - 添加流水线逻辑和多架构支持。
• 03.01.19: - 从默认app.db中移除guest用户。
• 16.08.18: - 基于alpine 3.8重建。
• 03.07.18: - 推送新构建，所有低于67的版本存在https://github.com/janeczku/calibre-web/issues/534%E3%80%82
• 05.01.18: - 弃用cpu_core例程，因缺乏扩展性。
• 06.12.17: - 基于alpine 3.7重建。
• 27.11.17: - 使用cpu核心计数例程加快构建时间。
• 24.07.17: - Curl版本的imagemagick。
• 17.07.17: - 初始发布。