Paperless-ngx 高级用法：从自动匹配到扫描归档与扩展集成-未完纪

原文：Paperless-ngx 文档贡献者，Advanced Topics。本文依据 2026-10-05 读取的 main 分支完整正文翻译整理，源文件 blob 为 661c2d7044ff13faf7cd909669144931123d5a3e。main 持续变化，新功能是否可用应按实际安装版本核对。本文没有执行消费、脚本、SQL、认证或加解密测试。

Paperless 的自动化不仅是 OCR。它还可以根据正文分配标签与路径，在消费前后调用脚本，用条码分隔扫描件，拼合单面 ADF 的两次扫描，并接入外部身份与加密邮件。首先应分清修改边界：消费前处理工作副本，消费后不要绕过应用直接修改归档文件。

未完纪原创技术示意：消费修改边界与双面扫描顺序，非运行截图。

匹配标签、往来单位、类型和路径

Paperless 将标签、往来单位（correspondent）、文档类型和存储路径的匹配规则与正文比较。比如标签 Home Utility 设置匹配文本 bc hydro、算法 Exact，只要新文档包含该片段，就会自动获得标签。规则在网页界面配置，再用代表性文档核对结果。

算法	行为
None	不匹配。
Any	给定词中的任一词出现即可。
All	每个词都出现，顺序不限。
Exact	给定片段按原顺序出现。
Regular expression	把匹配文本当正则表达式搜索。
Fuzzy match	使用 partial ratio 寻找局部近似匹配。
Auto	根据既有文档学习分配，无需提供匹配文本。

Any / All 中的多词短语可以放在双引号内。"Bank of America" BofA 配合 Any 匹配完整短语或缩写，不会仅因出现 “Bank of South America” 就命中。文本、OCR 质量、正则复杂度都会影响结果。

Auto 从什么内容学习

Auto 使用神经网络学习既有归类。例如某账户的对账单都带 bofa123 标签，并把标签设为 Auto，模型便尝试从账户号和银行名称等内容中学习。

归类修改不会立即体现在模型中；系统定期检查变化并训练，原文默认每小时一次。
带任一收件箱标签的文档不参加训练，避免把尚未整理的内容当成可靠标注。
类别要与正文相关。银行账户通常有文本依据，TODO 这种工作状态往往没有。
需要足够正例：千份文档中只出现一次的往来单位很难学好。
还需要负例：若库里只有 Webshop 和 Bank，且二者都启用 Auto，新文档也可能被硬分到这两类。

可选 AI：建议、相似文档与聊天

当前 main 包含 LLM 辅助建议、相似文档检索和文档聊天。它们默认关闭，不会取代内置的非 LLM 匹配与建议。启用后会把文档内容及元数据发给配置的模型后端；远程后端意味着内容离开服务器，也可能产生费用。可选择本地 Ollama 或自托管兼容网关，但仍应核对实际网络端点。

AI 参数可用 PAPERLESS_AI_* 环境变量或 Settings → Application Configuration 配置，数据库设置优先。至少需要 PAPERLESS_AI_ENABLED、PAPERLESS_AI_LLM_BACKEND、PAPERLESS_AI_LLM_MODEL。后端支持 ollama 与 openai-like；Ollama 需要 PAPERLESS_AI_LLM_ENDPOINT，OpenAI 兼容后端通常还需要 PAPERLESS_AI_LLM_API_KEY 与 / 或 endpoint。不要把真实 key 放进公开配置。

文档详情中的 Suggest 可请求标题、标签、往来单位、类型、存储路径与日期建议，经典分类器建议仍在。原文同时说明，打开带收件箱标签的文档会自动请求建议，除非关闭 Settings → Documents 的 “Automatically request suggestions for inbox documents”。因此不能理解为只有手动点 Suggest 才外发内容。PAPERLESS_AI_LLM_OUTPUT_LANGUAGE 控制输出语言，否则跟随界面语言。

配置 PAPERLESS_AI_LLM_EMBEDDING_BACKEND 可开启 RAG 向量索引，支持本地 huggingface，或 ollama / openai-like。必须同时启用 AI 和嵌入后端才建立索引。本地 Hugging Face 模型首次使用仍需联网下载到 data 目录。索引按 PAPERLESS_LLM_INDEX_TASK_CRON 更新，默认每天；可按官方管理说明重建或压缩。

相似文档可为建议提供上下文，顶部聊天控件按当前视图针对单份或多份文档回答，并附来源链接。文档内容必须当成不可信数据，不能执行检索材料里的指令。默认允许 AI endpoint 解析到私网与回环地址，以支持本地后端；PAPERLESS_AI_LLM_ALLOW_INTERNAL_ENDPOINTS=false 可阻止这类地址，也会影响相应本地服务。应限制端点配置权限，核对模型、数据许可及外发边界。

消费前后脚本

把脚本放在 Paperless 可读可执行的位置，在 paperless.conf 或 docker-compose.env 中设置 PAPERLESS_PRE_CONSUME_SCRIPT / PAPERLESS_POST_CONSUME_SCRIPT。钩子是阻塞执行，长任务会拖慢消费。原文提到脚本可自行派生异步进程，但生命周期、错误和资源限制也需自行处理。

消费前只改工作副本

脚本在发现新文件后、正式处理前执行，获得 DOCUMENT_SOURCE_PATH（源文件）、DOCUMENT_WORKING_PATH（消费工作副本）和存在时的 TASK_ID。修改源文件可能再触发一次消费，使两个任务争用同一路径；非确定性地改写副本也可能影响去重，让重复内容入库。

原文 OCR 示例未给路径变量加引号，会发生 shell 分词与通配符展开。以下为编辑修正版：增加必要变量检查和引号。它仍依赖外部 pdf2pdfocr，并不表示本文验证过该工具的安装或效果。

#!/usr/bin/env bash
set -eu
: "${DOCUMENT_WORKING_PATH:?Paperless working path is required}"
pdf2pdfocr.py -i "${DOCUMENT_WORKING_PATH}"

PAPERLESS_PRE_CONSUME_SCRIPT="/usr/local/bin/ocr-pdf"

未引号变量的问题是参数分裂和通配展开；普通变量值里的分号不会在这一命令中被 shell 二次解析，不应将它夸大成已证实的任意命令执行。脚本标准输出、标准错误和退出码都会逐行进入 Web 服务日志。

消费后读取结果，不改归档文件

成功消费并移入库后，可用信息如下：

环境变量	信息
`DOCUMENT_ID`、`DOCUMENT_FILE_NAME`	数据库主键、不含目录的格式化文件名。
`DOCUMENT_TYPE`	文档类型。
`DOCUMENT_CREATED`、`DOCUMENT_MODIFIED`、`DOCUMENT_ADDED`	创建、修改、加入库的日期时间。
`DOCUMENT_SOURCE_PATH`、`DOCUMENT_ARCHIVE_PATH`、`DOCUMENT_THUMBNAIL_PATH`	原文档、生成归档（若有）、缩略图路径。
`DOCUMENT_DOWNLOAD_URL`、`DOCUMENT_THUMBNAIL_URL`	下载与缩略图地址。
`DOCUMENT_OWNER`、`DOCUMENT_CORRESPONDENT`、`DOCUMENT_TAGS`	所有者、往来单位、逗号分隔的标签（若有）。
`DOCUMENT_ORIGINAL_FILENAME`、`TASK_ID`	输入文件名、存在时的任务 UUID。

原文嵌入的 scripts/post-consumption-example.sh 已另行读取：它把 ID、名称、路径、日期、所有者、往来单位、标签和 URL 等全部 echo 到日志。它不修改文件，但可能泄露文档元数据。若只需完成信号，可用这个编辑新增的缩减示例：

#!/usr/bin/env bash
printf 'Consumed document ID: %s\n' "${DOCUMENT_ID:-unknown}"

消费后钩子不能撤销已经完成的消费，也不能直接改归档文件。后续修改应经过受支持的应用机制，避免让文件、校验和与数据库失去一致。

Docker 挂载与排障

脚本须挂入容器，变量填写容器内路径。下例在原文基础上增加只读挂载，须合并进现有服务：

services:
  webserver:
    volumes:
      - /home/paperless-ngx/scripts:/path/in/container/scripts:ro
    environment:
      PAPERLESS_POST_CONSUME_SCRIPT: /path/in/container/scripts/post-consumption-example.sh

在项目目录运行 docker compose logs -f 可观察日志。遇权限错误要核对运行身份、目录及执行位；原文的 sudo chmod 755 post-consumption-example.sh 会允许其他用户读取执行，不适合含秘密脚本。原文还举例把 DOCUMENT_ID 通过 tee 追加到日志；实际应限制日志字段、访问与保留期限。

文件名与存储路径

默认文档保存在 media 目录，用标识符命名，如 0000123.pdf。可用 PAPERLESS_FILENAME_FORMAT 或 Storage Path 改变布局，扩展名由 Paperless 自动添加。存在文件版本时遵循同一规则，另加 _v1、_v2 等后缀。

PAPERLESS_FILENAME_FORMAT={{ created_year }}/{{ correspondent }}/{{ title }}

