mirror of
https://github.com/YunoHost-Apps/paperless-ngx_ynh.git
synced 2024-09-03 19:56:33 +02:00
81 lines
No EOL
4.1 KiB
Markdown
81 lines
No EOL
4.1 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Paperless-ngx pour YunoHost
|
||
|
||
[![Niveau d’intégration](https://dash.yunohost.org/integration/paperless-ngx.svg)](https://dash.yunohost.org/appci/app/paperless-ngx) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/paperless-ngx.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/paperless-ngx.maintain.svg)
|
||
|
||
[![Installer Paperless-ngx avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=paperless-ngx)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d’installer Paperless-ngx rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
||
|
||
## Vue d’ensemble
|
||
|
||
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](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html).
|
||
|
||
|
||
**Version incluse :** 1.13.0~ynh1
|
||
|
||
**Démo :** https://demo.paperless-ngx.com/
|
||
|
||
## Captures d’écran
|
||
|
||
![Capture d’écran de Paperless-ngx](./doc/screenshots/documents-wchrome-dark.png)
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
* 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
|
||
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l’app : <https://paperless-ngx.com>
|
||
* Documentation officielle utilisateur : <https://paperless-ngx.readthedocs.io/en/latest/usage_overview.html>
|
||
* Documentation officielle de l’admin : <https://paperless-ngx.readthedocs.io/en/latest/index.html>
|
||
* Dépôt de code officiel de l’app : <https://github.com/paperless-ngx/paperless-ngx>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_paperless-ngx>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/paperless-ngx_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade paperless-ngx -u https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps> |