# Paperless Readme

<div dir="auto" id="bkmrk--1"></div><div dir="auto" id="bkmrk-%21%5Bimage%5D%28assets%2Fscre"></div>## Features

<div class="markdown-heading" dir="auto" id="bkmrk--3">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#features)</div>- **Organize and index** your scanned documents with tags, correspondents, types, and more.
- *Your* data is stored locally on *your* server and is never transmitted or shared in any way.
- Performs **OCR** on your documents, adding searchable and selectable text, even to documents scanned with only images.
- Utilizes the open-source Tesseract engine to recognize more than 100 languages.
- Documents are saved as PDF/A format which is designed for long term storage, alongside the unaltered originals.
- 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)<sup>[1](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#user-content-fn-1-67069eea2fc7f57a068dda7458e99b56)</sup> 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**<sup>[1](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#user-content-fn-1-67069eea2fc7f57a068dda7458e99b56)</sup>: 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 workflow system that gives you even more control.
- **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.

## Paperless, a history

<div class="markdown-heading" dir="auto" id="bkmrk--5">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#paperless-a-history)</div>Paperless-ngx is the official successor to the original [Paperless](https://github.com/the-paperless-project/paperless) &amp; [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)

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

<div class="markdown-heading" dir="auto" id="bkmrk--7">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#screenshots)</div>Paperless-ngx aims to be as nice to use as it is useful. Check out some screenshots below.

<div dir="auto" id="bkmrk-the-dashboard-shows-">The dashboard shows saved views which can be sorted. Documents can be uploaded with the button or dropped anywhere in the application.</div><div dir="auto" id="bkmrk--9">  
</div>The document list provides three different styles to browse your documents.

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/W0Cgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/W0Cgrafik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/TMografik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/TMografik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/e0ngrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/e0ngrafik.png)

<div dir="auto" id="bkmrk--13"></div><div dir="auto" id="bkmrk-use-the-%27slim%27-sideb">Use the 'slim' sidebar to focus on your docs and minimize the UI.</div><div dir="auto" id="bkmrk-%21%5Bimage%5D%28assets%2Fscre-2">  
</div><div dir="auto" id="bkmrk--14">  
</div>Of course, Paperless-ngx also supports dark mode:

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/Fqsgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/Fqsgrafik.png)

<div dir="auto" id="bkmrk--17">  
</div><div dir="auto" id="bkmrk-quickly-find-documen">Quickly find documents with extensive filtering mechanisms.</div><div dir="auto" id="bkmrk--18"></div><div dir="auto" id="bkmrk-and-perform-bulk-edi">And perform bulk edit operations to set tags, correspondents, etc. as well as permissions.</div><div dir="auto" id="bkmrk--19"></div>Side-by-side editing of documents.

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/qH7grafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/qH7grafik.png)

<div dir="auto" id="bkmrk-support-for-custom-f">Support for custom fields.</div>[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/J5ografik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/J5ografik.png)

<div dir="auto" id="bkmrk--24"></div><div dir="auto" id="bkmrk-a-robust-permissions">A robust permissions system with support for 'global' and document / object permissions.</div>[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/AqKgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/AqKgrafik.png)

<div dir="auto" id="bkmrk--27"></div><div dir="auto" id="bkmrk-searching-provides-a">Searching provides auto complete and highlights the results.</div>[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/xRYgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/xRYgrafik.png)

<div dir="auto" id="bkmrk--30"></div>Tag, correspondent, document type and storage path editing.

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/zYdgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/zYdgrafik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/uyfgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/uyfgrafik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/aV4grafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/aV4grafik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/zN0grafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/zN0grafik.png)

<div dir="auto" id="bkmrk--35">  
</div><div dir="auto" id="bkmrk-mail-rules-support-v">Mail rules support various filters and actions for incoming e-mails.</div>[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/VR9grafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/VR9grafik.png)

<div dir="auto" id="bkmrk-workflows-provide-fi">Workflows provide finer control over the document pipeline and trigger actions.</div>[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/l2wgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/l2wgrafik.png)

<div dir="auto" id="bkmrk--40">  
</div><div dir="auto" id="bkmrk--41">  
</div>Mobile devices are supported.

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/35Pgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/35Pgrafik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/M9Ngrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/M9Ngrafik.png)

[![grafik.png](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/scaled-1680-/O3Dgrafik.png)](https://bst.wkmimnl.de/uploads/images/gallery/2025-03/O3Dgrafik.png)

## Support

<div class="markdown-heading" dir="auto" id="bkmrk--46">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#support)</div>Community support is available via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/) and [the Matrix chat room](https://matrix.to/#/#paperless:matrix.org).

### Feature Requests

<div class="markdown-heading" dir="auto" id="bkmrk--48">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#feature-requests)</div>Feature requests can be submitted via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests) where you can search for existing ideas, add your own and vote for the ones you care about.

### Bugs

<div class="markdown-heading" dir="auto" id="bkmrk--50">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#bugs)</div>For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/issues) or [start a discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/support) if you have questions.

## Contributing

<div class="markdown-heading" dir="auto" id="bkmrk--52">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#contributing)</div>People interested in continuing the work on paperless-ngx are encouraged to reach out on [GitHub](https://github.com/paperless-ngx/paperless-ngx) or [the Matrix chat room](https://matrix.to/#/#paperless:matrix.org). If you would like to contribute to the project on an ongoing basis there are multiple teams (frontend, ci/cd, etc) that could use your help so please reach out!

### Translation

<div class="markdown-heading" dir="auto" id="bkmrk--54">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#translation)</div>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 &amp; Software

<div class="markdown-heading" dir="auto" id="bkmrk--56">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#scanners--software)</div>Paperless-ngx is compatible with many different scanners and scanning tools. A user-maintained list of scanners and other software is available on [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Scanner-&-Software-Recommendations).

<section class="footnotes" data-footnotes="" id="bkmrk-footnotes-office-doc">## Footnotes

1. Office document and email consumption support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika)) [↩](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#user-content-fnref-1-67069eea2fc7f57a068dda7458e99b56) [↩<sup>2</sup>](https://github.com/paperless-ngx/paperless-ngx/blob/dev/docs/index.md#user-content-fnref-1-2-67069eea2fc7f57a068dda7458e99b56)

</section>