README

Paperless-ngx

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 is the official successor to the original Paperless & Paperless-ng projects and is designed to distribute the responsibility of advancing and supporting the project among a team of people. Consider joining us!

Thanks to the generous folks at Fyra Stack, a demo is available at demo.paperless-ngx.com using login demo / demo. _Note: demo content is reset frequently and confidential information should not be uploaded._

- Features
- Getting started
- Contributing
  - Community Support
  - Translation
  - Feature Requests
  - Bugs
- Related Projects
- Important Note

Demo hosting provided by:
  
     Fyra Stack
  


 Features


  
  
  


A full list of features and screenshots are available in the documentation.

 Getting started

The easiest way to deploy paperless is docker compose. The files in the /docker/compose directory are configured to pull the image from the GitHub container registry.

If you'd like to jump right in, you can configure a docker compose environment with our install script:

bash
bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"


More details and step-by-step guides for alternative installation methods can be found in the documentation.

Migrating from Paperless-ng is easy, just drop in the new docker image! See the documentation on migrating for more details.



 Documentation

The documentation for Paperless-ngx is available at https://docs.paperless-ngx.com.

 Contributing

If you feel like contributing to the project, please do! Bug fixes, enhancements, visual fixes etc. are always welcome. If you want to implement something big: Please start a discussion about that! The documentation has some basic information on how to get started.

 Community Support

People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the Matrix Room. 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

Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crowdin.com/project/paperless-ngx, and thank you! More details can be found in CONTRIBUTING.md.

 Feature Requests

Feature requests can be submitted via GitHub Discussions, you can search for existing ideas, add your own and vote for the ones you care about.

 Bugs

For bugs please open an issue or start a discussion if you have questions.

 Related Projects

Please see the wiki for a user-maintained list of related projects and software that is compatible with Paperless-ngx.

 Important Note

 Document scanners are typically used to scan sensitive docume

Discussions

Latest release

paperless-ngx 3.4.2

 Bug Fixes

- Fix: mobile save button display obsessing @shamoon (14676)
- Fix: make index and llmindex init wait for tesseract language install @stumpylog (14670)
- Fix: prevent loss of save view name on save + close @shamoon (14667)
- Fixhancement: doc detail mobile ux tweaks @shamoon (14664)
- Fix: Bumps filelock to 4.2.6 to pick up ACL related fixes @stumpylog (14656)
- Fix: ensure import bulk\_edit tasks in Celery workers @shamoon (14653)
- Fixhancement: add tag names to document history list @shamoon (14625)
- Fix: add button type to zoom buttons to preven