diff --git a/README.md b/README.md index 53ec7d068..5648e88c5 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,7 @@ 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](https://github.com/jonaswinkler/paperless-ng) to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support) Discussion of this transition can be found in issues -[#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632). +Paperless-ngx is the official successor to the original 'Paperless' & 'Paperless-ng' projects and is designed distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support). A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com) using login `demo` / `demo`. _Note: demo content is reset frequently and confidential information should not be uploaded._ @@ -36,28 +35,7 @@ A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com)   -- Organize and index your scanned documents with tags, correspondents, types, and more. -- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents. -- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents). - - Office document support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika)) -- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely. -- Single page application front end. - - Includes a dashboard that shows basic statistics and has document upload. - - Filtering by tags, correspondents, types, and more. - - Customizable views can be saved and displayed on the dashboard. -- 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: Paperless adds documents from your email accounts. - - Configure multiple accounts and filters for each account. - - When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them. -- Machine learning powered document matching. - - Paperless-ngx learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless. -- 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. -- [More screenshots are available in the documentation](https://docs.paperless-ngx.com/#screenshots). +A full list of [features](https://docs.paperless-ngx.com/#features) and [screenshots](https://docs.paperless-ngx.com/#screenshots) are available in the [documentation](https://docs.paperless-ngx.com/). # Getting started diff --git a/docs/assets/screenshots/bulk-edit.png b/docs/assets/screenshots/bulk-edit.png index 3d96dad24..3d21be1fe 100644 Binary files a/docs/assets/screenshots/bulk-edit.png and b/docs/assets/screenshots/bulk-edit.png differ diff --git a/docs/assets/screenshots/consumption_template.png b/docs/assets/screenshots/consumption_template.png new file mode 100644 index 000000000..f32bc4cc9 Binary files /dev/null and b/docs/assets/screenshots/consumption_template.png differ diff --git a/docs/assets/screenshots/correspondents.png b/docs/assets/screenshots/correspondents.png index 00fa4cba8..cac31e24f 100644 Binary files a/docs/assets/screenshots/correspondents.png and b/docs/assets/screenshots/correspondents.png differ diff --git a/docs/assets/screenshots/custom_field1.png b/docs/assets/screenshots/custom_field1.png new file mode 100644 index 000000000..59a772f9f Binary files /dev/null and b/docs/assets/screenshots/custom_field1.png differ diff --git a/docs/assets/screenshots/custom_field2.png b/docs/assets/screenshots/custom_field2.png new file mode 100644 index 000000000..9c3b01266 Binary files /dev/null and b/docs/assets/screenshots/custom_field2.png differ diff --git a/docs/assets/screenshots/dashboard.png b/docs/assets/screenshots/dashboard.png index 4bd1ee751..c8f524fae 100644 Binary files a/docs/assets/screenshots/dashboard.png and b/docs/assets/screenshots/dashboard.png differ diff --git a/docs/assets/screenshots/documents-filter.png b/docs/assets/screenshots/documents-filter.png index 972cf5998..2d5fa8e4d 100644 Binary files a/docs/assets/screenshots/documents-filter.png and b/docs/assets/screenshots/documents-filter.png differ diff --git a/docs/assets/screenshots/documents-largecards.png b/docs/assets/screenshots/documents-largecards.png index 0b68ba6e8..189a84768 100644 Binary files a/docs/assets/screenshots/documents-largecards.png and b/docs/assets/screenshots/documents-largecards.png differ diff --git a/docs/assets/screenshots/documents-smallcards-dark.png b/docs/assets/screenshots/documents-smallcards-dark.png index 62db042e6..65620f9a5 100644 Binary files a/docs/assets/screenshots/documents-smallcards-dark.png and b/docs/assets/screenshots/documents-smallcards-dark.png differ diff --git a/docs/assets/screenshots/documents-smallcards-slimsidebar.png b/docs/assets/screenshots/documents-smallcards-slimsidebar.png new file mode 100644 index 000000000..27497fab2 Binary files /dev/null and b/docs/assets/screenshots/documents-smallcards-slimsidebar.png differ diff --git a/docs/assets/screenshots/documents-smallcards.png b/docs/assets/screenshots/documents-smallcards.png index 5c172b23f..decc7d1ac 100644 Binary files a/docs/assets/screenshots/documents-smallcards.png and b/docs/assets/screenshots/documents-smallcards.png differ diff --git a/docs/assets/screenshots/documents-table.png b/docs/assets/screenshots/documents-table.png index 29927daf5..16c3e9ce5 100644 Binary files a/docs/assets/screenshots/documents-table.png and b/docs/assets/screenshots/documents-table.png differ diff --git a/docs/assets/screenshots/documents-wchrome-dark.png b/docs/assets/screenshots/documents-wchrome-dark.png index 66a0eb2bc..65620f9a5 100644 Binary files a/docs/assets/screenshots/documents-wchrome-dark.png and b/docs/assets/screenshots/documents-wchrome-dark.png differ diff --git a/docs/assets/screenshots/documents-wchrome.png b/docs/assets/screenshots/documents-wchrome.png index 16a8ab525..decc7d1ac 100644 Binary files a/docs/assets/screenshots/documents-wchrome.png and b/docs/assets/screenshots/documents-wchrome.png differ diff --git a/docs/assets/screenshots/editing.png b/docs/assets/screenshots/editing.png index c2dd6892e..daacc8e92 100644 Binary files a/docs/assets/screenshots/editing.png and b/docs/assets/screenshots/editing.png differ diff --git a/docs/assets/screenshots/logs.png b/docs/assets/screenshots/logs.png index cd1f37863..d272d304e 100644 Binary files a/docs/assets/screenshots/logs.png and b/docs/assets/screenshots/logs.png differ diff --git a/docs/assets/screenshots/mail-rules-edited.png b/docs/assets/screenshots/mail-rules-edited.png index 42db1d673..af9e3f050 100644 Binary files a/docs/assets/screenshots/mail-rules-edited.png and b/docs/assets/screenshots/mail-rules-edited.png differ diff --git a/docs/assets/screenshots/mobile.png b/docs/assets/screenshots/mobile.png deleted file mode 100644 index 5ac4c96b3..000000000 Binary files a/docs/assets/screenshots/mobile.png and /dev/null differ diff --git a/docs/assets/screenshots/mobile1.png b/docs/assets/screenshots/mobile1.png new file mode 100644 index 000000000..9793a2b17 Binary files /dev/null and b/docs/assets/screenshots/mobile1.png differ diff --git a/docs/assets/screenshots/mobile2.png b/docs/assets/screenshots/mobile2.png new file mode 100644 index 000000000..c6efc28c1 Binary files /dev/null and b/docs/assets/screenshots/mobile2.png differ diff --git a/docs/assets/screenshots/mobile3.png b/docs/assets/screenshots/mobile3.png new file mode 100644 index 000000000..2970a464c Binary files /dev/null and b/docs/assets/screenshots/mobile3.png differ diff --git a/docs/assets/screenshots/new-tag.png b/docs/assets/screenshots/new-tag.png index f763c0ecf..6990be1e7 100644 Binary files a/docs/assets/screenshots/new-tag.png and b/docs/assets/screenshots/new-tag.png differ diff --git a/docs/assets/screenshots/permissions_document.png b/docs/assets/screenshots/permissions_document.png new file mode 100644 index 000000000..e117e5ecf Binary files /dev/null and b/docs/assets/screenshots/permissions_document.png differ diff --git a/docs/assets/screenshots/permissions_global.png b/docs/assets/screenshots/permissions_global.png new file mode 100644 index 000000000..9e3fc7082 Binary files /dev/null and b/docs/assets/screenshots/permissions_global.png differ diff --git a/docs/assets/screenshots/search-preview.png b/docs/assets/screenshots/search-preview.png index 5e7c29049..46dec2dee 100644 Binary files a/docs/assets/screenshots/search-preview.png and b/docs/assets/screenshots/search-preview.png differ diff --git a/docs/assets/screenshots/search-results.png b/docs/assets/screenshots/search-results.png index 5480ef8f1..d62300d12 100644 Binary files a/docs/assets/screenshots/search-results.png and b/docs/assets/screenshots/search-results.png differ diff --git a/docs/configuration.md b/docs/configuration.md index dc7537a1c..f77ec908c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -708,7 +708,7 @@ but could result in missing text content. additional arguments you wish to pass to OCRmyPDF. Since Paperless uses the API of OCRmyPDF, you have to specify these in a format that can be passed to the API. See [the API reference of -OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latestapi.md.html#reference) +OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latest/api.html#reference) for valid parameters. All command line options are supported, but they use underscores instead of dashes. diff --git a/docs/index.md b/docs/index.md index 6b78b444b..456919706 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,62 +15,52 @@ physical documents into a searchable online archive so you can keep, well, _less
-## 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 continue the great work and distribute responsibility of supporting and advancing 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.md#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.md#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.md#encryption) about GnuPG encryption in paperless-ngx. -- Paperless is now integrated with a - [task processing queue](setup.md#task_processor) that tells you at a glance when and why something is not working. -- The [changelog](changelog.md) 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: +The dashboard shows saved views which can be sorted. Documents can be uploaded with the button or dropped anywhere in the application: [](assets/screenshots/dashboard.png) -The document list provides three different styles to scroll through your -documents: +The document list provides three different styles to browser your documents: [](assets/screenshots/documents-table.png) @@ -78,15 +68,19 @@ documents: [](assets/screenshots/documents-largecards.png) +Use the 'slim' sidebar to focus on just your docs: + +[](assets/screenshots/documents-smallcards-slimsidebar.png) + Paperless-ngx also supports dark mode: [](assets/screenshots/documents-smallcards-dark.png) -Extensive filtering mechanisms: +Quickly find documents with extensive filtering mechanisms: [](assets/screenshots/documents-filter.png) -Bulk editing of document tags, correspondents, etc.: +Bulk edit document tags, correspondents, etc. as well as permissions: [](assets/screenshots/bulk-edit.png) @@ -94,24 +88,36 @@ Side-by-side editing of documents: [](assets/screenshots/editing.png) +Support for custom fields: + +[{: style="width:50%; margin-left: 25%"}](assets/screenshots/custom_field1.png) +[](assets/screenshots/custom_field2.png) + +A robust permissions system with support for 'global' and document / object permissions: + +[{: style="width:50%; margin-left: 25%"}](assets/screenshots/permissions_global.png) +[](assets/screenshots/permissions_document.png) + Tag editing. This looks about the same for correspondents and document types. -[](assets/screenshots/new-tag.png) +[{: style="width:50%; margin-left: 25%"}](assets/screenshots/new-tag.png) Searching provides auto complete and highlights the results. -[](assets/screenshots/search-preview.png) +[{: style="width:50%; margin-left: 25%"}](assets/screenshots/search-preview.png) [](assets/screenshots/search-results.png) Fancy mail filters! -[](assets/screenshots/mail-rules-edited.png) +[{: style="width:80%; margin-left: 10%"}](assets/screenshots/mail-rules-edited.png) Mobile devices are supported. -[](assets/screenshots/mobile.png) +[{: style="width:33%"}](assets/screenshots/mobile1.png) +[{: style="width:33%"}](assets/screenshots/mobile2.png) +[{: style="width:33%"}](assets/screenshots/mobile3.png) ## Support @@ -131,7 +137,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 diff --git a/docs/usage.md b/docs/usage.md index 4838f4298..a3e5b3665 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -103,25 +103,14 @@ Typically, you're looking at an FTP server like ### Web UI Upload -The dashboard has a file drop field to upload documents to paperless. -Simply drag a file onto this field or select a file with the file -dialog. Multiple files are supported. - -You can also upload documents on any other page of the web UI by -dragging-and-dropping files into your browser window. +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 {#usage-mobile_upload} -The mobile app over at [https://github.com/qcasey/paperless_share](https://github.com/qcasey/paperless_share) -allows Android users to share any documents with paperless. This can be -combined with any of the mobile scanning apps out there, such as Office -Lens. - -Furthermore, there is the [Paperless -App](https://github.com/bauerj/paperless_app) as well, which not only -has document upload, but also document browsing and download features. - -Another option is [Paperless Mobile](https://github.com/astubenbord/paperless-mobile), an Android app that supports document upload, scanning, management of labels and more. +Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and +software (e.g. for mobile devices) that is compatible with Paperless-ngx. ### IMAP (Email) {#usage-email} @@ -145,9 +134,9 @@ These rules perform the following: 5. If documents were consumed from a mail, the rule action is performed on that mail. -Paperless will completely ignore mails that do not match your filters. -It will also only perform the action on mails that it has consumed -documents from. +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 actions all ensure that the same mail is not consumed twice by different means. These are as follows: @@ -354,6 +343,19 @@ The following custom field types are supported: - `Number`: float number e.g. 12.3456 - `Monetary`: float number with exactly two decimals, e.g. 12.30 +## Share Links + +Paperless-ngx added the abiltiy to create shareable links to files in version 2.0. You can find the button for this on the document detail screen. + +- 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}`. +- 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. + +!!! 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. + ## Best practices {#basic-searching} Paperless offers a couple tools that help you organize your document @@ -645,16 +647,3 @@ Paperless-ngx consists of the following components: - Optional: A database server. Paperless supports PostgreSQL, MariaDB and SQLite for storing its data. - -## Share Links - -Paperless-ngx added the abiltiy to create shareable links to files in version 2.0. You can find the button for this on the document detail screen. - -- 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}`. -- 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. - -!!! 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. diff --git a/mkdocs.yml b/mkdocs.yml index 1e692d68b..f99b45ab3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,6 +42,7 @@ markdown_extensions: - pymdownx.superfences - pymdownx.inlinehilite - pymdownx.snippets + - footnotes strict: true nav: - index.md @@ -64,3 +65,5 @@ extra: link: https://hub.docker.com/r/paperlessngx/paperless-ngx - icon: material/chat link: https://matrix.to/#/#paperless:matrix.org +plugins: + - glightbox