mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-07-28 18:24:38 -05:00
Documentation: update docs, screenshots ahead of Paperless-ngx v2.0 (#4542)
* Reformat internal links * Update screenshots, docs & readme * Use image lightbox * Fix nested list on docs index * Add some visual interest to screenshots layout * Compress images
This commit is contained in:
shamoon
188
docs/index.md
188
docs/index.md
@@ -5,7 +5,7 @@
|
||||
**Paperless-ngx** is a _community-supported_ open-source document management system that transforms your
|
||||
physical documents into a searchable online archive so you can keep, well, _less paper_.
|
||||
|
||||
[Get started](/setup){ .md-button .md-button--primary .index-callout }
|
||||
[Get started](setup.md){ .md-button .md-button--primary .index-callout }
|
||||
[Demo](https://demo.paperless-ngx.com){ .md-button .md-button--secondary target=\_blank }
|
||||
|
||||
</div>
|
||||
@@ -15,103 +15,159 @@ physical documents into a searchable online archive so you can keep, well, _less
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
## Why This Exists
|
||||
## Features
|
||||
|
||||
Paper is a nightmare. Environmental issues aside, there's no excuse for
|
||||
it in the 21st century. It takes up space, collects dust, doesn't
|
||||
support any form of a search feature, indexing is tedious, it's heavy
|
||||
and prone to damage & loss.
|
||||
- **Organize and index** your scanned documents with tags, correspondents, types, and more.
|
||||
- Performs **OCR** on your documents, adding selectable text to image-only documents.
|
||||
- Uses machine-learning to automatically add tags, correspondents and document types to your documents.
|
||||
- Supports PDF documents, images, plain text files, Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents)[^1] and more.
|
||||
- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely with different configurations assigned to different documents.
|
||||
- **Beautiful, modern web application** that features:
|
||||
- Customizable dashboard with statistics.
|
||||
- Filtering by tags, correspondents, types, and more.
|
||||
- Bulk editing of tags, correspondents, types and more.
|
||||
- Drag-and-drop uploading of documents throughout the app.
|
||||
- Customizable views can be saved and displayed on the dashboard and / or sidebar.
|
||||
- Support for custom fields of various data types.
|
||||
- Shareable public links with optional expiration.
|
||||
- **Full text search** helps you find what you need:
|
||||
- Auto completion suggests relevant words from your documents.
|
||||
- Results are sorted by relevance to your search query.
|
||||
- Highlighting shows you which parts of the document matched the query.
|
||||
- Searching for similar documents ("More like this")
|
||||
- **Email processing**[^1]: import documents from your email accounts:
|
||||
- Configure multiple accounts and rules for each account.
|
||||
- After processing, paperless can perform actions on the messages such as marking as read, deleting and more.
|
||||
- A built-in robust **multi-user permissions** system that supports 'global' permissions as well as per document or object.
|
||||
- A powerful templating system that gives you more control over the consumption pipeline.
|
||||
- **Optimized** for multi core systems: Paperless-ngx consumes multiple documents in parallel.
|
||||
- The integrated sanity checker makes sure that your document archive is in good health.
|
||||
|
||||
This software is designed to make "going paperless" easier. No more worrying
|
||||
about finding stuff again, feed documents right from the post box into
|
||||
the scanner and then shred them. Perhaps you might find it useful too.
|
||||
[^1]: Office document and email consumption support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
|
||||
|
||||
## Paperless, a history
|
||||
|
||||
Paperless is a simple Django application running in two parts: a
|
||||
_Consumer_ (the thing that does the indexing) and the _Web server_ (the
|
||||
part that lets you search & download already-indexed documents). If you
|
||||
want to learn more about its functions keep on reading after the
|
||||
installation section.
|
||||
Paperless-ngx is the official successor to the original [Paperless](https://github.com/the-paperless-project/paperless) & [Paperless-ng](https://github.com/jonaswinkler/paperless-ng) projects and is designed to distribute the responsibility of advancing and supporting the project among a team of people. [Consider joining us!](https://github.com/paperless-ngx/paperless-ngx#community-support)
|
||||
|
||||
Paperless-ngx is a document management system that transforms your
|
||||
physical documents into a searchable online archive so you can keep,
|
||||
well, _less paper_.
|
||||
|
||||
Paperless-ngx forked from paperless-ng to continue the great work and
|
||||
distribute responsibility of supporting and advancing the project among
|
||||
a team of people.
|
||||
|
||||
NG stands for both Angular (the framework used for the Frontend) and
|
||||
next-gen. Publishing this project under a different name also avoids
|
||||
confusion between paperless and paperless-ngx.
|
||||
|
||||
If you want to learn about what's different in paperless-ngx from
|
||||
Paperless, check out these resources in the documentation:
|
||||
|
||||
- [Some screenshots](#screenshots) of the new UI are available.
|
||||
- Read [this section](/advanced_usage#automatic-matching) if you want to learn about how paperless automates all
|
||||
tagging using machine learning.
|
||||
- Paperless now comes with a [proper email consumer](/usage#usage-email) that's fully tested and production ready.
|
||||
- Paperless creates searchable PDF/A documents from whatever you put into the consumption directory. This means
|
||||
that you can select text in image-only documents coming from your scanner.
|
||||
- See [this note](/administration#encryption) about GnuPG encryption in paperless-ngx.
|
||||
- Paperless is now integrated with a
|
||||
[task processing queue](/setup#task_processor) that tells you at a glance when and why something is not working.
|
||||
- The [changelog](/changelog) contains a detailed list of all changes in paperless-ngx.
|
||||
Further discussion of the transition between these projects can be found at
|
||||
[ng#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [ng#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
|
||||
|
||||
## Screenshots
|
||||
|
||||
This is what Paperless-ngx looks like.
|
||||
Paperless-ngx aims to be as nice to use as it is useful. Check out some screenshots below.
|
||||
|
||||
The dashboard shows customizable views on your document and allows
|
||||
document uploads:
|
||||
<div class="grid-flipped-left" markdown>
|
||||
|
||||
</div>
|
||||
<div class="grid-flipped-right" markdown>
|
||||
The dashboard shows saved views which can be sorted. Documents can be uploaded with the button or dropped anywhere in the application.
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
[](assets/screenshots/dashboard.png)
|
||||
The document list provides three different styles to browse your documents.
|
||||
|
||||
The document list provides three different styles to scroll through your
|
||||
documents:
|
||||
{: style="width:32%"}
|
||||
{: style="width:32%"}
|
||||
{: style="width:32%"}
|
||||
|
||||
[](assets/screenshots/documents-table.png)
|
||||
<div class="clear"></div>
|
||||
|
||||
[](assets/screenshots/documents-smallcards.png)
|
||||
<div class="grid-left" markdown>
|
||||
Use the 'slim' sidebar to focus on your docs and minimize the UI.
|
||||
</div>
|
||||
<div class="grid-right" markdown>
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
[](assets/screenshots/documents-largecards.png)
|
||||
Of course, Paperless-ngx also supports dark mode:
|
||||
|
||||
Paperless-ngx also supports dark mode:
|
||||
|
||||
|
||||
[](assets/screenshots/documents-smallcards-dark.png)
|
||||
<div class="clear"></div>
|
||||
|
||||
Extensive filtering mechanisms:
|
||||
<div class="grid-left" markdown>
|
||||
Quickly find documents with extensive filtering mechanisms.
|
||||
</div>
|
||||
<div class="grid-right" markdown>
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
<div class="grid-left" markdown>
|
||||
And perform bulk edit operations to set tags, correspondents, etc. as well as permissions.
|
||||
</div>
|
||||
<div class="grid-right" markdown>
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
[](assets/screenshots/documents-filter.png)
|
||||
Side-by-side editing of documents.
|
||||
|
||||
Bulk editing of document tags, correspondents, etc.:
|
||||
|
||||
|
||||
[](assets/screenshots/bulk-edit.png)
|
||||
<div class="grid-left" markdown>
|
||||
Support for custom fields.
|
||||
|
||||
Side-by-side editing of documents:
|
||||
|
||||
|
||||
[](assets/screenshots/editing.png)
|
||||
</div>
|
||||
<div class="grid-right" markdown>
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
Tag editing. This looks about the same for correspondents and document
|
||||
types.
|
||||
<div class="grid-left" markdown>
|
||||
A robust permissions system with support for 'global' and document / object permissions.
|
||||
|
||||
[](assets/screenshots/new-tag.png)
|
||||
|
||||
|
||||
Searching provides auto complete and highlights the results.
|
||||
</div>
|
||||
<div class="grid-right" markdown>
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
[](assets/screenshots/search-preview.png)
|
||||
<div class="grid-left" markdown>
|
||||
Searching provides auto complete and highlights the results.
|
||||
|
||||
[](assets/screenshots/search-results.png)
|
||||
|
||||
|
||||
Fancy mail filters!
|
||||
</div>
|
||||
<div class="grid-right" markdown>
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
[](assets/screenshots/mail-rules-edited.png)
|
||||
Tag, correspondent, document type and storage path editing.
|
||||
|
||||
{: style="width:21%; float: left"}
|
||||
{: style="width:21%; margin-left: 4%; float: left"}
|
||||
{: style="width:21%; margin-left: 4%; float: left"}
|
||||
{: style="width:21%; margin-left: 4%; float: left"}
|
||||
|
||||
<div class="clear"></div>
|
||||
|
||||
<div class="grid-half-left" markdown>
|
||||
Mail rules support various filters and actions for incoming e-mails.
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="grid-half-right" markdown>
|
||||
Consumption templates provide finer control over the document pipeline.
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
|
||||
<div class="clear"></div>
|
||||
|
||||
Mobile devices are supported.
|
||||
|
||||
[](assets/screenshots/mobile.png)
|
||||
{: style="width:32%"}
|
||||
{: style="width:32%"}
|
||||
{: style="width:32%"}
|
||||
|
||||
## Support
|
||||
|
||||
@@ -131,7 +187,7 @@ People interested in continuing the work on paperless-ngx are encouraged to reac
|
||||
|
||||
### Translation
|
||||
|
||||
Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you!
|
||||
Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to the [Paperless-ngx project at Crowdin](https://crwd.in/paperless-ngx), and thank you!
|
||||
|
||||
## Scanners & Software
|
||||
|
||||
|
||||
Reference in New Issue
Block a user