paperless-ngx_ynh/README.md

Paperless-ngx for YunoHost

Lire ce readme en français.

This package allows you to install Paperless-ngx quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.

Features

• 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).
• 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.
• Full text search helps you find what you need.
• Email processing: Paperless adds documents from your email accounts.
• Machine learning powered document matching.
• 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.

Shipped version: 1.11.0~ynh1

Demo: https://demo.paperless-ngx.com/

Screenshots

Disclaimers / important information

• This app require a dedicated domain.

• There is no LDAP or SSO support.

• Paperless is performing OCR on documents and images. English is installed by default. More languages can be installed:

  • Display a list of all Tesseract language packs apt-cache search tesseract-ocr
  • Install additional language packs
    • Example for french sudo apt-get install tesseract-ocr-fra
    • Example for german sudo apt-get install tesseract-ocr-deu
  • Modify config to add new languages
    • Open config-panel: https://my-domain.tld/yunohost/admin/#/apps/$app_id/config-panel
    • You can combine multiple languages like this:
      • One language: eng
      • Two languages: eng+fra

Documentation and resources

• Official app website: https://paperless-ngx.com
• Official user documentation: https://paperless-ngx.readthedocs.io/en/latest/usage_overview.html
• Official admin documentation: https://paperless-ngx.readthedocs.io/en/latest/index.html
• Upstream app code repository: https://github.com/paperless-ngx/paperless-ngx
• YunoHost documentation for this app: https://yunohost.org/app_paperless-ngx
• Report a bug: https://github.com/YunoHost-Apps/paperless-ngx_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug
or
sudo yunohost app upgrade paperless-ngx -u https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps