linuxserver/paperless-ng

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

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

应用概述

Paperless-ng是由Daniel Quinn及其贡献者开发的应用，它可以索引您的扫描文档，允许您轻松搜索文档并在文档旁存储元数据。

支持的架构

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

支持的架构：

应用设置

默认登录信息为admin:admin，通过Web界面访问，地址为[***]

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

使用方法

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

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

---
version: "2.1"
services:
  paperless-ng:
    image: lscr.io/linuxserver/paperless-ng:latest
    container_name: paperless-ng
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - REDIS_URL= #可选
    volumes:
      - </本地路径/appdata/config>:/config
      - </本地路径/appdata/data>:/data
    ports:
      - 8000:8000
    restart: unless-stopped

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

docker run -d \
  --name=paperless-ng \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/New_York \
  -e REDIS_URL= `#可选` \
  -p 8000:8000 \
  -v </本地路径/appdata/config>:/config \
  -v </本地路径/appdata/data>:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/paperless-ng:latest

参数

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

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

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

例如：

-e FILE__PASSWORD=/run/secrets/mysecretpassword

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

应用运行的Umask

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

用户/组标识符

使用卷（-v标志）时，主机操作系统和容器之间可能会出现权限问题。我们通过允许您指定用户PUID和组PGID来避免此问题。

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

在此示例中PUID=1000和PGID=1000，通过以下命令查找您的ID：

  $ id 用户名
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

我们发布了各种Docker Mods以启用容器内的额外功能。可通过上方动态徽章访问此镜像可用的Mods列表（如有）以及可应用于我们任何镜像的通用Mods。

支持信息

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

更新信息

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

以下是更新容器的说明：

通过Docker Compose

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

通过Docker Run

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

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

• 拉取其标签的最新镜像并在一次运行中替换具有相同环境变量的镜像：

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

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

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

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

• 我们推荐Diun用于更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

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

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

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

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

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

版本历史

• 30.11.21： 添加了jbig2enc。
• 07.10.21： 修复了确定是否应在本地运行redis的变量。
• 01.10.21： 由于websocket问题，将uwsgi替换为gunicorn。
• 24.07.21： 修复了目录配置文件（sqlite db）的存储位置。
• 23.07.21： 修复了初始用户创建。
• 10.07.21： 初始发布。