mirror of
https://github.com/YunoHost-Apps/paperless-ngx_ynh.git
synced 2024-09-03 19:56:33 +02:00
69 lines
3.4 KiB
Markdown
69 lines
3.4 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 for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/paperless-ngx)  
|
|
[](https://install-app.yunohost.org/?app=paperless-ngx)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *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](https://yunohost.org/#/install) 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](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html).
|
|
|
|
|
|
**Shipped version:** 1.6~ynh1
|
|
|
|
**Demo:** https://demo.paperless-ngx.com/
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
* This app require a dedicated domain.
|
|
* There no LDAP or SSO. ⚠️ The admin user will recieve a mail after the installation.
|
|
|
|
## 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](https://github.com/YunoHost-Apps/paperless-ngx_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
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>
|