它可生成 2020/My bank/Statement January.pdf 等结构。不要手工移动 media 文件：数据库记着上次位置，直接改名会被报告为缺失。保存文档时会检查文件名；修改或删除 Storage Path 会反映到磁盘。改变全局格式后，则需按document renamer处理已有文档。

变量	含义
`asn`、`correspondent`、`document_type`	归档序号、往来单位、类型；缺失时为 none。
`tag_list`、`title`	逗号分隔标签、标题。
`created`、`added`	创建与加入日期的 ISO 表示。
`created_year`、`created_year_short`、`created_month`、`created_day`	创建日期的四位年、两位年、两位月、两位日。
`created_month_name`、`created_month_name_short`	按 locale 得到的完整 / 缩写月份名称。
`added_year`、`added_year_short`、`added_month`、`added_day`、`added_month_name`、`added_month_name_short`	加入日期的同类字段。
`owner_username`、`original_name`、`doc_pk`	所有者用户名、去除扩展名的原名、文档主键；前两项缺失时为 none。

变量用 {{ variable }} 引用。标题中的某些非法文件名字符（例如冒号和路径分隔符）会改为连字符。重名时追加 _01、_02；版本文件追加在版本后缀后，如 statement_v2_01.pdf。格式错误退回默认命名；标签等内容使路径超长时，会保留旧路径并记录错误。

PAPERLESS_FILENAME_FORMAT_REMOVE_NONE 可让缺失变量变成空串，移除其前面的空格并省略空目录。原文警告，含 ../ 的模板可能指向 media 外部；Docker 中若超出持久卷，重启后可能丢失。不要把这种写法当作推荐存储方案。

Storage Path 允许每份文档采用不同模板，可由匹配规则分配并人工覆盖，未指定时用全局格式。例如普通通信按年份 / 往来单位组织，保险文件放进固定目录：

{{ created_year }}/{{ correspondent }}/{{ title }}
Insurances/{{ correspondent }}/{{ created_year }}-{{ created_month }}-{{ created_day }} {{ title }}

Jinja 模板与自定义过滤器

模板支持条件与过滤器，可输入多行，最后渲染成单行路径。受限的 document 对象包含 id、pk、title、content、page_count、created、added、modified、mime_type、checksum、archive_checksum、archive_serial_number、filename、archive_filename、original_filename；关联值提供有限字段，如 document.correspondent.name。

tag_name_list 是按名称排序的标签列表，不是字符串；custom_fields 映射字段名称、类型和值。get_cf_value 必须接收该映射，可提供字段缺失或无值时的默认值，返回字符串或 None。名称有空格时尤应使用它：

{{ custom_fields | get_cf_value('department') }}
{{ custom_fields | get_cf_value('phone', 'Not provided') }}
invoices/{{ custom_fields | get_cf_value('Invoice Number') }}

也可先查存在性，再访问普通字段：

{% if 'Invoice' in custom_fields %}
  invoices/{{ custom_fields.Invoice.value }}
{% else %}
  not-invoices/{{ title }}
{% endif %}

datetime 接受日期时间对象或可解析字符串，采用 Python strftime；localize_date 采用 Babel 的 locale 与模式，可接收日期、带时区日期时间或 ISO 字符串，通常使用 document.created。两套模式不能混用：

{{ created | datetime('%Y-%m-%d') }}
{{ custom_fields | get_cf_value('Date Field', '2024-01-01') | datetime('%Y') }}
{{ document.created | localize_date('medium', 'en_US') }}
{{ document.created | localize_date('dd/MM/yyyy', 'en_GB') }}
{{ title | slugify }}

short、medium、long、full 逐步增加细节；以 2024-01-15 英文日期为例，依次类似 1/15/24、Jan 15, 2024、January 15, 2024，以及包含星期的完整日期。法语和德语 medium 示例分别是 15 janv. 2024、15.01.2024。更多模式见 Python 和 Unicode 日期格式。

按 MIME 类型分目录的原文例子：

{% if document.mime_type == 'application/pdf' %}
  pdfs
{% elif document.mime_type == 'image/png' %}
  pngs
{% else %}
  others
{% endif %}
/{{ title }}

原文 ASN 区间例子在 0–200 分支和末尾重复放入标题，可能产生重复层级，且未处理空 ASN。以下编辑修正版只在末尾放一次标题并增加空值分支，未执行验证：

somepath/
{% set n = document.archive_serial_number %}
{% if n is not none and n >= 0 and n <= 200 %}
  asn-000-200
{% elif n is not none and n >= 201 and n <= 400 %}
  asn-201-400
  {% if n < 300 %}/asn-2xx{% elif n < 400 %}/asn-3xx{% endif %}
{% else %}
  unclassified
{% endif %}
/{{ title }}

ASN 205 / 355 分别进入 asn-2xx / asn-3xx。原文发票例把 Date Field 拆成年/月/日，再将 Select Field 与去掉连字符的日期拼入名称。因为扩展名由应用添加，本文保留无手工 .pdf 后缀的写法，避免把该局部示例推广到其他类型。模板应由可信管理员维护，文档内容不得直接当作模板代码。

PDF 恢复、Celery 监控与启动脚本

遇到某些损坏或 MIME 识别异常的 PDF，Paperless 尝试先用 qpdf 清理；不代表能修复所有文件，也不能替代扫描源备份。

Flower 可查看 Celery 的运行、排队、完成任务和耗时，并导出 Prometheus 指标。使用 PAPERLESS_ENABLE_FLOWER 启用，进一步配置放在 src/paperless/flowerconfig.py。原文示例直接发布 5555 端口，却未展示认证。以下编辑修正版只把监听收窄至宿主回环；它不是完整访问控制：

services:
  webserver:
    environment:
      - PAPERLESS_ENABLE_FLOWER
    ports:
      - "127.0.0.1:5555:5555"
    volumes:
      - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro

Docker 允许把 shell 脚本目录挂载到 /custom-cont-init.d，在 Web 服务启动完成前以root执行。目录须由 root 所有，权限为 a=rx，脚本只能让 root 写入；原文建议只读挂载。需要降权时用镜像内 gosu，优先于 sudo。错误可能影响功能或数据，应先禁用自定义脚本复现，再提交问题。

第三方解析器插件

解析器是通过 paperless_ngx.parsers entry point 注册的 Python 包，用于额外文件格式。官方不支持第三方插件问题，报告前须移除插件复现。

原文 Docker 方案是在 root 初始化脚本中运行 pip install my-paperless-parser-package；裸机则在 Paperless 使用的 Python 环境内安装，比如 sudo -Hu paperless pip3 install my-paperless-parser-package，或激活环境后使用 uv pip install / pip install。这些是示例包名，本文没有验证对应插件。

静态审核：启动时以 root 从网络安装未固定版本的包，会把供应链、网络故障和依赖变化引入启动过程。应核对来源、许可、版本和校验信息，优先在受控镜像构建阶段准备依赖。安装后重启所有服务，检查日志是否出现发现解析器的条目；否则核对安装环境和 pyproject.toml 的 entry point。本稿没有执行安装。

MySQL / MariaDB 注意事项

数据库接口没有直接切换 MySQL 大小写敏感性的选项。不区分大小写时，Name 与 NAME 标签被视为相同；区分后，搜索 invoice 可能找不到标题 Invoice。原文给出两种 DDL：

ALTER TABLE <table_name> CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
ALTER DATABASE <db_name> CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;

第一条转换已有表；第二条只设置新表默认值。尖括号要替换成经核对的标识符。这些操作会修改数据库，可能影响排序、唯一性、索引和锁定时间，先在备份副本验证。原文“MariaDB 10.4+”是历史功能下限，不表示该旧版目前仍受维护；也不应为旧系统退回 utf8mb3，原文说明它可能导致消费问题。

MySQL / MariaDB 默认未必装有时区信息，虽然某些镜像已处理。缺失可能导致日期查询异常。原文给出如下导入命令，应按数据库选择一条：

mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql -p
mariadb-tzinfo-to-sql /usr/share/zoneinfo | mariadb -u root mysql -p

它们写入系统时区表，-p 交互询问密码。不要把实际密码加进命令历史。本文没有连接数据库或执行 DDL。

条码：分隔、归档序号与标签

条码支持 PDF，TIFF 需启用 PAPERLESS_CONSUMER_BARCODE_TIFF_SUPPORT。识别库支持 EAN-13/UPC-A、UPC-E、EAN-8、Code 128、Code 93、Code 39、Codabar、Interleaved 2 of 5、QR Code、Data Matrix、Aztec、PDF417。Paperless 主要依据内容执行动作，不是码制本身决定动作。

用途	页面处理
普通分隔条码	默认丢弃含分隔码的页，从下一页开始新文档，适合专用 PATCH-T 隔页。
`PAPERLESS_CONSUMER_BARCODE_RETAIN_SPLIT_PAGES`	启用时保留分隔页，作为新文档第一页。
ASN 条码	整数内容可设为归档序号；同时启用分隔时，从当前页起新文档，并保留该页。
标签条码	默认只赋标签；开启 `PAPERLESS_CONSUMER_TAG_BARCODE_SPLIT` 后分隔并保留该页，每片只提取自己的标签。

