mirror of https://github.com/YunoHost-Apps/paperless-ngx_ynh.git synced 2024-09-03 19:56:33 +02:00

Scan, index and archive all your physical documents

Find a file

YunoHost Bot 6fe8b2aee2 Upgrade to v2.2.1 (#58 ) * Upgrade to v2.2.1 * Auto-update README		2023-12-29 09:34:12 +01:00
.github	Merge pull request #16 from YunoHost-Apps/testing	2023-05-05 23:42:53 +02:00
conf	Convert to packaging v2 (#23 ) (#24 )	2023-06-16 21:08:15 +02:00
doc	Update and rename PRE_INSTALL.md to ADMIN.md	2023-07-09 17:40:11 +02:00
scripts	Convert to packaging v2 (#23 ) (#24 )	2023-06-16 21:08:15 +02:00
sources	Initial commit	2022-03-29 11:08:51 +02:00
.gitignore	Initial commit	2022-03-29 11:08:51 +02:00
config_panel.toml	Convert to packaging v2 (#23 ) (#24 )	2023-06-16 21:08:15 +02:00
LICENSE	Fix license	2022-03-29 16:05:04 +00:00
manifest.toml	Upgrade to v2.2.1 (#58 )	2023-12-29 09:34:12 +01:00
README.md	Upgrade to v2.2.1 (#58 )	2023-12-29 09:34:12 +01:00
README_fr.md	Upgrade to v2.2.1 (#58 )	2023-12-29 09:34:12 +01:00
tests.toml	Convert to packaging v2 (#23 ) (#24 )	2023-06-16 21:08:15 +02:00

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: 2.2.1~ynh1

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

Screenshots

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 Store: https://apps.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