原文作者:Paperless-ngx 文档贡献者(页面无个人署名)。中文翻译与技术整理:未完纪。核验日期:2026-10-05。

Paperless-ngx 的维护围绕三件事展开:保存能够恢复的数据,按安装方式升级应用和数据库,以及在需要时修复索引、归档件和元数据。本文翻译整理官方 Administration 文档的全部维护主题。基准为 2026-10-05 读取的仓库 main 文档快照,而不是对任意旧版安装都有效的操作承诺。所有命令仅作静态说明。
备份:先停止文档消费,再选择备份边界
备份前应确认 Paperless 没有正在消费文档。通用方式是 document_exporter:它把文档、缩略图、元数据以及数据库内容导出到指定目录。导出既可用于把文档与设置恢复到全新 Paperless 实例,也可用于迁往另一套文档管理系统。导出器能够更新已有导出,因此可以与 rsync 等方式组成增量备份流程。
API token 不包含在导出中,导入后需要重新生成。导出同时包含数据库的精确结构与内容,数据库迁移会改变布局,因此恢复应匹配导出时的应用版本。原文备份段使用严格的跨版本禁止表述,导入段又说明旧版导出“可能可用”;本文取保守的共同边界:不要把跨版本导入当作受保证的恢复方案,先在相同应用版本恢复,再按升级流程迁移。
| 安装方式/数据卷 | 需要保存的内容 |
|---|---|
| 所有安装方式 | document_exporter 输出目录或 ZIP;同时记录应用版本、配置与部署方式,后者是编辑补充的恢复前提。 |
| Docker:paperless_media | 文档文件。 |
| Docker:paperless_data | 辅助数据;使用 SQLite 时,数据库也在这里。 |
| Docker:paperless_pgdata | 仅使用 PostgreSQL 时存在,包含数据库。 |
| Docker:paperless_dbdata | 仅使用 MariaDB 时存在,包含数据库。 |
| 裸机或非 Docker | 完整 Paperless 目录;使用 PostgreSQL 或 MariaDB 时还要另行备份数据库。 |
Docker 卷通常位于宿主机 /var/lib/docker/volumes,需要相应权限才能访问。直接备份运行中的数据库文件不等于一致性备份;编辑补充建议结合数据库官方备份流程处理,而不是仅复制一个正在变化的目录。恢复时,如果采用导出器备份,就使用导入器;如果采用卷、文件夹与数据库副本,就必须把对应部分一并恢复。
升级应用:容器与裸机有不同路径
升级前先阅读对应版本发布说明,确认没有文档消费等活动进程,并完成可恢复的备份。当前文档特别要求:升级 Paperless-ngx v3.0 前先阅读 migration-v3.md,部分不兼容变化需要手动处理;升级 v3 会清空已有任务历史,过去完成、失败或已确认任务不再显示在任务列表里。原文说这项清理本身不需要额外操作,但需要把变化告知运维和使用者。
Docker Compose 安装首先停止服务,下面的路径需要替换为部署目录。down 会中断服务,不应作为无影响检查来执行;示例没有加会删除数据卷的 -v。
cd /path/to/paperless
docker compose down
如果使用发布镜像,原文接下来执行:
docker compose pull
docker compose up
如果自行构建镜像,原文路径是先 git pull,再 docker compose build,最后 docker compose up。启动时也会应用新的数据库迁移。确认启动日志与功能符合预期后,可以按一次 Ctrl+C 正常停止,再用 docker compose up -d 放到后台运行。本文没有运行或确认这些步骤成功。
镜像标签需要单独管理。原文 Compose 文件使用 latest 指向最新稳定版,但它是可移动目标;编辑建议在实际变更中选择已经审阅发布说明的明确版本或镜像摘要,并保存旧配置以便评估回退。数据库迁移可能限制直接回退,不能只凭旧镜像还在就承诺可恢复。
历史说明:0.9.13 及更早 Compose 文件固定 0.9.x,单独 pull 不会自动切到新版本;0.9.14 调整过这一流程。1.7.1 起镜像可固定一个发行系列,原文举 1.7 为例,便于只跟进该系列修复版。1.7 是历史例子,不是本文推荐的当前目标版本;即使使用自动更新器,仍应先读发布说明。
裸机升级时,直接把新压缩包覆盖解压到旧目录,只会新增或覆盖文件,不会删除新版已经移除的旧文件。遗留数据库迁移可能导致 manage.py migrate 出现 NodeNotFoundError。原文允许先移除旧源码、保留 media、data、consume 与 paperless.conf/.env;本文采用其另一条更易审查的路径:解压到全新目录,再迁移持久数据与配置。这里不提供递归删除命令。干净 Git checkout 上的 git pull 会处理上游已删除文件,不属于同一覆盖解压问题。
裸机后续步骤依次为:核对新增的系统依赖;激活项目虚拟环境并更新 requirements;迁移数据库;按需要重建搜索索引;按需要迁移 LLM 索引。依赖列表也可能删掉旧包,应比较版本并在受控环境清理无用依赖。原文命令如下,每条都应在正确目录和运行账户下使用:
pip install -r requirements.txt
# 以下命令在 Paperless 的 src 目录执行
python3 manage.py migrate
python3 manage.py document_index reindex --if-needed
python3 manage.py document_llmindex migrate
有些部署需要以 Paperless 服务账户执行,即原文的 sudo -Hu <paperless_user> 方式。不是每次更新都会发生数据库迁移。当前文档说明,搜索索引或 LLM 索引模式已是最新时,对应按需命令不会再做工作;这不意味着所有旧版本都已有这些命令。
升级数据库:应用版本与路径保持一致
Paperless-ngx 与 Django 所支持的 PostgreSQL、MariaDB 版本相适配。数据库大版本升级仍要先备份,并按数据库本身的升级文档处理。原文注明从 Paperless-ngx v2.18 起,PostgreSQL 最低支持版本为 14;具体目标版本还需与实际应用依赖核对。
也可以在新版 PostgreSQL 或 MariaDB 中创建新数据库,借助导出器与导入器的 –data-only 选项只搬迁数据库内容。做这类迁移时,不应顺便改变应用设置,尤其不能更改文档路径,否则存在数据丢失风险。数据模式必须与应用版本相容;数据库引擎升级不是任意跨应用版本导入的豁免。
管理命令的三种入口
下文命令名需要通过安装方式对应的入口运行。Docker 和 Compose 的 exec 方式要求 Paperless 容器正在运行;裸机方式从 src 目录调用 manage.py。所有命令都提供 –help,参数应以实际安装版本的帮助为准。
# Docker Compose
docker compose exec webserver <command> <arguments>
# 单独 Docker 容器
docker exec -it <container-name> <command> <arguments>
# 裸机:在 src 目录
python3 manage.py <command> <arguments>
在 cron 等无交互终端环境中,Compose 的 exec 后可以加 -T,避免 “The input device is not a TTY” 错误。例如:
docker compose exec -T webserver document_exporter ../export
document_exporter:输出内容和增量行为
target 是导出的目标目录,其中包括文档、缩略图以及 manifest.json;manifest 保存联系人、标签等数据库元数据。使用官方 Compose 配置时,容器中的 ../export 对应宿主机 export 目录,但自定义挂载不一定相同,应先核对。
目标目录已有文件时,导出器会把它当作以前的导出并尝试更新,默认根据修改时间与大小判断文档是否变化,只输出新增与变化文件。-c/–compare-checksums 改为比较校验和,更慢但可避免仅依赖文件属性。manifest 和元数据 JSON 默认总会更新;-cj/–compare-json 可启用相应 JSON 比较。
| 选项 | 行为与边界 |
|---|---|
| -d / –delete | 删除导出目录内不属于当前导出的旧文件,包括已删除文档对应文件。默认不删除。不能指向混有其他文件的目录;本文日常备份示例不启用。 |
| -f / –use-filename-format | 按 PAPERLESS_FILENAME_FORMAT 命名;默认格式为 [创建日期] [联系人] [标题].[扩展名]。过长路径可能触及操作系统限制。 |
| -na / –no-archive | 只导出原件,不导出归档件。 |
| -nt / –no-thumbnail | 不导出缩略图。 |
| -p / –use-folder-prefix | 按 archive、originals、thumbnails、json 分目录保存。 |
| -sm / –split-manifest | 逐文档信息拆到独立 JSON;manifest.json 仍保留标签、联系人、文档类型等全局信息。 |
| -z / –zip;-zn / –zip-name | 在目标目录生成 ZIP,默认按当前本地日期命名,也可指定名称。 |
| –zip-compression;–zip-compression-level | 需要与 –zip 一起使用。可选 stored、deflated(默认)、bzip2、lzma、zstd;级别范围分别为 deflated 0–9、bzip2 1–9、zstd -22–22,stored 与 lzma 忽略级别。 |
| –data-only | 仅导出数据库,主要用于数据库升级时保留原有媒体目录。 |
| –no-progress-bar | 隐藏进度条,适合脚本与定时任务。 |
| –passphrase | 对导出中的特定字段加密,导入时需要同一口令;丢失口令会导致无法导入。它不表示整个文档备份都已加密。 |
省略归档件或缩略图可以减少某些去重备份中的额外空间,因为生成算法变化后这些派生文件及其校验和可能改变。代价是导入后完整性检查会报告它们缺失,直到用 document_thumbnails 或 document_archiver 重新生成。原件不应因此省略。
zstd ZIP 要求导出端和导入端都使用 Python 3.14 或更高版本。对于 zstd、或缺少对应模块时的 lzma/bzip2,导入运行时若没有解码器就不能读取,导入器会拒绝。默认 deflated 的兼容性更广。口令不应写成硬编码常量或展示到公开命令记录中;备份应另外采用适合环境的访问控制或整包加密。这些是基于导出包含敏感内容的编辑补充。
document_importer:恢复到空实例
导入器接收导出目录或生成的 ZIP 文件:
document_importer source
source 为必填来源。可选 –no-progress-bar 隐藏进度,–data-only 只导入数据库而不导入文档与缩略图,–passphrase 用于匹配加密导出。–batch-size 默认 500,代表每批插入的数据库记录数;超大实例可以降低它以减少峰值内存。
使用官方 Compose 配置时,将导出放到 Paperless 源目录的 export 文件夹,再以 ../export 为 source。普通导入必须面向数据库和目录都完全为空的实例;仅数据导入则至少要求数据库为空。这不是对已有实例的合并命令,不能直接拿生产库试导入。恢复应优先匹配原应用版本,并在恢复后重建需要的 API token。
重新匹配元数据与训练分类器
添加标签、联系人或更改匹配规则后,可以让 document_retagger 用新规则重新处理已有文档。-c/–correspondent、-T/–tags、-t/–document_type、-s/–storage_path 可组合使用;一个也不选,命令不会做事。-i/–inbox-only 只处理带收件箱标签的文档,–id-range 1 100 将范围缩小到指定 ID 区间,可用于先核查一小部分。
同一文档匹配多个联系人或文档类型时,默认不会为其选择其中一个;–use-first 会改为采用找到的第一项。这个选项不限制标签,因为文档可以有多个标签。默认会保留已有联系人和类型;-f/–overwrite 允许覆盖。对标签而言,默认只增加匹配标签,不移除旧标签;加 -f 后,不再匹配的标签也会被移除。范围限制仍会修改文档,不能误称为 dry-run。
Auto 自动匹配算法依赖训练好的神经网络,数据改变后需要更新。Docker 镜像由任务调度器自动处理;也可手动运行无参数的 document_create_classifier 重建分类器。
缩略图、搜索索引与 AI 索引
document_thumbnails 会重新生成缩略图;–document <id> 只处理一份文档,–processes 控制进程数,默认使用可用处理器数的四分之一。
搜索索引通常随文档增删改自动更新。如果搜索出现不存在的文档,或应有内容搜索不到,可以用 document_index reindex 从数据库中的全部文档重建索引。–recreate 会先清除现有索引再重建;–if-needed 只在模式版本、模式指纹或搜索语言不一致等需要更新的情况下重建。重建可能耗时,也不能补回已经丢失的原件。
当前文档仍列出 optimize 子命令,但紧接着说明它已经弃用,成为无实际操作的兼容入口;Tantivy 自动管理分段合并,不再需要手工优化。Docker 每次启动会自动执行 document_index reindex –if-needed,并在 webserver 启动前处理模式、语言或缺失索引。裸机用户在升级后或修改 PAPERLESS_SEARCH_LANGUAGE 后,需要自行执行对应命令。
启用 AI 功能并配置 embedding 后端后,Paperless 会维护用于 RAG、相似文档检索和文档对话的向量索引,默认按 PAPERLESS_LLM_INDEX_TASK_CRON 指定计划更新。document_llmindex 支持 rebuild、update、compact、migrate:rebuild 从全部文档重新构建,适合初次启用或更换 embedding 后端/模型;update 增量更新新增与变化文档;compact 回收空间并优化磁盘向量存储;migrate 用于索引模式迁移。未启用 AI 或未配置后端时,这些命令不会生效。
数据库读缓存与文件重命名
如果开启了数据库读缓存,而又在应用之外修改数据库,例如恢复数据库备份或直接执行 SQL 更新、插入、删除、建表、改表等操作,原文要求清除 Django-Cachalot 缓存。否则应用可能读到陈旧数据,导致不一致,甚至数据损坏。裸机入口如下;容器应按前述管理命令入口执行 invalidate_cachalot:
python3 manage.py invalidate_cachalot
更改自定义文档命名规则后,document_renamer 会按新规则移动所有文档文件。它没有参数,一次处理整个库。原文称重命名逻辑不会覆盖或删除文件,但仍明确要求事先备份;本文保留这一前提,不把作者的实现描述写成已测试的保证。
完整性检查与邮件获取
document_sanity_checker 不带参数,按库的大小可能运行较久。它检查:原件、归档件和缩略图是否缺失;是否因权限不可访问;原件与归档件的实际校验和是否匹配数据库记录;文档是否没有提取内容;媒体目录中是否存在没有任何文档引用的孤立文件。后两类属于警告。它是发现问题的检查入口,不是修复丢失文件的替代备份。
邮件默认每 10 分钟自动抓取一次。mail_fetcher 可手动触发,命令没有参数,会处理全部已配置邮件账户与规则,因此可能消费新邮件内容。使用 OAuth 访问令牌时,编辑邮件账户要勾选“密码实际为 token”的选项;令牌的创建方式取决于邮件服务商。本文未读取账户或执行抓取。
生成 PDF/A 归档件
Paperless 在原件旁保存派生的 PDF/A 归档件。对于只有图像的原件,归档件还会包含可选择的文字。原件始终按原样保存;较早版本导入的文档可能还没有归档件。document_archiver 用于补建这些派生文件。
# 仅补建某个文档缺少的归档件;请使用真实且已核对的文档 ID
document_archiver --document <id>
上例是编辑采用的保守写法,相比原文示例省略了 –overwrite。默认只尝试处理尚无归档件的文档;明确加 –overwrite 才会覆盖重建已有归档件;省略 –document 则扩大到全部文档。该过程实际上会按当前设置再次进行 OCR。若 PAPERLESS_OCR_MODE=redo,耗时可能很长。原文说明可中断后再运行,已存在归档件会被跳过;但启用 –overwrite 时不能再把“已有归档件跳过”当作相同保证。加密 PDF 等无法转换的文件会被跳过并报告错误。
近似重复:相似内容不是删除授权
Paperless 已能识别逐字节完全相同的重复文档,但同一纸张的重新扫描通常不会产生相同字节。document_fuzzy_match 因此比较文档内容,按相似度寻找近似重复;当前不把联系人、文档类型等其他元数据纳入判断。
| 选项 | 默认值与含义 |
|---|---|
| –ratio | 默认 85.0,范围 0–100;越高表示需要越相似才报告。 |
| –processes | 默认系统核心数的四分之一;设为 1 时不使用多进程。 |
| –delete | 默认 False;启用后会删除超过阈值的匹配对中的一份文档,存在误删需要保留文件的风险。 |
| –url | 默认空;提供实例 URL 后,输出表用文档链接代替 ID 与名称。 |
# 编辑建议的首轮报告方式:没有自动删除选项
document_fuzzy_match --ratio 85 --processes 1
先逐对核对报告、原件及业务含义。即使分数超过阈值,也可能是需要分别保留的不同扫描件或版本。原文强烈建议启用 –delete 前备份;本稿不把它放进可连续复制的日常维护脚本。
审计历史与超级用户
启用审计日志时,Paperless 会记录文档变更。后来版本增加了自动移除已删除文档相关条目的功能,但在此之前产生的旧条目不会自动移除。prune_audit_logs 用于清理不再需要的这些审计记录;这是删除历史,不应未经留存需求核对就执行。
需要创建超级用户时,使用 createsuperuser 管理命令,按交互提示设置账户。它会新增高权限身份;本文不预设口令,也不写入硬编码凭证。
本次静态审查与使用边界
本文未执行任何导入、升级、删除、重打标、OCR 或数据库操作。静态审核发现的实际风险包括:导出 –delete 会清理目标目录;重打标覆盖可能移除标签;导入需要空库;模糊匹配删除可能误删;重命名会移动全库文件;升级和索引重建会中断服务或消耗资源;prune_audit_logs 会删除审计记录;createsuperuser 会创建高权限账户。文中没有发现硬编码秘密或把外部文本拼进 shell 执行的示例,但这不代表软件整体没有漏洞。
来源、署名与许可
来源仓库采用 GNU GPL v3,完整许可证保留在本文下方;本中文翻译整理中属于原文派生的内容沿用 GNU GPL v3,按该许可提供且不作担保;作者归属 Paperless-ngx 贡献者。本稿为中文翻译整理,新增安全操作边界。
保留作者与适用许可证。本文调整与安全补充均已说明,未执行原文应用代码或命令。
GNU General Public License v3
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>.












暂无评论内容