Docker-Paperless-ngx(无纸化)

Paperless-ngx 是一个文档管理系统，可以将您的物理文档转换为可搜索的在线档案，这样您就可以减少纸张的使用

特点：
---
- 使用标签、联系人、类型等组织和索引扫描的文档。
- 对您的文档执行 OCR，将可选文本添加到仅图像文档，并向您的文档添加标签、通讯员和文档类型。
- 支持 PDF 文档、图像、纯文本文件和 Office 文档（Word、Excel、Powerpoint 和 LibreOffice 等同物）。
	- Office 文档支持是可选的，由 Apache Tika 提供（参见配置）
- 无纸化将您的文档直接存储在磁盘上。文件名和文件夹采用无纸化管理，格式可自由配置。
- 单页应用程序前端。
	- 包括一个显示基本统计数据并具有文档上传功能的仪表板。
	- 按标签、通讯员、类型等过滤。
	- 可自定义的视图可以保存并显示在仪表板上。
- 全文搜索可帮助您找到所需内容。
	- 自动完成会建议您文档中的相关词。
	- 结果按与您的搜索查询的相关性排序。
	- 突出显示向您显示文档的哪些部分与查询匹配。
	- 搜索类似文档（“更多类似文档”）
- 电子邮件处理：无纸化从您的电子邮件帐户添加文档。
	- 为每个帐户配置多个帐户和过滤器。
	- 当从邮件中添加文档时，无纸化可以将这些邮件移动到一个新文件夹中，将它们标记为已读、标记为重要或删除它们。
- 机器学习支持文档匹配。
	- Paperless-ngx 从您的文档中学习，一旦您以无纸化方式存储了一些文档，它将能够自动为文档分配标签、联系人和类型。
- 针对多核系统进行了优化：Paperless-ngx 并行处理多个文档。
- 集成的完整性检查器可确保您的文档存档处于良好状态。

相关链接：
---
GitHub：https://github.com/paperless-ngx/paperless-ngx
Docker：https://registry.hub.docker.com/r/paperlessngx/paperless-ngx
文档：https://docs.paperless-ngx.com/setup/
docker-compose.yml 示例：https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose
[额外语言包](https://packages.debian.org/search?suite=buster&section=all&arch=any&searchon=names&keywords=tesseract-ocr-)

## docker-compose
```bash
# 脚本一键安装
bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
```

```bash
mkdir {redis,db,data,media,export,consume}		# 创建所需文件夹
nano docker-compose.yml		# 编辑 docker-compose.yml
nano .env		# 编辑 .env,作为补充配置,可以整合在一起
docker-compose up -d		# 部署并启动服务

# 创建用户(二选一)
docker-compose exec webserver python3 manage.py createsuperuser		# 连接容器并执行创建账户
docker-compose exec webserver bash		# 进入容器
	python3 manage.py createsuperuser		# 创建账户
```

`docker-compose.yml`
```yaml
version: "3.4"
services:
  # 部署redis
  broker:
    image: docker.io/library/redis:7
    restart: unless-stopped
    volumes:
      - ./redis:/data
  # 部署数据库
  db:
    image: docker.io/library/mariadb:10
    restart: unless-stopped
    volumes:
      - ./db:/var/lib/mysql
    environment:
      MARIADB_HOST: paperless
      MARIADB_DATABASE: paperless  # 数据库名
      MARIADB_ROOT_PASSWORD: paperless  # 数据库ROOT用户密码
      MARIADB_USER: paperless  # 数据库用户名
      MARIADB_PASSWORD: paperless  # 数据库用户密码
  # paperless-ngx 主服务
  webserver:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    restart: unless-stopped
    depends_on:  # 在以下服务启动后启动
      - db
      - broker
      - gotenberg
      - tika
    ports:
      - "8008:8000"  # 对外开放端口,可以配合下方修改默认内部端口
    healthcheck:
      # test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]  # SQLite
      test: ["CMD", "curl", "-f", "http://localhost:8000"]  # 可以修改指定端口
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - ./data:/usr/src/paperless/data  # 所有数据(搜索索引/SQLite/数据库/分类模型等)
      - ./media:/usr/src/paperless/media  # 文档和缩略图
      - ./export:/usr/src/paperless/export
      - ./consume:/usr/src/paperless/consume  # 文档存放位置,放入的会自动识别
    env_file: .env  # 其他附加配置
    environment:
      PAPERLESS_REDIS: redis://broker:6379  # 连接 Redis
      # 配置数据库,不配置则使用SQLite
      PAPERLESS_DBENGINE: mariadb  # 指定使用 MariaDB
      PAPERLESS_DBHOST: db  # 连接容器
      PAPERLESS_DBUSER: paperless  # 数据库用户名
      PAPERLESS_DBPASS: paperless  # 数据库用户密码
      PAPERLESS_DBPORT: 3306  # 数据库端口
      # 以下为启用 gotenberg/tika 为 Office文档 提供支持,不需要则禁用
      PAPERLESS_TIKA_ENABLED: 1
      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
      PAPERLESS_TIKA_ENDPOINT: http://tika:9998

# 以下为配置 gotenberg/tika 为 Office文档 提供支持,不需要则禁用
  gotenberg:
    image: docker.io/gotenberg/gotenberg:7.8
    restart: unless-stopped
    command:
      - "gotenberg"
      - "--chromium-disable-javascript=true"
      - "--chromium-allow-list=file:///tmp/.*"
  tika:
    image: ghcr.io/paperless-ngx/tika:latest
    restart: unless-stopped
```
`.env`
```env
# Paperless容器中运行的用户的UID和GID.将其设置为主机上您的UID和GID,以便您可以写入
USERMAP_UID=1000
USERMAP_GID=1000

# 安装的文本识别的其他语言,默认情况下,容器安装英语、德语、意大利语、西班牙语和法语.
# 请参阅 https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster 获取可用语言.
# 注意格式,比如安装 tesseract-ocr-chi-sim 语言,则设置为 chi-sim,多语言中间用 空格 隔开
PAPERLESS_OCR_LANGUAGES=chi-sim chi-sim-vert chi-tra chi-tra-vert

# 如果您将公开Paperless-ngx,则需要此设置. (如果这样做,请考虑反向代理等安全措施)
#PAPERLESS_URL=https://blynk.space:8008

# 如果您计划公开Paperless,请调整此密钥.它应该是一个非常长的随机字符序列.您不需要记住它.
PAPERLESS_SECRET_KEY=change-me

# 使用此变量为Paperless Docker容器设置时区.如果未指定,则默认为UTC.
PAPERLESS_TIME_ZONE=Asia/Shanghai

# OCR使用的默认语言.将其设置为大多数文档所写的语言.
# 注意格式,比如使用 tesseract-ocr-chi-sim 作为默认语音,则需设置为 chi_sim
PAPERLESS_OCR_LANGUAGE=chi_sim

# 文件归档样式(允许文件夹),详情查看 https://docs.paperless-ngx.com/advanced_usage/#file-name-handling
# 示例:年份/用户名/文档标题
#PAPERLESS_FILENAME_FORMAT={created_year}/{correspondent}/{title}

# 如果通过域子路径访问paperless（例如 https://domain.com/PATHPREFIX）并使用像traefik或nginx这样的反向代理
#PAPERLESS_FORCE_SCRIPT_NAME=/PATHPREFIX
#PAPERLESS_STATIC_URL=/PATHPREFIX/static/  # 必须有斜杠
```