标签解析由 PAPERLESS_CONSUMER_ENABLE_TAG_BARCODE、PAPERLESS_CONSUMER_TAG_BARCODE_MAPPING 等设置控制，可与 ASN 一起使用。原文例子是六页扫描：第 3 页有 TAG:invoice，第 5 页有 TAG:receipt，结果是 1–2 页无标签、3–4 页为 invoice、5–6 页为 receipt。分隔页可能被丢弃，不能把重要内容页未经核对就当隔页；保留原扫描并先做样本验证。

单面 ADF 的双面拼页

原生双面扫描仪无需此功能；它默认关闭。对单面 ADF，可把两次扫描自动交错成完整文档。

源文的完整双面扫描步骤如下；当前配置参考同时要求启用 PAPERLESS_CONSUMER_RECURSIVE 与 PAPERLESS_CONSUMER_ENABLE_COLLATE_DOUBLE_SIDED，并确认目录不会自动创建。

三张纸六页，先从第 1 页开始扫描，得到 1、3、5。
把第一份扫描送到指定消费子目录，默认 double-sided，该目录须自己创建；Paperless 将它移到内部暂存区。
整叠翻面、不重排纸张，再扫描得到 6、4、2；确保第一份已被消费，再送入第二份。
Paperless 反转第二次页序，交错得到 1–6，再按常规消费。

可以省略末尾空白页，如第 6 页，但不能省中间空白页。第一次奇数页数少于第二次时，系统删除暂存副本及该扫描并报错，要求重新开始。两份必须按序、逐份消费，上传时服务须运行。

若使用轮询，间隔应短于两次扫描到达的间隔，原文建议 5–10 秒或更短。正文简写 CONSUMER_POLLING_INTERVAL；已核对当前官方配置，完整变量为 PAPERLESS_CONSUMER_POLLING_INTERVAL：0 默认使用文件系统通知，正数为轮询秒数。旧版变量不同，应按安装版本核对。

第一份只暂存最多 30 分钟，超时丢弃，下个文件会被当新奇数页。结合“子目录作为标签”时，double-sided/foo/bar 与 foo/bar/double-sided 都会得到 foo、bar 标签，不含 double-sided。若双面拼页再接普通条码分隔，单面隔页背面可能残留为空白首页；原文建议隔页双面都印分隔码，使多余页按分隔规则移除。保留分隔页等设置也会影响结果。

SSO 与第三方认证

Paperless 自带 Django 认证，也支持 Remote User。相关配置是 PAPERLESS_ENABLE_HTTP_REMOTE_USER、PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME、PAPERLESS_LOGOUT_REDIRECT_URL。可信代理必须清理并重写身份头，同时阻止客户端绕过代理直连；原文只是配置入口，不是完整的安全代理方案。

2.5.0 起通过 django-allauth 支持外部登录及可选注册。已有用户先用普通凭据登录，再从 My Profile 关联外部账户。GitHub 例子载入 allauth.socialaccount.providers.github，在 PAPERLESS_SOCIALACCOUNT_PROVIDERS 的 github.APPS 配置 provider_id、名称、client_id 和 secret。

Keycloak OIDC 的原文结构如下，尖括号为占位配置：

PAPERLESS_APPS="allauth.socialaccount.providers.openid_connect"
PAPERLESS_SOCIALACCOUNT_PROVIDERS='{"openid_connect":{"APPS":[{"provider_id":"keycloak","name":"Keycloak","client_id":"paperless","secret":"<CLIENT_SECRET>","settings":{"server_url":"https://<KEYCLOAK_SERVER>/realms/<REALM>/.well-known/openid-configuration"}}]}}'

详见 allauth 提供商文档。真实 secret 要受控注入，不能提交公开仓库。PAPERLESS_DISABLE_REGULAR_LOGIN 可关闭普通登录，PAPERLESS_REDIRECT_LOGIN_TO_SSO 可自动跳转；先验证 SSO 和恢复路径，再改这些选项，避免管理员被锁在系统外。

消费前解密 GPG 邮件

源文要求主机已有 gpg-agent ≥ 2.1.1 并能用自己的 agent 解密邮件；这是功能下限，不是当前维护推荐。原文让使用者先以测试文件核对加解密：

gpg --encrypt --armor -r person@email.com name_of_file
gpg --decrypt name_of_file.asc
gpgconf --list-dir agent-socket

启用 PAPERLESS_ENABLE_GPG_DECRYPTOR，用最后一条命令定位实际 socket，并找到公钥环。Docker 原例把公钥环挂到 /usr/src/paperless/.gnupg/pubring.gpg，socket 挂到 /usr/src/paperless/.gnupg/S.gpg-agent。pubring.gpg 是该示例环境的布局，现代 GnuPG 不一定相同，不应盲目复制。

裸机通常不需额外配置，可用 PAPERLESS_EMAIL_GNUPG_HOME 指定独立目录。排障时检查主机 agent、容器可访问性、加解密结果和文件权限；原例目录 0700，socket 与公钥环 0600。

静态审核：挂载 agent socket 是向容器授予相应解密能力通道，不是只提供无害的公钥。应限定容器、身份和权限，考虑独立邮件密钥。本文没有访问个人 keyring、挂载 agent 或执行上述命令。

归属与许可：Paperless-ngx 文档贡献者，项目 GPL-3.0 完整许可见下方。本中文翻译与修改保留上游许可及归属；明确标注 shell、日志、挂载、Flower 与 ASN 模板修正，以及官方历史版本补核。配图由未完纪原创。

原文代码、模板与输出完整对照

以下保留原文片段，按原文顺序列出；中文解释及已标明的修订在正文。原例含未加引号的路径、宽泛Flower监听、重复标题模板、root安装与身份信任配置等风险，仅供对照。没有执行；占位符必须先按目标环境核查。

原文片段 1

#!/usr/bin/env bash
pdf2pdfocr.py -i ${DOCUMENT_WORKING_PATH}

原文片段 2

...
PAPERLESS_PRE_CONSUME_SCRIPT="/usr/local/bin/ocr-pdf"
...

原文片段 3

--8<-- "./scripts/post-consumption-example.sh"

原文片段 4

...
webserver:
  ...
  volumes:
    ...
    - /home/paperless-ngx/scripts:/path/in/container/scripts/ # (1)!
  environment: # (3)!
    ...
    PAPERLESS_POST_CONSUME_SCRIPT: /path/in/container/scripts/post-consumption-example.sh # (2)!
...

原文片段 5

PAPERLESS_FILENAME_FORMAT={{ created_year }}/{{ correspondent }}/{{ title }}

原文片段 6

2019/
  My bank/
    Statement January.pdf
    Statement February.pdf
2020/
  My bank/
    Statement January.pdf
    Letter.pdf
    Letter_01.pdf
  Shoe store/
    My new shoes.pdf

原文片段 7

    PAPERLESS_FILENAME_FORMAT=../../my/custom/location/{title}

原文片段 8

By Year = {{ created_year }}/{{ correspondent }}/{{ title }}
Insurances = Insurances/{{ correspondent }}/{{ created_year }}-{{ created_month }}-{{ created_day }} {{ title }}

原文片段 9

2019/                                   # By Year
   My bank/
     Statement January.pdf
     Statement February.pdf

Insurances/                             # Insurances
   Healthcare 123/
     2022-01-01 Statement January.pdf
     2022-02-02 Letter.pdf
     2022-02-03 Letter.pdf
   Dental 456/
     2021-12-01 New Conditions.pdf

原文片段 10

{{ custom_fields | get_cf_value('field_name') }}
{{ custom_fields | get_cf_value('field_name', 'default_value') }}

原文片段 11

<!-- Basic usage -->
{{ custom_fields | get_cf_value('department') }}

<!-- With default value -->
{{ custom_fields | get_cf_value('phone', 'Not provided') }}

原文片段 12

{{ datetime_value | datetime('%Y-%m-%d %H:%M:%S') }}

原文片段 13

<!-- Format datetime object -->
{{ created | datetime('%B %d, %Y at %I:%M %p') }}
<!-- Output: "January 15, 2024 at 02:30 PM" -->

<!-- Custom formatting -->
{{ custom_fields | get_cf_value('Date Field') | datetime('%A, %B %d, %Y') }}
<!-- Output: "Monday, January 15, 2024" -->

原文片段 14

{{ date_value | localize_date('medium', 'en_US') }}
{{ datetime_value | localize_date('short', 'fr_FR') }}

原文片段 15

<!-- Preset formats -->
{{ document.created | localize_date('short', 'en_US') }}
<!-- Output: "1/15/24" -->

{{ document.created | localize_date('medium', 'en_US') }}
<!-- Output: "Jan 15, 2024" -->

{{ document.created | localize_date('long', 'en_US') }}
<!-- Output: "January 15, 2024" -->

{{ document.created | localize_date('full', 'en_US') }}
<!-- Output: "Monday, January 15, 2024" -->

<!-- Different locales -->
{{ document.created | localize_date('medium', 'fr_FR') }}
<!-- Output: "15 janv. 2024" -->

{{ document.created | localize_date('medium', 'de_DE') }}
<!-- Output: "15.01.2024" -->

<!-- Custom patterns -->
{{ document.created | localize_date('dd/MM/yyyy', 'en_GB') }}
<!-- Output: "15/01/2024" -->

原文片段 16

somepath/
{% if document.archive_serial_number >= 0 and document.archive_serial_number <= 200 %}
  asn-000-200/{{title}}
{% elif document.archive_serial_number >= 201 and document.archive_serial_number <= 400 %}
  asn-201-400
  {% if document.archive_serial_number >= 201 and document.archive_serial_number < 300 %}
    /asn-2xx
  {% elif document.archive_serial_number >= 300 and document.archive_serial_number < 400 %}
    /asn-3xx
  {% endif %}
{% endif %}
/{{ title }}

原文片段 17

{% if document.mime_type == "application/pdf" %}
  pdfs
{% elif document.mime_type == "image/png" %}
  pngs
{% else %}
  others
{% endif %}
/{{ title }}

原文片段 18

{% if "Invoice" in custom_fields %}
  invoices/{{ custom_fields.Invoice.value }}
{% else %}
  not-invoices/{{ title }}
{% endif %}

原文片段 19

"invoices/{{ custom_fields|get_cf_value('Invoice Number') }}"

原文片段 20

invoices/
{{ custom_fields|get_cf_value("Date Field","2024-01-01")|datetime('%Y') }}/
{{ custom_fields|get_cf_value("Date Field","2024-01-01")|datetime('%m') }}/
{{ custom_fields|get_cf_value("Date Field","2024-01-01")|datetime('%d') }}/
Invoice_{{ custom_fields|get_cf_value("Select Field") }}_{{ custom_fields|get_cf_value("Date Field","2024-01-01")|replace("-", "") }}.pdf

原文片段 21

{{ title | slugify }}

原文片段 22

services:
  # ...
  webserver:
    environment:
      - PAPERLESS_ENABLE_FLOWER
    ports:
      - 5555:5555 # (2)!
    # ...
    volumes:
      - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro # (1)!

原文片段 23

services:
  # ...
  webserver:
    # ...
    volumes:
      - /path/to/my/scripts:/custom-cont-init.d:ro # (1)!

原文片段 24

#!/bin/bash
# /path/to/my/scripts/install-parsers.sh

pip install my-paperless-parser-package

原文片段 25

services:
  webserver:
    # ...
    volumes:
      - /path/to/my/scripts:/custom-cont-init.d:ro

原文片段 26

sudo -Hu paperless pip3 install my-paperless-parser-package

原文片段 27

uv pip install my-paperless-parser-package
# or
pip install my-paperless-parser-package

原文片段 28

Loaded third-party parser 'My Parser' v1.0.0 by Acme Corp (entrypoint: 'my_parser').

原文片段 29

PAPERLESS_APPS="allauth.socialaccount.providers.github"
PAPERLESS_SOCIALACCOUNT_PROVIDERS='{"github": {"APPS": [{"provider_id": "github","name": "Github","client_id": "<CLIENT_ID>","secret": "<CLIENT_SECRET>"}]}}'

原文片段 30

PAPERLESS_APPS="allauth.socialaccount.providers.openid_connect"
PAPERLESS_SOCIALACCOUNT_PROVIDERS='
{"openid_connect": {"APPS": [{"provider_id": "keycloak","name": "Keycloak","client_id": "paperless","secret": "<CLIENT_SECRET>","settings": { "server_url": "https://<KEYCLOAK_SERVER>/realms/<REALM>/.well-known/openid-configuration"}}]}}'

原文片段 31

gpg --encrypt --armor -r person@email.com name_of_file
gpg --decrypt name_of_file.asc

原文片段 32

gpgconf --list-dir agent-socket

原文片段 33

webserver:
  volumes:
    - /home/user/.gnupg/pubring.gpg:/usr/src/paperless/.gnupg/pubring.gpg
    - <path to gpg-agent socket>:/usr/src/paperless/.gnupg/S.gpg-agent

原文片段 34

paperless@9da1865df327:~/.gnupg$ ls -al
drwx------ 1 paperless paperless   4096 Aug 18 17:52 .
drwxr-xr-x 1 paperless paperless   4096 Aug 18 17:52 ..
srw------- 1 paperless paperless      0 Aug 18 17:22 S.gpg-agent
-rw------- 1 paperless paperless 147940 Jul 24 10:23 pubring.gpg

原文嵌入的消费后脚本

#!/usr/bin/env bash

echo "

A document with an id of ${DOCUMENT_ID} was just consumed.  I know the
following additional information about it:

* Generated File Name: ${DOCUMENT_FILE_NAME}
* Document type: ${DOCUMENT_TYPE}
* Archive Path: ${DOCUMENT_ARCHIVE_PATH}
* Source Path: ${DOCUMENT_SOURCE_PATH}
* Created: ${DOCUMENT_CREATED}
* Added: ${DOCUMENT_ADDED}
* Modified: ${DOCUMENT_MODIFIED}
* Thumbnail Path: ${DOCUMENT_THUMBNAIL_PATH}
* Download URL: ${DOCUMENT_DOWNLOAD_URL}
* Thumbnail URL: ${DOCUMENT_THUMBNAIL_URL}
* Owner Name: ${DOCUMENT_OWNER}
* Correspondent: ${DOCUMENT_CORRESPONDENT}
* Tags: ${DOCUMENT_TAGS}

"

GNU General Public License Version 3 全文

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The GNU General Public License is a free, copyleft license for
software and other kinds of works.

  The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.  We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors.  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

  To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights.  Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received.  You must make sure that they, too, receive
or can get the source code.  And you must show them these terms so they
know their rights.

  Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

  For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software.  For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

  Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so.  This is fundamentally incompatible with the aim of
protecting users' freedom to change the software.  The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable.  Therefore, we
have designed this version of the GPL to prohibit the practice for those
products.  If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.

  Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary.  To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

  The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 3 of the GNU General Public License.

  "Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

  "The Program" refers to any copyrightable work licensed under this
License.  Each licensee is addressed as "you".  "Licensees" and
"recipients" may be individuals or organizations.

  To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy.  The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

  A "covered work" means either the unmodified Program or a work based
on the Program.

  To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy.  Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

  To "convey" a work means any kind of propagation that enables other
parties to make or receive copies.  Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

  An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License.  If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

  1. Source Code.

  The "source code" for a work means the preferred form of the work
for making modifications to it.  "Object code" means any non-source
form of a work.

  A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

  The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form.  A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

  The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities.  However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work.  For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

  The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

  The Corresponding Source for a work in source code form is that
same work.

  2. Basic Permissions.

  All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met.  This License explicitly affirms your unlimited
permission to run the unmodified Program.  The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work.  This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

  You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force.  You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright.  Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

  Conveying under any other circumstances is permitted solely under
the conditions stated below.  Sublicensing is not allowed; section 10
makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

  No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

  When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

  4. Conveying Verbatim Copies.

  You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

  You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

  You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

  A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit.  Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

  6. Conveying Non-Source Forms.

  You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

  A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

  A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling.  In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage.  For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product.  A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

  "Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source.  The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

  If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information.  But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

  The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed.  Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

  Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

  7. Additional Terms.

  "Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law.  If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

  When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it.  (Additional permissions may be written to require their own
removal in certain cases when you modify the work.)  You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

  Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

  All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10.  If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term.  If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

  If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

  Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

  8. Termination.

  You may not propagate or modify a covered work except as expressly
provided under this License.  Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

  However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

  Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

  Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

  9. Acceptance Not Required for Having Copies.

  You are not required to accept this License in order to receive or
run a copy of the Program.  Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance.  However,
nothing other than this License grants you permission to propagate or
modify any covered work.  These actions infringe copyright if you do
not accept this License.  Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

  10. Automatic Licensing of Downstream Recipients.

  Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License.  You are not responsible
for enforcing compliance by third parties with this License.

  An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations.  If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

  You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License.  For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

  11. Patents.

  A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.  The
work thus licensed is called the contributor's "contributor version".

  A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version.  For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

  Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

  In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement).  To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

  If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients.  "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

  If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

  A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License.  You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

  Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

  12. No Surrender of Others' Freedom.

  If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all.  For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

  13. Use with the GNU Affero General Public License.

  Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work.  The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

  14. Revised Versions of this License.

  The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

  Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.

  If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

  Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    {one line to give the program's name and a brief idea of what it does.}
    Copyright (C) {year}  {name of author}

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

  If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

    {project}  Copyright (C) {year}  {fullname}
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".

  You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.

  The GNU General Public License does not permit incorporating your program
into proprietary programs.  If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library.  If this is what you want to do, use the GNU Lesser General
Public License instead of this License.  But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

文章版权归作者所有，未经允许请勿转载。

THE END

Paperless-ngx 高级用法：从自动匹配到扫描归档与扩展集成