Usage Overview 使用概述
Paperless is an application that manages your personal documents. With
the help of a document scanner (see the scanners wiki),
paperless transforms your unwieldy physical document binders into a searchable archive
and provides many utilities for finding and managing your documents.
无纸化是一个管理您的个人文档的应用程序。借助文档扫描仪(请参阅扫描仪 wiki ),无纸化将您笨重的物理文档活页夹转换为可搜索的存档,并提供许多用于查找和管理文档的实用程序。
Terms and definitions 术语和定义
Paperless essentially consists of two different parts for managing your
documents:
无纸化本质上由用于管理文档的两个不同部分组成:
- The consumer watches a specified folder and adds all documents in
that folder to paperless.
消费者监视指定的文件夹并将该文件夹中的所有文档添加为无纸化。 - The web server provides a UI that you use to manage and search for
your scanned documents.
Web 服务器提供了一个 UI,您可以用它来管理和搜索扫描的文档。
Each document has a couple of fields that you can assign to them:
每个文档都有几个可以分配给它们的字段:
- A Document is a piece of paper that sometimes contains valuable
information.
文档是一张纸,有时包含有价值的信息。 - The correspondent of a document is the person, institution or
company that a document either originates from, or is sent to.
文件的通讯者是指文件发出或发送至的个人、机构或公司。 - A tag is a label that you can assign to documents. Think of labels
as more powerful folders: Multiple documents can be grouped together
with a single tag, however, a single document can also have multiple
tags. This is not possible with folders. The reason folders are not
implemented in paperless is simply that tags are much more versatile
than folders.
标签是您可以分配给文档的标签。将标签视为更强大的文件夹:可以使用单个标签将多个文档分组在一起,但是单个文档也可以具有多个标签。这对于文件夹来说是不可能的。文件夹没有实现无纸化的原因很简单,标签比文件夹更通用。 - A document type is used to demarcate the type of a document such
as letter, bank statement, invoice, contract, etc. It is used to
identify what a document is about.
文档类型用于划分文档的类型,例如信件、银行对账单、发票、合同等。它用于标识文档的内容。 - The date added of a document is the date the document was scanned
into paperless. You cannot and should not change this date.
文档的添加日期是文档被扫描为无纸化的日期。您不能也不应该更改此日期。 - The date created of a document is the date the document was
initially issued. This can be the date you bought a product, the
date you signed a contract, or the date a letter was sent to you.
文件的创建日期是文件最初发布的日期。这可以是您购买产品的日期、签署合同的日期或向您发送信件的日期。 - The archive serial number (short: ASN) of a document is the
identifier of the document in your physical document binders. See
recommended workflow below.
文档的存档序列号(简称:ASN)是物理文档活页夹中文档的标识符。请参阅下面推荐的工作流程。 - The content of a document is the text that was OCR'ed from the
document. This text is fed into the search engine and is used for
matching tags, correspondents and document types.
文档的内容是从文档中进行 OCR 处理的文本。该文本被输入搜索引擎并用于匹配标签、通讯员和文档类型。
Adding documents to paperless
添加文档至无纸化
Once you've got Paperless setup, you need to start feeding documents
into it. When adding documents to paperless, it will perform the
following operations on your documents:
一旦完成无纸化设置,您需要开始将文档送入其中。添加文档到无纸化时,它将对您的文档执行以下操作:
- OCR the document, if it has no text. Digital documents usually have
text, and this step will be skipped for those documents.
OCR 文档(如果没有文本)。数字文档通常带有文本,对于这些文档将跳过此步骤。 - Paperless will create an archivable PDF/A document from your
document. If this document is coming from your scanner, it will have
embedded selectable text.
无纸化将从您的文档创建可存档的 PDF/A 文档。如果此文档来自您的扫描仪,它将嵌入可选择的文本。 - Paperless performs automatic matching of tags, correspondents and
types on the document before storing it in the database.
无纸化在将文档存储到数据库之前,会自动匹配文档上的标签、通讯员和类型。
Tip 提示
This process can be configured to fit your needs. If you don't want
paperless to create archived versions for digital documents, you can
configure that by configuring
PAPERLESS_OCR_SKIP_ARCHIVE_FILE=with_text
. Please read the
relevant section in the documentation.
可以配置此过程以满足您的需求。如果您不希望无纸化地创建数字文档的存档版本,您可以通过配置进行配置 PAPERLESS_OCR_SKIP_ARCHIVE_FILE=with_text
。请阅读文档中的相关部分。
Note 笔记
No matter which options you choose, Paperless will always store the
original document that it found in the consumption directory or in the
mail and will never overwrite that document. Archived versions are
stored alongside the original versions. Any files found in the
consumption directory will stored inside the Paperless-ngx file
structure and will not be retained in the consumption directory.
无论您选择哪个选项,无纸化将始终存储在消费目录或邮件中找到的原始文档,并且永远不会覆盖该文档。存档版本与原始版本一起存储。在消费目录中找到的任何文件都将存储在 Paperless-ngx 文件结构中,并且不会保留在消费目录中。
The consumption directory
消费目录
The primary method of getting documents into your database is by putting
them in the consumption directory. The consumer waits patiently, looking
for new additions to this directory. When it finds them,
the consumer goes about the process of parsing them with the OCR,
indexing what it finds, and storing it in the media directory. You should
think of this folder as a temporary location, as files will be re-created
inside Paperless-ngx and removed from the consumption folder.
将文档放入数据库的主要方法是将它们放入消费目录中。消费者耐心等待,寻找此目录中的新添加内容。当找到它们时,消费者会使用 OCR 解析它们,对找到的内容建立索引,并将其存储在媒体目录中。您应该将此文件夹视为临时位置,因为文件将在 Paperless-ngx 内重新创建并从消耗文件夹中删除。
Getting stuff into this directory is up to you. If you're running
Paperless on your local computer, you might just want to drag and drop
files there, but if you're running this on a server and want your
scanner to automatically push files to this directory, you'll need to
setup some sort of service to accept the files from the scanner.
Typically, you're looking at an FTP server like
Proftpd or a Windows folder share with
Samba.
将内容放入此目录由您决定。如果您在本地计算机上运行无纸化,您可能只想将文件拖放到那里,但如果您在服务器上运行它并希望扫描仪自动将文件推送到此目录,则需要设置某种服务来接受来自扫描仪的文件。通常,您会查看Proftpd之类的 FTP 服务器或使用Samba共享的 Windows 文件夹。
Warning 警告
Files found in the consumption directory that are consumed will be
removed from the consumption directory and stored inside the
Paperless-ngx file structure using any settings / storage paths
you have specified. This action is performed as safely as possible
but this means it is expected that files in the consumption
directory will no longer exist (there) after being consumed.
在消费目录中找到的已消费的文件将从消费目录中删除,并使用您指定的任何设置/存储路径存储在 Paperless-ngx 文件结构中。此操作尽可能安全地执行,但这意味着消耗目录中的文件在被消耗后将不再存在。
Web UI Upload 网页界面上传
The dashboard has a button to upload documents to paperless or you
can simply drag a file anywhere into the app to initiate the consumption
process.
仪表板有一个按钮可将文档上传到无纸化系统,或者您只需将文件拖到应用程序中的任何位置即可启动消费流程。
Mobile upload 手机上传
Please see the wiki for a user-maintained list of related projects and
software (e.g. for mobile devices) that is compatible with Paperless-ngx.
请参阅wiki,了解用户维护的与 Paperless-ngx 兼容的相关项目和软件(例如移动设备)列表。
Email 电子邮件
You can tell paperless-ngx to consume documents from your email
accounts. This is a very flexible and powerful feature, if you regularly
received documents via mail that you need to archive. The mail consumer
can be configured via the frontend settings (/settings/mail) in the following
manner:
您可以告诉 paperless-ngx 使用您的电子邮件帐户中的文档。如果您经常通过邮件收到需要存档的文档,那么这是一个非常灵活且强大的功能。邮件使用者可以通过前端设置(/settings/mail)按以下方式进行配置:
- Define e-mail accounts. 定义电子邮件帐户。
- Define mail rules for your account.
为您的帐户定义邮件规则。
These rules perform the following:
这些规则执行以下操作:
- Connect to the mail server.
连接到邮件服务器。 - Fetch all matching mails (as defined by folder, maximum age and the
filters)
获取所有匹配的邮件(按文件夹、最长期限和过滤器定义) - Check if there are any consumable attachments.
检查是否有耗材附件。 - If so, instruct paperless to consume the attachments and optionally
use the metadata provided in the rule for the new document.
如果是这样,请指示无纸化使用附件,并可选择使用新文档规则中提供的元数据。 - If documents were consumed from a mail, the rule action is performed
on that mail.
如果文档是从邮件中使用的,则会对该邮件执行规则操作。
Paperless will check all emails only once and completely ignore messages
that do not match your filters. It will also only perform the rule action
on e-mails that it has consumed documents from. The filename attachment
patterns can include wildcards and multiple patterns separated by a comma.
无纸化只会检查所有电子邮件一次,并完全忽略与您的过滤器不匹配的邮件。它还将仅对已使用文档的电子邮件执行规则操作。文件名附件模式可以包括通配符和用逗号分隔的多个模式。
The actions all ensure that the same mail is not consumed twice by
different means. These are as follows:
这些操作都确保相同的邮件不会被不同的方式使用两次。具体如下:
- Delete: Immediately deletes mail that paperless has consumed
documents from. Use with caution.
删除:立即删除无纸化已消耗文档的邮件。谨慎使用。 - Mark as read: Mark consumed mail as read. Paperless will not
consume documents from already read mails. If you read a mail before
paperless sees it, it will be ignored.
标记为已读:将已使用的邮件标记为已读。无纸化不会消耗已读邮件中的文档。如果您在无纸化系统看到邮件之前阅读它,它将被忽略。 - Flag: Sets the 'important' flag on mails with consumed
documents. Paperless will not consume flagged mails.
标记:在包含已使用文档的邮件上设置“重要”标记。无纸化不会消耗带标记的邮件。 - Move to folder: Moves consumed mails out of the way so that
paperless won't consume them again.
移至文件夹:将已使用的邮件移开,以便无纸化不会再次使用它们。 -
Add custom Tag: Adds a custom tag to mails with consumed documents (the IMAP standard calls these "keywords"). Paperless will not consume mails already tagged. Not all mail servers support this feature!
添加自定义标签:向包含已使用文档的邮件添加自定义标签(IMAP 标准将这些标签称为“关键字”)。无纸化不会消耗已经标记的邮件。并非所有邮件服务器都支持此功能!- Apple Mail support: Apple Mail clients allow differently colored tags. For this to work use
apple:<color>
(e.g. apple:green) as a custom tag. Available colors are red, orange, yellow, blue, green, violet and grey.
Apple Mail 支持: Apple Mail 客户端允许使用不同颜色的标签。为此,请使用apple:<color>
(例如apple:green )作为自定义标记。可用颜色有红、橙、黄、蓝、绿、紫和灰。
- Apple Mail support: Apple Mail clients allow differently colored tags. For this to work use
Warning 警告
The mail consumer will perform these actions on all mails it has
consumed documents from. Keep in mind that the actual consumption
process may fail for some reason, leaving you with missing documents in
paperless.
邮件使用者将对所有已使用文档的邮件执行这些操作。请记住,实际的消费过程可能会因某种原因失败,导致您在无纸化过程中丢失文档。
Note 笔记
With the correct set of rules, you can completely automate your email
documents. Create rules for every correspondent you receive digital
documents from and paperless will read them automatically. The default
action "mark as read" is pretty tame and will not cause any damage or
data loss whatsoever.
通过正确的规则集,您可以完全自动化您的电子邮件文档。为您收到的数字文档的每位通讯员创建规则,无纸化将自动阅读它们。默认操作“标记为已读”非常温和,不会造成任何损坏或数据丢失。
You can also setup a special folder in your mail account for paperless
and use your favorite mail client to move to be consumed mails into that
folder automatically or manually and tell paperless to move them to yet
another folder after consumption. It's up to you.
您还可以在邮件帐户中为无纸化设置一个特殊文件夹,并使用您最喜欢的邮件客户端将要使用的邮件自动或手动移动到该文件夹中,并告诉无纸化在使用后将它们移动到另一个文件夹。由你决定。
Note 笔记
When defining a mail rule with a folder, you may need to try different
characters to define how the sub-folders are separated. Common values
include ".", "/" or "|", but this varies by the mail server.
Check the documentation for your mail server. In the event of an error
fetching mail from a certain folder, check the Paperless logs. When a
folder is not located, Paperless will attempt to list all folders found
in the account to the Paperless logs.
使用文件夹定义邮件规则时,您可能需要尝试不同的字符来定义子文件夹的分隔方式。常见值包括“.”、“/”或“|”,但这因邮件服务器而异。检查您的邮件服务器的文档。如果从某个文件夹提取邮件时出错,请检查无纸化日志。当找不到文件夹时,无纸化将尝试将帐户中找到的所有文件夹列出到无纸化日志中。
Note 笔记
Paperless will process the rules in the order defined in the admin page.
无纸化将按照管理页面中定义的顺序处理规则。
You can define catch-all rules and have them executed last to consume
any documents not matched by previous rules. Such a rule may assign an
"Unknown mail document" tag to consumed documents so you can inspect
them further.
您可以定义包罗万象的规则并让它们最后执行以使用与先前规则不匹配的任何文档。此类规则可能会为已使用的文档分配“未知邮件文档”标签,以便您可以进一步检查它们。
Paperless is set up to check your mails every 10 minutes. This can be
configured via PAPERLESS_EMAIL_TASK_CRON
无纸化设置为每 10 分钟检查一次您的邮件。这可以通过PAPERLESS_EMAIL_TASK_CRON
配置
OAuth Email Setup OAuth 电子邮件设置
Paperless-ngx supports OAuth2 authentication for Gmail and Outlook email accounts. To set up an email account with OAuth2, you will need to create a 'developer' app with the respective provider and obtain the client ID and client secret and set the appropriate configuration variables. You will also need to set either PAPERLESS_OAUTH_CALLBACK_BASE_URL
or PAPERLESS_URL
to the correct value for the OAuth2 flow to work correctly.
Paperless-ngx 支持 Gmail 和 Outlook 电子邮件帐户的 OAuth2 身份验证。要使用 OAuth2 设置电子邮件帐户,您需要使用相应的提供商创建一个“开发人员”应用程序,获取客户端 ID 和客户端密钥,并设置适当的配置变量。您还需要设置 PAPERLESS_OAUTH_CALLBACK_BASE_URL
或PAPERLESS_URL
为 OAuth2 流程正常工作的正确值。
Specific instructions for setting up the required 'developer' app with Google or Microsoft are beyond the scope of this documentation, but you can find user-maintained instructions in the wiki or by searching the web.
有关通过 Google 或 Microsoft 设置所需“开发人员”应用程序的具体说明超出了本文档的范围,但您可以在wiki中或通过搜索网络找到用户维护的说明。
Once setup, navigating to the email settings page in Paperless-ngx will allow you to add an email account for Gmail or Outlook using OAuth2. After authenticating, you will be presented with the newly-created account where you will need to enter and save your email address. After this, the account will work as any other email account in Paperless-ngx and refreshing tokens will be handled automatically.
设置完成后,导航到 Paperless-ngx 中的电子邮件设置页面将允许您使用 OAuth2 添加 Gmail 或 Outlook 的电子邮件帐户。身份验证后,您将看到新创建的帐户,您需要在其中输入并保存您的电子邮件地址。此后,该帐户将像 Paperless-ngx 中的任何其他电子邮件帐户一样工作,并且刷新令牌将自动处理。
REST API 休息API
You can also submit a document using the REST API, see POSTing documents
for details.
您还可以使用 REST API 提交文档,有关详细信息,请参阅发布文档。
Permissions 权限
Permissions in Paperless-ngx are based around 'global' permissions as well as
'object-level' permissions. Global permissions determine which parts of the
application a user can access (e.g. Documents, Tags, Settings) and object-level determine which
objects are visible or editable. All objects have an 'owner' and 'view' and 'edit' permissions which
can be granted to other users or groups. The paperless-ngx permissions system uses the built-in user
model of the backend framework, Django.
Paperless-ngx 中的权限基于“全局”权限和“对象级”权限。全局权限确定用户可以访问应用程序的哪些部分(例如文档、标签、设置),而对象级别确定哪些对象可见或可编辑。所有对象都具有“所有者”、“查看”和“编辑”权限,这些权限可以授予其他用户或组。 paperless-ngx权限系统使用后端框架Django的内置用户模型。
Tip 提示
Object-level permissions only apply to the object itself. In other words, setting permissions
for a Tag will not affect the permissions of documents that have the Tag.
对象级权限仅适用于对象本身。换句话说,为Tag设置权限不会影响具有该Tag的文档的权限。
Permissions can be set using the new "Permissions" tab when editing documents, or bulk-applied
in the UI by selecting documents and choosing the "Permissions" button.
编辑文档时可以使用新的“权限”选项卡设置权限,也可以通过选择文档并选择“权限”按钮在 UI 中批量应用权限。
Default permissions 默认权限
Workflows provide advanced ways to control permissions.
工作流提供了控制权限的高级方法。
For objects created via the web UI (tags, doc types, etc.) the default is to set the current user
as owner and no extra permissions, but you can explicitly set these under Settings > Permissions.
对于通过 Web UI 创建的对象(标签、文档类型等),默认设置是将当前用户设置为所有者且没有额外权限,但您可以在设置 > 权限下显式设置这些权限。
Documents consumed via the consumption directory do not have an owner or additional permissions set by default, but again, can be controlled with Workflows.
默认情况下,通过消费目录消费的文档没有所有者或其他权限设置,但同样可以使用Workflows进行控制。
Users and Groups 用户和组
Paperless-ngx supports editing users and groups via the 'frontend' UI, which can be found under
Settings > Users & Groups, assuming the user has access. If a user is designated
as a member of a group those permissions will be inherited and this is reflected in the UI. Explicit
permissions can be granted to limit access to certain parts of the UI (and corresponding API endpoints).
Paperless-ngx 支持通过“前端”UI 编辑用户和组,假设用户具有访问权限,可以在“设置 > 用户和组”下找到该 UI。如果用户被指定为组的成员,这些权限将被继承,这会反映在 UI 中。可以授予显式权限来限制对 UI 某些部分(以及相应的 API 端点)的访问。
Tip 提示
By default, new users are not granted any permissions, except those inherited from any group(s) of which they are a member.
默认情况下,新用户不会被授予任何权限,除了从其所属的任何组继承的权限之外。
Superusers 超级用户
Superusers can access all parts of the front and backend application as well as any and all objects.
超级用户可以访问前端和后端应用程序的所有部分以及任何和所有对象。
Admin Status 管理员状态
Admin status (Django 'staff status') grants access to viewing the paperless logs and the system status dialog
as well as accessing the Django backend.
管理员状态(Django“员工状态”)授予查看无纸化日志和系统状态对话框以及访问 Django 后端的权限。
Detailed Explanation of Global Permissions
全局权限详解
Global permissions define what areas of the app and API endpoints users can access. For example, they
determine if a user can create, edit, delete or view any documents, but individual documents themselves
still have "object-level" permissions.
全局权限定义用户可以访问应用程序和 API 端点的哪些区域。例如,它们确定用户是否可以创建、编辑、删除或查看任何文档,但单个文档本身仍然具有“对象级”权限。
Type 类型 | Details 细节 |
---|---|
AppConfig 应用程序配置 | Change or higher permissions grants access to the "Application Configuration" area. 更改或更高权限授予对“应用程序配置”区域的访问权限。 |
Correspondent 通讯员 | Add, edit, delete or view Correspondents. 添加、编辑、删除或查看通讯员。 |
CustomField 自定义字段 | Add, edit, delete or view Custom Fields. 添加、编辑、删除或查看自定义字段。 |
Document 文档 | Add, edit, delete or view Documents. 添加、编辑、删除或查看文档。 |
DocumentType 文件类型 | Add, edit, delete or view Document Types. 添加、编辑、删除或查看文档类型。 |
Group 团体 | Add, edit, delete or view Groups. 添加、编辑、删除或查看组。 |
MailAccount 邮件帐户 | Add, edit, delete or view Mail Accounts. 添加、编辑、删除或查看邮件帐户。 |
MailRule 邮件规则 | Add, edit, delete or view Mail Rules. 添加、编辑、删除或查看邮件规则。 |
Note 笔记 | Add, edit, delete or view Notes. 添加、编辑、删除或查看注释。 |
PaperlessTask 无纸化任务 | View or dismiss (Change) File Tasks. 查看或取消(更改)文件任务。 |
SavedView 保存的视图 | Add, edit, delete or view Saved Views. 添加、编辑、删除或查看已保存的视图。 |
ShareLink 分享链接 | Add, delete or view Share Links. 添加、删除或查看共享链接。 |
StoragePath 存储路径 | Add, edit, delete or view Storage Paths. 添加、编辑、删除或查看存储路径。 |
Tag 标签 | Add, edit, delete or view Tags. 添加、编辑、删除或查看标签。 |
UISettings 用户界面设置 | Add, edit, delete or view the UI settings that are used by the web app. 添加、编辑、删除或查看 Web 应用程序使用的 UI 设置。 |
User 用户 | Add, edit, delete or view Users. 添加、编辑、删除或查看用户。 |
Workflow 工作流程 | Add, edit, delete or view Workflows. 添加、编辑、删除或查看工作流程。 Note that Workflows are global, in other words all users who can access workflows have access to the same set of them. 请注意,工作流是全局的,换句话说,所有可以访问工作流的用户都可以访问同一组工作流。 |
Detailed Explanation of Object Permissions
对象权限详解
Type 类型 | Details 细节 |
---|---|
Owner 所有者 | By default objects are only visible and editable by their owner. 默认情况下,对象仅对其所有者可见和可编辑。 Only the object owner can grant permissions to other users or groups. 只有对象所有者才能向其他用户或组授予权限。 Additionally, only document owners can create share links and add / remove custom fields. 此外,只有文档所有者才能创建共享链接并添加/删除自定义字段。 For backwards compatibility objects can have no owner which makes them visible to any user. 为了向后兼容,对象可以没有所有者,这使得它们对任何用户都可见。 |
View 看法 | Confers the ability to view (not edit) a document, tag, etc. 赋予查看(而不是编辑)文档、标签等的能力。 Users without 'view' (or higher) permissions will be shown 'Private' in place of the object name for example when viewing a document with a tag for which the user doesn't have permissions. 没有“查看”(或更高)权限的用户将显示“私有”,而不是对象名称,例如,在查看带有用户没有权限的标签的文档时。 |
Edit 编辑 | Confers the ability to edit (and view) a document, tag, etc. 赋予编辑(和查看)文档、标签等的能力。 |
Password reset 密码重置
In order to enable the password reset feature you will need to setup an SMTP backend, see
PAPERLESS_EMAIL_HOST
. If your installation does not have
PAPERLESS_URL
set, the reset link included in emails will use the server host.
为了启用密码重置功能,您需要设置 SMTP 后端,请参阅PAPERLESS_EMAIL_HOST
。如果您的安装未设置PAPERLESS_URL
,则电子邮件中包含的重置链接将使用服务器主机。
Workflows 工作流程
Note 笔记
v2.3 added "Workflows" and existing "Consumption Templates" were converted automatically to the new more powerful format.
v2.3 添加了“工作流程”,现有的“消费模板”自动转换为新的更强大的格式。
Workflows allow hooking into the Paperless-ngx document pipeline, for example to alter what metadata (tags, doc types) and
permissions (owner, privileges) are assigned to documents. Workflows can have multiple 'triggers' and 'actions'. Triggers
are events (with optional filtering rules) that will cause the workflow to be run and actions are the set of sequential
actions to apply.
工作流程允许挂钩 Paperless-ngx 文档管道,例如更改分配给文档的元数据(标签、文档类型)和权限(所有者、特权)。工作流程可以有多个“触发器”和“操作”。触发器是导致工作流运行的事件(具有可选的过滤规则),操作是要应用的一组顺序操作。
In general, workflows and any actions they contain are applied sequentially by sort order. For "assignment" actions, subsequent
workflow actions will override previous assignments, except for assignments that accept multiple items e.g. tags, custom
fields and permissions, which will be merged.
一般来说,工作流及其包含的任何操作都会按排序顺序应用。对于“分配”操作,后续工作流操作将覆盖之前的分配,但接受多个项目(例如标签、自定义字段和权限)的分配除外,这些项目将被合并。
Workflow Triggers 工作流程触发器
Currently, there are three events that correspond to workflow trigger 'types':
目前,存在与工作流触发器“类型”相对应的三个事件:
- Consumption Started: before a document is consumed, so events can include filters by source (mail, consumption
folder or API), file path, file name, mail rule
消费开始:在消费文档之前,因此事件可以包括按源(邮件、消费文件夹或 API)、文件路径、文件名、邮件规则进行过滤 - Document Added: after a document is added. At this time, file path and source information is no longer available,
but the document content has been extracted and metadata such as document type, tags, etc. have been set, so these can now
be used for filtering.
添加文档:添加文档后。此时,文件路径和源信息不再可用,但文档内容已被提取,并且文档类型、标签等元数据已设置,因此现在可以使用这些进行过滤。 - Document Updated: when a document is updated. Similar to 'added' events, triggers can include filtering by content matching,
tags, doc type, or correspondent.
文档更新:文档更新时。与“添加”事件类似,触发器可以包括按内容匹配、标签、文档类型或通讯员进行过滤。
The following flow diagram illustrates the three trigger types:
以下流程图说明了三种触发器类型:
Filters 过滤器
Workflows allow you to filter by:
工作流程允许您按以下条件进行过滤:
- Source, e.g. documents uploaded via consume folder, API (& the web UI) and mail fetch
来源,例如通过消费文件夹上传的文档、API(和 Web UI)和邮件获取 - File name, including wildcards e.g. *.pdf will apply to all pdfs
文件名,包括通配符,例如 *.pdf 将适用于所有 pdf - File path, including wildcards. Note that enabling
PAPERLESS_CONSUMER_RECURSIVE
would allow, for example, automatically assigning documents to different owners based on the upload directory.
文件路径,包括通配符。请注意,启用PAPERLESS_CONSUMER_RECURSIVE
将允许根据上传目录自动将文档分配给不同的所有者。 - Mail rule. Choosing this option will force 'mail fetch' to be the workflow source.
邮件规则。选择此选项将强制“邮件获取”成为工作流程源。 - Content matching (
Added
andUpdated
triggers only). Filter document content using the matching settings.
内容匹配(仅限Added
和Updated
触发器)。使用匹配的设置过滤文档内容。 - Tags (
Added
andUpdated
triggers only). Filter for documents with any of the specified tags
标签(仅限Added
和Updated
触发器)。过滤具有任何指定标签的文档 - Document type (
Added
andUpdated
triggers only). Filter documents with this doc type
文档类型(仅限Added
和Updated
触发器)。过滤具有此文档类型的文档 - Correspondent (
Added
andUpdated
triggers only). Filter documents with this correspondent
通讯员(仅限Added
和Updated
触发器)。与这位通讯员一起过滤文件
Workflow Actions 工作流程操作
There are currently two types of workflow actions, "Assignment", which can assign:
目前有两种类型的工作流动作,“分配”,可以分配:
- Title, see title placeholders below
标题,请参阅下面的标题占位符 - Tags, correspondent, document type and storage path
标签、通讯员、文档类型和存储路径 - Document owner 文件所有者
- View and / or edit permissions to users or groups
查看和/或编辑用户或组的权限 - Custom fields. Note that no value for the field will be set
自定义字段。请注意,不会设置该字段的值
and "Removal" actions, which can remove either all of or specific sets of the following:
和“删除”操作,可以删除以下所有或特定组:
- Tags, correspondents, document types or storage paths
标签、通讯员、文档类型或存储路径 - Document owner 文件所有者
- View and / or edit permissions
查看和/或编辑权限 - Custom fields 自定义字段
Title placeholders 标题占位符
Workflow titles can include placeholders but the available options differ depending on the type of
workflow trigger. This is because at the time of consumption (when the title is to be set), no automatic tags etc. have been
applied. You can use the following placeholders with any trigger type:
工作流标题可以包含占位符,但可用选项根据工作流触发器的类型而有所不同。这是因为在消费时(当要设置标题时),没有应用自动标签等。您可以将以下占位符与任何触发器类型一起使用:
{correspondent}
: assigned correspondent name{correspondent}
: 分配的通讯员姓名{document_type}
: assigned document type name{document_type}
:分配的文档类型名称{owner_username}
: assigned owner username{owner_username}
:分配的所有者用户名{added}
: added datetime{added}
:添加日期时间{added_year}
: added year{added_year}
:添加年份{added_year_short}
: added year{added_year_short}
:添加年份{added_month}
: added month{added_month}
:添加的月份{added_month_name}
: added month name{added_month_name}
:添加的月份名称{added_month_name_short}
: added month short name{added_month_name_short}
:添加月份短名称{added_day}
: added day{added_day}
:添加的日期{added_time}
: added time in HH:MM format{added_time}
:添加时间,格式为 HH:MM{original_filename}
: original file name without extension{original_filename}
:不带扩展名的原始文件名
The following placeholders are only available for "added" or "updated" triggers
以下占位符仅适用于“添加”或“更新”触发器
{created}
: created datetime{created}
:创建日期时间{created_year}
: created year{created_year}
:创建年份{created_year_short}
: created year{created_year_short}
:创建年份{created_month}
: created month{created_month}
:创建月份{created_month_name}
: created month name{created_month_name}
:创建的月份名称{created_month_name_short}
: created month short name{created_month_name_short}
:创建月份短名称{created_day}
: created day{created_day}
:创建日{created_time}
: created time in HH:MM format{created_time}
:创建时间,格式为 HH:MM
Workflow permissions 工作流程权限
All users who have application permissions for editing workflows can see the same set
of workflows. In other words, workflows themselves intentionally do not have an owner or permissions.
所有具有编辑工作流应用程序权限的用户都可以看到同一组工作流。换句话说,工作流本身故意没有所有者或权限。
Given their potentially far-reaching capabilities, you may want to restrict access to workflows.
鉴于其潜在的深远功能,您可能希望限制对工作流程的访问。
Upon migration, existing installs will grant access to workflows to users who can add
documents (and superusers who can always access all parts of the app).
迁移后,现有安装将向可以添加文档的用户(以及始终可以访问应用程序所有部分的超级用户)授予对工作流程的访问权限。
Custom Fields 自定义字段
Paperless-ngx supports the use of custom fields for documents as of v2.0, allowing a user
to optionally attach data to documents which does not fit in the existing set of fields
Paperless-ngx provides.
Paperless-ngx 自 v2.0 起支持使用文档的自定义字段,允许用户选择将数据附加到不适合 Paperless-ngx 提供的现有字段集的文档。
- First, create a custom field (under "Manage"), with a given name and data type. This could be something like "Invoice Number" or "Date Paid", with a data type of "Number", "Date", "String", etc.
首先,使用给定的名称和数据类型创建一个自定义字段(在“管理”下)。这可能类似于“发票编号”或“支付日期”,数据类型为“数字”、“日期”、“字符串”等。 - Once created, a field can be used with documents and data stored. To do so, use the "Custom Fields" menu on the document detail page, choose your existing field from the dropdown. Once the field is visible in the form you can enter the appropriate data which will be validated according to the custom field "data type".
创建后,字段可以与存储的文档和数据一起使用。为此,请使用文档详细信息页面上的“自定义字段”菜单,从下拉列表中选择现有字段。一旦该字段在表单中可见,您就可以输入适当的数据,这些数据将根据自定义字段“数据类型”进行验证。 - Fields can be removed by hovering over the field name revealing a "Remove" button.
将鼠标悬停在字段名称上并显示“删除”按钮即可删除字段。
Important 重要的
Added / removed fields, as well as any data, is not saved to the document until you
actually hit the "Save" button, similar to other changes on the document details page.
在您实际点击“保存”按钮之前,添加/删除的字段以及任何数据都不会保存到文档中,这与文档详细信息页面上的其他更改类似。
Note 笔记
Once the data type for a field is set, it cannot be changed.
一旦设置了字段的数据类型,就无法更改。
Multiple fields may be attached to a document but the same field name cannot be assigned multiple times to the a single document.
多个字段可以附加到一个文档,但不能将相同的字段名称多次分配给单个文档。
The following custom field types are supported:
支持以下自定义字段类型:
Text
: any textText
:任何文本Boolean
: true / false (check / unchecked) fieldBoolean
:true / false(选中/未选中)字段Date
: dateDate
: 日期URL
: a valid urlURL
: 有效的 URLInteger
: integer number e.g. 12Integer
:整数,例如 12Number
: float number e.g. 12.3456Number
: 浮点数,例如 12.3456Monetary
: ISO 4217 currency code and a number with exactly two decimals, e.g. USD12.30Monetary
: ISO 4217 货币代码和精确到两位小数的数字,例如 USD12.30Document Link
: reference(s) to other document(s) displayed as links, automatically creates a symmetrical link in reverseDocument Link
:对显示为链接的其他文档的引用,自动创建反向对称链接Select
: a pre-defined list of strings from which the user can chooseSelect
:用户可以从中选择的预定义字符串列表
Share Links 分享链接
Paperless-ngx added the ability to create shareable links to files in version 2.0. You can find the button for this on the document detail screen.
Paperless-ngx 在 2.0 版本中添加了创建文件可共享链接的功能。您可以在文档详细信息屏幕上找到此按钮。
- Share links do not require a user to login and thus link directly to a file.
共享链接不需要用户登录,因此可以直接链接到文件。 - Links are unique and are of the form
{paperless-url}/share/{randomly-generated-slug}
.
链接是唯一的并且采用以下形式{paperless-url}/share/{randomly-generated-slug}
。 - Links can optionally have an expiration time set.
链接可以选择设置过期时间。 - After a link expires or is deleted users will be redirected to the regular paperless-ngx login.
链接过期或删除后,用户将被重定向到常规的 paperless-ngx 登录。
Tip 提示
If your paperless-ngx instance is behind a reverse-proxy you may want to create an exception to bypass any authentication layers that are part of your setup in order to make links truly publicly-accessible. Of course, do so with caution.
如果您的无纸化 ngx 实例位于反向代理后面,您可能需要创建一个例外来绕过您设置中的任何身份验证层,以使链接真正可公开访问。当然,请谨慎行事。
PDF Actions PDF 操作
Paperless-ngx supports four basic editing operations for PDFs (these operations currently cannot be performed on non-PDF files):
Paperless-ngx 支持 PDF 的四种基本编辑操作(目前无法对非 PDF 文件执行这些操作):
- Merging documents: available when selecting multiple documents for 'bulk editing'.
合并文档:选择多个文档进行“批量编辑”时可用。 - Rotating documents: available when selecting multiple documents for 'bulk editing' and from an individual document's details page.
旋转文档:在选择多个文档进行“批量编辑”时以及从单个文档的详细信息页面中可用。 - Splitting documents: available from an individual document's details page.
拆分文档:可从单个文档的详细信息页面获取。 - Deleting pages: available from an individual document's details page.
删除页面:可从单个文档的详细信息页面获取。
Important 重要的
Note that rotation and deleting pages alter the Paperless-ngx original file, which would, for example, invalidate a digital signature.
请注意,旋转和删除页面会更改 Paperless-ngx原始文件,例如,这会导致数字签名无效。
Document History 文档历史记录
As of version 2.7, Paperless-ngx automatically records all changes to a document and records this in an audit log. The feature requires PAPERLESS_AUDIT_LOG_ENABLED
be enabled, which it is by default as of version 2.7.
Changes to documents are visible under the "History" tab. Note that certain changes such as those made by workflows, record the 'actor'
as "System".
从版本 2.7 开始,Paperless-ngx 自动记录对文档的所有更改,并将其记录在审核日志中。该功能需要启用PAPERLESS_AUDIT_LOG_ENABLED
,从版本 2.7 开始默认启用该功能。对文档的更改在“历史记录”选项卡下可见。请注意,某些更改(例如工作流程所做的更改)会将“参与者”记录为“系统”。
Document Trash 文件垃圾
When you first delete a document it is moved to the 'trash' until either it is explicitly deleted or it is automatically removed after a set amount of time has passed.
You can set how long documents remain in the trash before being automatically deleted with PAPERLESS_EMPTY_TRASH_DELAY
, which defaults
to 30 days. Until the file is actually deleted (e.g. the trash is emptied), all files and database content remains intact and can be restored at any point up until that time.
当您首次删除文档时,它将被移至“垃圾箱”,直到明确删除该文档或在经过设定的时间后自动删除。您可以使用PAPERLESS_EMPTY_TRASH_DELAY
设置文档在自动删除之前在垃圾箱中保留的时间,默认为 30 天。在文件被实际删除(例如,垃圾箱被清空)之前,所有文件和数据库内容都保持不变,并且可以随时恢复。
Additionally you may configure a directory where deleted files are moved to when they the trash is emptied with PAPERLESS_EMPTY_TRASH_DIR
.
Note that the empty trash directory only stores the original file, the archive file and all database information is permanently removed once a document is fully deleted.
此外,您可以配置一个目录,当使用PAPERLESS_EMPTY_TRASH_DIR
清空垃圾箱时,已删除的文件将移至该目录。请注意,空垃圾目录仅存储原始文件,存档文件和所有数据库信息将在文档完全删除后永久删除。
Best practices 最佳实践
Paperless offers a couple tools that help you organize your document
collection. However, it is up to you to use them in a way that helps you
organize documents and find specific documents when you need them. This
section offers a couple ideas for managing your collection.
无纸化提供了一些工具来帮助您组织文档集合。但是,您可以选择以某种方式使用它们来帮助您组织文档并在需要时查找特定文档。本节提供了一些管理收藏的想法。
Document types allow you to classify documents according to what they
are. You can define types such as "Receipt", "Invoice", or
"Contract". If you used to collect all your receipts in a single
binder, you can recreate that system in paperless by defining a document
type, assigning documents to that type and then filtering by that type
to only see all receipts.
文档类型允许您根据文档的内容对文档进行分类。您可以定义“收据”、“发票”或“合同”等类型。如果您过去将所有收据收集在一个活页夹中,则可以通过定义文档类型、将文档分配给该类型,然后按该类型进行过滤以仅查看所有收据,以无纸化方式重新创建该系统。
Not all documents need document types. Sometimes its hard to determine
what the type of a document is or it is hard to justify creating a
document type that you only need once or twice. This is okay. As long as
the types you define help you organize your collection in the way you
want, paperless is doing its job.
并非所有文档都需要文档类型。有时很难确定文档的类型,或者很难证明创建只需要一次或两次的文档类型是合理的。这没关系。只要您定义的类型可以帮助您按照您想要的方式组织馆藏,无纸化就可以发挥作用。
Tags can be used in many different ways. Think of tags are more
versatile folders or binders. If you have a binder for documents related
to university / your car or health care, you can create these binders in
paperless by creating tags and assigning them to relevant documents.
Just as with documents, you can filter the document list by tags and
only see documents of a certain topic.
标签可以以多种不同的方式使用。将标签视为更通用的文件夹或活页夹。如果您有与大学/您的汽车或医疗保健相关的文件活页夹,您可以通过创建标签并将其分配给相关文件来无纸化地创建这些活页夹。与文档一样,您可以按标签过滤文档列表,并且仅查看特定主题的文档。
With physical documents, you'll often need to decide which folder the
document belongs to. The advantage of tags over folders and binders is
that a single document can have multiple tags. A physical document
cannot magically appear in two different folders, but with tags, this is
entirely possible.
对于物理文档,您通常需要决定文档属于哪个文件夹。标签相对于文件夹和活页夹的优点是单个文档可以有多个标签。一个物理文档不能神奇地出现在两个不同的文件夹中,但是有了标签,这完全有可能。
Tip 提示
This can be used in many different ways. One example: Imagine you're
working on a particular task, such as signing up for university. Usually
you'll need to collect a bunch of different documents that are already
sorted into various folders. With the tag system of paperless, you can
create a new group of documents that are relevant to this task without
destroying the already existing organization. When you're done with the
task, you could delete the tag again, which would be equal to sorting
documents back into the folder they belong into. Or keep the tag, up to
you.
这可以以多种不同的方式使用。一个例子:假设您正在执行一项特定任务,例如报名大学。通常,您需要收集一堆已分类到各个文件夹中的不同文档。借助无纸化的标签系统,您可以创建一组与此任务相关的新文档,而无需破坏现有的组织。完成任务后,您可以再次删除标签,这相当于将文档重新排序到它们所属的文件夹中。或者保留标签,由您决定。
All of the logic above applies to correspondents as well. Attach them to
documents if you feel that they help you organize your collection.
上述所有逻辑也适用于记者。如果您认为它们可以帮助您组织收藏,请将它们附加到文档中。
When you've started organizing your documents, create a couple saved
views for document collections you regularly access. This is equal to
having labeled physical binders on your desk, except that these saved
views are dynamic and simply update themselves as you add documents to
the system.
当您开始组织文档时,为您经常访问的文档集合创建几个已保存的视图。这相当于在您的办公桌上放置带有标签的物理活页夹,只不过这些保存的视图是动态的,并且在您将文档添加到系统时会自行更新。
Here are a couple examples of tags and types that you could use in your
collection.
以下是您可以在集合中使用的标签和类型的几个示例。
- An
inbox
tag for newly added documents that you haven't manually edited yet.
您尚未手动编辑的新添加文档的inbox
标签。 - A tag
car
for everything car related (repairs, registration, insurance, etc)
一辆标签car
可处理与汽车相关的一切(维修、登记、保险等) - A tag
todo
for documents that you still need to do something with, such as reply, or perform some task online.
标签待办事项,用于todo
您仍需要处理的文档,例如回复或在线执行某些任务。 - A tag
bank account x
for all bank statement related to that account.
与该帐户相关的所有银行对账单的标签bank account x
。 - A tag
mail
for anything that you added to paperless via its mail processing capabilities.
通过其邮件处理功能添加到无纸化的任何内容的标签mail
。 - A tag
missing_metadata
when you still need to add some metadata to a document, but can't or don't want to do this right now.
当您仍然需要向文档添加一些元数据,但现在不能或不想执行此操作时,使用标记missing_metadata
。
Searching 搜寻中
Global search 全球搜索
The top search bar in the web UI performs a "global" search of the various
objects Paperless-ngx uses, including documents, tags, workflows, etc. Only
objects for which the user has appropriate permissions are returned. For
documents, if there are < 3 results, "advanced" search results (which use
the document index) will also be included. This can be disabled under settings.
Web UI 中的顶部搜索栏对 Paperless-ngx 使用的各种对象(包括文档、标签、工作流程等)执行“全局”搜索。仅返回用户具有适当权限的对象。对于文档,如果有 < 3 个结果,还将包括“高级”搜索结果(使用文档索引)。可以在设置下禁用此功能。
Document searches 文件检索
Paperless offers an extensive searching mechanism that is designed to
allow you to quickly find a document you're looking for (for example,
that thing that just broke and you bought a couple months ago, that
contract you signed 8 years ago).
无纸化提供了广泛的搜索机制,旨在让您快速找到您正在寻找的文档(例如,您几个月前购买的刚刚损坏的东西,您 8 年前签署的合同)。
When you search paperless for a document, it tries to match this query
against your documents. Paperless will look for matching documents by
inspecting their content, title, correspondent, type and tags. Paperless
returns a scored list of results, so that documents matching your query
better will appear further up in the search results.
当您无纸化搜索文档时,它会尝试将此查询与您的文档进行匹配。无纸化将通过检查内容、标题、通讯员、类型和标签来查找匹配的文档。无纸化返回结果的评分列表,以便更好地匹配您的查询的文档将出现在搜索结果中的更靠前的位置。
By default, paperless returns only documents which contain all words
typed in the search bar. However, paperless also offers advanced search
syntax if you want to drill down the results further.
默认情况下,无纸化仅返回包含在搜索栏中输入的所有单词的文档。但是,如果您想进一步深入了解结果,无纸化还提供高级搜索语法。
Matching documents with logical expressions:
用逻辑表达式匹配文档:
Matching specific tags, correspondents or types:
匹配特定标签、通讯者或类型:
Matching dates: 匹配日期:
Matching inexact words: 匹配不精确的单词:
Note 笔记
Inexact terms are hard for search indexes. These queries might take a
while to execute. That's why paperless offers auto complete and query
correction.
不精确的术语对于搜索索引来说是困难的。这些查询可能需要一段时间才能执行。这就是无纸化提供自动完成和查询更正的原因。
All of these constructs can be combined as you see fit. If you want to
learn more about the query language used by paperless, paperless uses
Whoosh's default query language. Head over to Whoosh query
language. For
details on what date parsing utilities are available, see Date
parsing.
所有这些结构都可以根据您的需要进行组合。如果您想详细了解无纸化使用的查询语言,无纸化使用的是 Whoosh 的默认查询语言。转到Whoosh 查询语言。有关可用的日期解析实用程序的详细信息,请参阅日期解析。
Keyboard shortcuts / hotkeys
键盘快捷键/热键
A list of available hotkeys can be shown on any page using Shift +
?. The help dialog shows only the keys that are currently available
based on which area of Paperless-ngx you are using.
可以使用以下命令在任何页面上显示可用热键列表 Shift + ? 。帮助对话框仅根据您使用的 Paperless-ngx 区域显示当前可用的按键。
The recommended workflow 推荐的工作流程
Once you have familiarized yourself with paperless and are ready to use
it for all your documents, the recommended workflow for managing your
documents is as follows. This workflow also takes into account that some
documents have to be kept in physical form, but still ensures that you
get all the advantages for these documents as well.
一旦您熟悉了无纸化并准备好将其用于所有文档,管理文档的推荐工作流程如下。此工作流程还考虑到某些文档必须以物理形式保存,但仍然确保您也能获得这些文档的所有优势。
The following diagram shows how easy it is to manage your documents.
下图显示了管理文档是多么容易。
Preparations in paperless
无纸化准备
- Create an inbox tag that gets assigned to all new documents.
创建一个分配给所有新文档的收件箱标签。 - Create a TODO tag. 创建 TODO 标签。
Processing of the physical documents
物理文件的处理
Keep a physical inbox. Whenever you receive a document that you need to
archive, put it into your inbox. Regularly, do the following for all
documents in your inbox:
保留一个物理收件箱。每当您收到需要存档的文档时,请将其放入收件箱。定期对收件箱中的所有文档执行以下操作:
- For each document, decide if you need to keep the document in
physical form. This applies to certain important documents, such as
contracts and certificates.
对于每个文档,决定是否需要以纸质形式保存该文档。这适用于某些重要文件,例如合同和证书。 - If you need to keep the document, write a running number on the
document before scanning, starting at one and counting upwards. This
is the archive serial number, or ASN in short.
如果您需要保留文档,请在扫描前在文档上写下一个连续编号,从 1 开始向上计数。这是存档序列号,简称 ASN。 - Scan the document. 扫描文档。
- If the document has an ASN assigned, store it in a single binder,
sorted by ASN. Don't order this binder in any other way.
如果文档分配了 ASN,则将其存储在单个活页夹中,并按 ASN 排序。请勿以任何其他方式订购此活页夹。 - If the document has no ASN, throw it away. Yay!
如果文档没有 ASN,请将其丢弃。耶!
Tip 提示
Instead of writing a number on the document by hand, you may also prepare
a spool of labels with barcodes with an ascending serial number, that are
formatted like ASN00001
.
This also enables Paperless to automatically parse and process the ASN
(if enabled in the config), so that you don't need to manually assign it.
您还可以准备一卷带有条形码的标签,这些条形码带有升序序列号,其格式类似于ASN00001
,而不是在文档上手动书写数字。这还使 Paperless 能够自动解析和处理 ASN(如果在配置中启用),因此您无需手动分配它。
Over time, you will notice that your physical binder will fill up. If it
is full, label the binder with the range of ASNs in this binder (i.e.,
"Documents 1 to 343"), store the binder in your cellar or elsewhere,
and start a new binder.
随着时间的推移,您会发现您的物理活页夹将被填满。如果已满,则用该活页夹中的 ASN 范围标记该活页夹(即“文档 1 到 343”),将该活页夹存储在您的地窖或其他地方,然后启动一个新的活页夹。
The idea behind this process is that you will never have to use the
physical binders to find a document. If you need a specific physical
document, you may find this document by:
此过程背后的想法是您永远不必使用物理活页夹来查找文档。如果您需要特定的物理文件,您可以通过以下方式找到该文件:
- Searching in paperless for the document.
无纸化搜索文档。 - Identify the ASN of the document, since it appears on the scan.
识别文档的 ASN,因为它出现在扫描件上。 - Grab the relevant document binder and get the document. This is easy
since they are sorted by ASN.
抓住相关的文件活页夹并获取文件。这很容易,因为它们是按 ASN 排序的。
Processing of documents in paperless
文件处理无纸化
Once you have scanned in a document, proceed in paperless as follows.
扫描文档后,请按照以下方式进行无纸化操作。
- If the document has an ASN, assign the ASN to the document.
如果文档有 ASN,请将 ASN 分配给该文档。 - Assign a correspondent to the document (i.e., your employer, bank,
etc) This isn't strictly necessary but helps in finding a document
when you need it.
为该文档指定一名通讯员(即您的雇主、银行等) 这并不是绝对必要的,但有助于在您需要时查找文档。 - Assign a document type (i.e., invoice, bank statement, etc) to the
document This isn't strictly necessary but helps in finding a
document when you need it.
为文档指定文档类型(即发票、银行对账单等) 这不是绝对必要的,但有助于在需要时查找文档。 - Assign a proper title to the document (the name of an item you
bought, the subject of the letter, etc)
为文档指定适当的标题(您购买的物品的名称、信件的主题等) - Check that the date of the document is correct. Paperless tries to
read the date from the content of the document, but this fails
sometimes if the OCR is bad or multiple dates appear on the
document.
检查文件的日期是否正确。无纸化尝试从文档内容中读取日期,但如果 OCR 损坏或文档上出现多个日期,有时会失败。 - Remove inbox tags from the documents.
从文档中删除收件箱标签。
Tip 提示
You can setup manual matching rules for your correspondents and tags and
paperless will assign them automatically. After consuming a couple
documents, you can even ask paperless to learn when to assign tags and
correspondents by itself. For details on this feature, see
advanced matching.
您可以为您的联系人和标签设置手动匹配规则,无纸化将自动分配它们。使用完几个文档后,您甚至可以要求无纸化系统自行了解何时分配标签和通讯员。有关此功能的详细信息,请参阅高级匹配。
Task management 任务管理
Some documents require attention and require you to act on the document.
You may take two different approaches to handle these documents based on
how regularly you intend to scan documents and use paperless.
有些文件需要注意并要求您根据该文件采取行动。根据您打算扫描文档和使用无纸化的频率,您可以采用两种不同的方法来处理这些文档。
- If you scan and process your documents in paperless regularly,
assign a TODO tag to all scanned documents that you need to process.
Create a saved view on the dashboard that shows all documents with
this tag.
如果您定期以无纸化方式扫描和处理文档,请为需要处理的所有扫描文档分配一个 TODO 标签。在仪表板上创建一个保存的视图,显示带有此标签的所有文档。 - If you do not scan documents regularly and use paperless solely for
archiving, create a physical todo box next to your physical inbox
and put documents you need to process in the TODO box. When you
performed the task associated with the document, move it to the
inbox.
如果您不定期扫描文档并仅使用无纸化方式进行归档,请在物理收件箱旁边创建一个物理待办事项框,并将需要处理的文档放入待办事项框中。当您执行与文档关联的任务时,将其移至收件箱。
Architecture 建筑学
Paperless-ngx consists of the following components:
Paperless-ngx 由以下组件组成:
-
The webserver: This serves the administration pages, the API, and the new frontend. This is the main tool you'll be using to interact with paperless. You may start the webserver directly with
网络服务器:它提供管理页面、API 和新前端。这是您将用来与无纸化交互的主要工具。您可以直接启动网络服务器or by any other means such as Apache
mod_wsgi
.
或通过任何其他方式,例如 Apachemod_wsgi
。 -
The consumer: This is what watches your consumption folder for documents. However, the consumer itself does not really consume your documents. Now it notifies a task processor that a new file is ready for consumption. I suppose it should be named differently. This was also used to check your emails, but that's now done elsewhere as well.
消费者:这是监视您的消费文件夹中的文档的人。然而,消费者本身并没有真正消费你的文档。现在,它通知任务处理器有一个新文件可供使用。我想它应该以不同的方式命名。这也用于检查您的电子邮件,但现在也在其他地方完成。Start the consumer with the management command
document_consumer
:
使用管理命令document_consumer
启动消费者: -
The task processor: Paperless relies on Celery - Distributed Task Queue for doing most of the heavy lifting. This is a task queue that accepts tasks from multiple sources and processes these in parallel. It also comes with a scheduler that executes certain commands periodically.
任务处理器: Paperless 依靠Celery - 分布式任务队列来完成大部分繁重的工作。这是一个任务队列,它接受来自多个源的任务并并行处理这些任务。它还带有一个定期执行某些命令的调度程序。This task processor is responsible for:
该任务处理器负责:- Consuming documents. When the consumer finds new documents, it
notifies the task processor to start a consumption task.
消费文件。当消费者发现新文档时,通知任务处理器启动消费任务。 - The task processor also performs the consumption of any
documents you upload through the web interface.
任务处理器还执行您通过 Web 界面上传的任何文档的消耗。 - Consuming emails. It periodically checks your configured
accounts for new emails and notifies the task processor to
consume the attachment of an email.
消费电子邮件。它会定期检查您配置的帐户中是否有新电子邮件,并通知任务处理器使用电子邮件的附件。 - Maintaining the search index and the automatic matching
algorithm. These are things that paperless needs to do from time
to time in order to operate properly.
维护搜索索引和自动匹配算法。这些是无纸化为了正常运行而需要不时做的事情。
This allows paperless to process multiple documents from your consumption folder in parallel! On a modern multi core system, this makes the consumption process with full OCR blazingly fast.
这允许无纸化并行处理您的消费文件夹中的多个文档!在现代多核系统上,这使得完整 OCR 的使用过程非常快。The task processor comes with a built-in admin interface that you can use to check whenever any of the tasks fail and inspect the errors (i.e., wrong email credentials, errors during consuming a specific file, etc).
任务处理器附带一个内置管理界面,您可以使用它来检查任何任务失败的情况并检查错误(即错误的电子邮件凭据、使用特定文件期间的错误等)。 - Consuming documents. When the consumer finds new documents, it
notifies the task processor to start a consumption task.
-
A redis message broker: This is a really lightweight service that is responsible for getting the tasks from the webserver and the consumer to the task scheduler. These run in a different process (maybe even on different machines!), and therefore, this is necessary.
Redis消息代理:这是一个真正的轻量级服务,负责将任务从 Web 服务器和使用者获取到任务调度程序。它们在不同的进程中运行(甚至可能在不同的机器上!),因此这是必要的。 -
Optional: A database server. Paperless supports PostgreSQL, MariaDB and SQLite for storing its data.
可选:数据库服务器。 Paperless 支持 PostgreSQL、MariaDB 和 SQLite 来存储数据。