2022-03-29 11:08:51 +02:00
<!--
2024-02-16 15:59:00 +01:00
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
2022-03-29 11:08:51 +02:00
It shall NOT be edited by hand.
-->
2022-03-29 18:00:05 +02:00
# Paperless-ngx for YunoHost
2022-03-29 11:08:51 +02:00
2023-02-08 18:27:56 +01:00
[](https://dash.yunohost.org/appci/app/paperless-ngx)  
2023-04-15 22:02:35 +02:00
2022-03-29 18:00:05 +02:00
[](https://install-app.yunohost.org/?app=paperless-ngx)
2022-03-29 11:08:51 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-03-29 18:00:05 +02:00
> *This package allows you to install Paperless-ngx quickly and simply on a YunoHost server.
2022-03-29 11:08:51 +02:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
## Overview
2022-03-29 18:48:53 +02:00
Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, *less paper* .
2022-03-29 11:08:51 +02:00
2022-03-29 18:00:05 +02:00
### Features
2022-03-29 11:08:51 +02:00
2022-03-29 18:48:53 +02:00
* 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 ](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html ).
2022-03-29 11:08:51 +02:00
2024-02-14 13:15:22 +01:00
**Shipped version:** 2.5.1~ynh1
2022-03-29 11:08:51 +02:00
2022-03-29 18:00:05 +02:00
**Demo:** https://demo.paperless-ngx.com/
2022-03-29 11:08:51 +02:00
2022-03-29 18:00:05 +02:00
## Screenshots
2022-03-29 11:08:51 +02:00
2022-08-03 01:25:20 +02:00
2022-03-29 11:08:51 +02:00
## Documentation and resources
2022-08-03 01:25:20 +02:00
* 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 >
2023-11-29 18:58:25 +01:00
* YunoHost Store: < https: // apps . yunohost . org / app / paperless-ngx >
2022-08-03 01:25:20 +02:00
* Report a bug: < https: // github . com / YunoHost-Apps / paperless-ngx_ynh / issues >
2022-03-29 11:08:51 +02:00
## Developer info
2022-03-29 18:00:05 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing ).
2022-03-29 11:08:51 +02:00
To try the testing branch, please proceed like that.
2022-08-03 01:25:20 +02:00
``` bash
2022-03-29 18:00:05 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug
2022-03-29 11:08:51 +02:00
or
2022-03-29 18:00:05 +02:00
sudo yunohost app upgrade paperless-ngx -u https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug
2022-03-29 11:08:51 +02:00
```
2024-02-16 15:59:00 +01:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >
