YunoHost-Apps/paperless-ngx_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/paperless-ngx_ynh.git synced 2024-09-03 19:56:33 +02:00
Code Issues Activity Actions 1
Scan, index and archive all your physical documents
8 commits 2 branches 0 tags 1.7 MiB
Shell 100%
Find a file
yunohost-bot a76e15bd52 Auto-update README
2022-08-02 23:25:20 +00:00
.github Initial commit 2022-03-29 11:08:51 +02:00
conf [wip] Initial release 2022-03-29 15:52:26 +00:00
doc Fix README 2022-03-29 16:48:53 +00:00
scripts [wip] Initial release 2022-03-29 15:52:26 +00:00
sources Initial commit 2022-03-29 11:08:51 +02:00
.gitignore Initial commit 2022-03-29 11:08:51 +02:00
check_process [wip] Initial release 2022-03-29 15:52:26 +00:00
config_panel.toml.example Initial commit 2022-03-29 11:08:51 +02:00
LICENSE Fix license 2022-03-29 16:05:04 +00:00
manifest.json Fix license 2022-03-29 16:05:04 +00:00
README.md Auto-update README 2022-08-02 23:25:20 +00:00
README_fr.md Auto-update README 2022-08-02 23:25:20 +00:00

README.md

Paperless-ngx for YunoHost

Integration level Working status Maintenance status
Install Paperless-ngx with 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.6~ynh1

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

Screenshots

Screenshot of Paperless-ngx

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

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