6ca9caf062
**Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes https://github.com/truecharts/public/issues/33114 **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [x] 🪛 Bugfix - [x] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code - [ ] 📜 Documentation Changes **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [x] ⚖️ My code follows the style guidelines of this project - [x] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made changes to the documentation - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [x] ⬆️ I increased versions for any altered app according to semantic versioning - [x] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Co-authored-by: alfi0812 <admin@alfi0812.de>
4.3 KiB
title
| title |
|---|
| Setup Guide |
Paperless-ngx is an open-source document management system that transforms your physical documents into a searchable online archive.
Media Storage
- If you plan on importing documents into Paperless-ngx via a network share, for example from a computer or scanner, it
is recommended to set up an
NFS Sharefor the shared folder.
Configure additional OCR languages
Paperless-ngx supports different configuration options to customize how it performs OCR. The most prominent option is the language or languages used to perform OCR operations. You can skip this section if you only expect to import documents written in English.
Per default OCR is only performed in English. Check the Paperless-ngx documentation regarding the
PAPERLESS_OCR_LANGUAGE (singular) and note what configuration
would best match your use-case. Paperless-ngx only comes with a few OCR languages pre-installed, see the
PAPERLESS_OCR_LANGUAGES (plural) configuration option for more
information, and note if you need this configured too.
Configure import share
In addition to document uploads via the Web UI, Paperless-ngx can import documents from a consumption directory. This would allow you to move new documents to an NFS share from your PC or directly from your scanner and Paperless-ngx would pick up the documents from there. See the explanation of the feature linked above and its configuration options for more information.
This guide will only describe the Paperless-ngx specific options required to set up importing documents from a network share. Please refer to your NAS documentation.
In addition to adding the NFS share to the Paperless-ngx application we need to configure polling for the import folder. The NFS Share do not support the default polling model Paperless-ngx uses.
Example Values for Paperless-ngx
workload:
main:
podSpec:
containers:
main:
env:
PAPERLESS_ADMIN_USER: "admin"
PAPERLESS_ADMIN_PASSWORD: "changeme"
PAPERLESS_ADMIN_MAIL: "admin@admin.com"
PAPERLESS_OCR_LANGUAGE: "eng"
PAPERLESS_OCR_LANGUAGES: "eng fra deu spa ita"
PAPERLESS_CONSUMER_POLLING: 120
persistence:
consume:
type: nfs
# Example NFS Share
server: "192.168.0.10"
path: "/mnt/paperless/"
Configure ForwardAuth authentication
Users that have set up Traefik with ForwardAuth, for example with Authelia can take advantage of authentication through Authelia for their Paperless-ngx installation. Paperless-ngx will honour logins passed from Authelia but not the e-mail address nor the groups of the logged-in user, those will be internal to Paperless-ngx and separate from those in Authelia. ForwardAuth can be added to an existing Paperless-ngx installation as long as the logins of Authelia users match the logins of Paperless-ngx users.
This guide will only describe the Paperless-ngx specific options required to set up ForwardAuth. Please refer to the Traefik + Authelia ForwardAuth setup guide on how to prepare ForwardAuth.
Once you have set up ForwardAuth in your Traefik installation, configure ForwardAuth in Paperless-ngx as follows:
- Add the following environment variables in the values for paperless.
- Enter
PAPERLESS_ENABLE_HTTP_REMOTE_USERand set its value to true, and PAPERLESS_LOGOUT_REDIRECT_URLand your logout URL (https://auth.mydomain.com/logoutas per the above guide's example domain) in the second box.
This will reconfigure and restart Paperless-ngx. Authentication to your Paperless-ngx installation will be handled by Authelia now. Those options can be removed at any time, authentication to your Paperless-ngx installation will then revert to the Paperless-ngx built-in authentication mechanism.
Where to go from here?
Paperless-ngx offers a helpful best practices guide as a starting point, as well as a recommended workflow a little further along on that same page.