lsiodev/paperless-ngx

linuxserver/paperless-ngx

https://github.com/paperless-ngx/paperless-ngx 是由Daniel Quinn及其贡献者开发的应用，用于索引扫描文档，支持轻松搜索文档并存储元数据。

!https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/paperless-ngx-banner.png

支持的架构

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

支持的架构：

应用设置

Web界面默认登录信息为 admin:admin，可通过 [***] 访问。更多信息请参见 https://github.com/paperless-ngx/paperless-ngx%E3%80%82

为方便使用，此容器提供管理命令别名。上游文档中记录的管理命令可通过以下方式访问：docker exec -it <容器名称> manage <命令>。例如：docker exec -it paperless manage document_retagger -tT。

使用方法

以下是帮助您创建容器的示例代码片段。

docker-compose（推荐，https://docs.linuxserver.io/general/docker-compose%EF%BC%89

yaml
---
version: "2.1"
services:
  paperless-ngx:
    image: docker.xuanyuan.run/linuxserver/paperless-ngx:latest
    container_name: paperless-ngx
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - REDIS_URL= #可选
    volumes:
      - /path/to/appdata/config:/config
      - /path/to/appdata/data:/data
    ports:
      - 8000:8000
    restart: unless-stopped

docker cli（https://docs.docker.com/engine/reference/commandline/cli/%EF%BC%89

bash
docker run -d \
  --name=paperless-ngx \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/New_York \
  -e REDIS_URL= `#可选` \
  -p 8000:8000 \
  -v /path/to/appdata/config:/config \
  -v /path/to/appdata/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/paperless-ngx:latest

参数

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

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

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

例如：

bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword

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

应用运行的Umask

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

用户/组标识符

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

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

在此示例中 PUID=1000 和 PGID=1000，要查找您的ID，请使用 id user：

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

Docker Mods

https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=paperless-ngx&query=%24.mods%5B%27paperless-ngx%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml](https://mods.linuxserver.io/?mod=paperless-ngx "查看此容器的可用mods") 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://mods.linuxserver.io/?mod=universal "查看可用的通用mods")

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

支持信息

• 容器运行时的Shell访问：docker exec -it paperless-ngx /bin/bash
• 实时监控容器日志：docker logs -f paperless-ngx
• 容器版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ngx
• 镜像版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ngx:latest

更新信息

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

以下是更新容器的说明：

通过Docker Compose

• 更新所有镜像：docker-compose pull
  • 或更新单个镜像：docker-compose pull paperless
• 让Compose按需更新所有容器：docker-compose up -d
  • 或更新单个容器：docker-compose up -d paperless
• 还可以删除旧的悬空镜像：docker image prune

通过Docker Run

• 更新镜像：docker pull docker.xuanyuan.run/linuxserver/paperless-ngx:latest
• 停止运行中的容器：docker stop paperless-ngx
• 删除容器：docker rm paperless-ngx
• 使用上述相同的docker run参数重新创建新容器（如果正确映射到主机文件夹，您的 /config 文件夹和设置将被保留）
• 还可以删除旧的悬空镜像：docker image prune

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

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

  bash
  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  docker.xuanyuan.run/containrrr/watchtower \
  --run-once paperless-ngx
  

• 还可以删除旧的悬空镜像：docker image prune

注意： 我们不支持将Watchtower用作现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但是，对于您忘记原始参数的容器，这是一个有用的一次性手动更新工具。长期来看，我们强烈建议使用 https://docs.linuxserver.io/general/docker-compose%E3%80%82

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

• 我们推荐 https://crazymax.dev/diun/ 用于更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如果您想为开发目的对这些镜像进行本地修改或自定义逻辑：

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

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

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

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

版本历史

• 16.05.22： - 为ARM构建添加正确的libqpdf.so。
• 14.05.22： - 优化Redis禁用逻辑。
• 12.05.22： - 将迁移移至multilangocr mod之后。修复Redis禁用问题。添加PostgreSQL的缺失依赖。
• 12.05.22： - 使用lsio wheel for pikepdf。
• 11.05.22： - 更新上游工件名称，并使用lsio wheels for scipy和scikit-learn。
• 05.05.22： - 为armhf添加运行时依赖libxslt1.1。
• 30.04.22： - 添加运行时依赖lizbar和poppler-utils。
• 27.04.22： - 为arm32构建添加构建依赖。
• 11.04.22： - 由于WebSocket问题，将uwsgi替换为gunicorn。
• 11.03.22： - 初始发布。