linuxserver/readarr

镜像概述

Readarr 是一款书籍管理与自动化工具（可理解为电子书版的Sonarr），用于监控、下载和管理电子书。本镜像由LinuxServer.io团队提供，具备以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 基于s6 overlay的自定义基础镜像
• 每周基础操作系统更新，通过通用层减少空间占用、 downtime和带宽消耗
• 定期安全更新

支持的架构

本镜像利用Docker manifest实现多平台支持。直接拉取lscr.io/linuxserver/readarr:develop即可获取适合您架构的镜像，也可通过标签指定特定架构：

版本标签

本镜像提供多种版本标签，使用时请注意选择：

应用设置

通过<your-ip>:8787访问Web界面，更多信息请查看Readarr官方文档。

媒体文件夹

本镜像默认设置/books和/downloads为可选路径，这是最简单的入门方式，但可能失去硬链接（同一文件在同一文件系统中多位置存在但仅占用一份空间）和原子移动（即时文件移动而非复制+删除）的功能。

如果不需要硬链接/原子移动，可使用可选路径。关于路径规划的更多信息，可参考servarr.com的文档。

使用方法

以下是启动容器的示例配置。

Docker Compose（推荐，查看更多信息）

---
version: "2.1"
services:
  readarr:
    image: lscr.io/linuxserver/readarr:develop
    container_name: readarr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/data:/config
      - /path/to/books:/books #可选
      - /path/to/downloadclient-downloads:/downloads #可选
    ports:
      - 8787:8787
    restart: unless-stopped

Docker命令行（查看更多信息）

docker run -d \
  --name=readarr \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 8787:8787 \
  -v /path/to/data:/config \
  -v /path/to/books:/books `#可选` \
  -v /path/to/downloadclient-downloads:/downloads `#可选` \
  --restart unless-stopped \
  lscr.io/linuxserver/readarr:develop

参数说明

容器通过运行时参数配置，格式为<外部>:<内部>。例如-p 8080:80表示将容器内的80端口映射到主机的8080端口。

从文件加载环境变量（Docker Secrets）

可通过特殊前缀FILE__从文件设置环境变量。例如：

-e FILE__PASSWORD=/run/secrets/mysecretpassword

这会将PASSWORD环境变量设置为/run/secrets/mysecretpassword文件的内容。

应用运行权限掩码

所有镜像支持通过可选参数-e UMASK=022覆盖默认权限掩码。请注意，权限掩码不是chmod，它基于值减少权限而非增加。更多信息请参考这里。

用户/组标识符

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

确保主机上的卷目录由指定用户拥有，权限问题将迎刃而解。示例中使用PUID=1000和PGID=1000，可通过id user命令获取您的ID：

$ id username
  uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

我们提供多种Docker Mods以扩展容器功能。上方徽章链接可查看此镜像的专用Mods和适用于所有镜像的通用Mods。

支持信息

• 容器运行时进入shell：docker exec -it readarr /bin/bash
• 实时监控容器日志：docker logs -f readarr
• 容器版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' readarr
• 镜像版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/readarr

更新信息

大多数镜像为静态版本，需更新镜像并重建容器以更新应用（nextcloud、plex等除外）。不建议在容器内更新应用。

通过Docker Compose更新

• 更新所有镜像：docker-compose pull（或单独更新：docker-compose pull readarr）
• 更新容器：docker-compose up -d（或单独更新：docker-compose up -d readarr）
• 清理旧镜像：docker image prune

通过Docker Run更新

• 更新镜像：docker pull lscr.io/linuxserver/readarr
• 停止容器：docker stop readarr
• 删除容器：docker rm readarr
• 用原参数重建容器（/config文件夹映射正确的话，设置会保留）
• 清理旧镜像：docker image prune

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

docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once readarr

清理旧镜像：docker image prune

注意：不推荐使用Watchtower作为容器自动更新方案，长期建议使用Docker Compose。

镜像更新通知 - Diun（Docker Image Update Notifier）

推荐使用Diun接收更新通知。不建议使用自动更新容器的工具。

本地构建

如需本地修改镜像用于开发或自定义：

git clone [***]
cd docker-readarr
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/readarr:latest .

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

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

注册后，使用-f Dockerfile.aarch64指定架构Dockerfile。

版本历史

• 06.06.23：- 基于Alpine 3.18重新构建。
• 22.02.22：- 添加develop分支。
• 21.01.22：- 将nightly分支重新基于Alpine构建，弃用nightly-alpine分支。
• 21.01.22：- 移除chromaprint（不再是必需依赖）。
• 01.01.22：- 添加chromaprint用于音频指纹识别。
• 30.12.21：- 添加nightly-alpine分支。
• 28.07.21：- 初始发布。