From ea186516163a256ee47f4341d1483674f151bd5c Mon Sep 17 00:00:00 2001 From: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> Date: Sun, 30 Jul 2023 14:52:06 -0400 Subject: [PATCH] docs(Paperless-ngx): Fix how-to + remove outdated (#11047) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [x] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ 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._ --- charts/stable/paperless-ngx/Chart.yaml | 2 +- charts/stable/paperless-ngx/docs/how-to.md | 22 ++-------------------- 2 files changed, 3 insertions(+), 21 deletions(-) diff --git a/charts/stable/paperless-ngx/Chart.yaml b/charts/stable/paperless-ngx/Chart.yaml index dca035be815..18bce5502c5 100644 --- a/charts/stable/paperless-ngx/Chart.yaml +++ b/charts/stable/paperless-ngx/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: paperless-ngx -version: 1.1.0 +version: 1.1.1 appVersion: "1.16.5" description: Paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents. type: application diff --git a/charts/stable/paperless-ngx/docs/how-to.md b/charts/stable/paperless-ngx/docs/how-to.md index b7ebb78173c..5573723adc7 100644 --- a/charts/stable/paperless-ngx/docs/how-to.md +++ b/charts/stable/paperless-ngx/docs/how-to.md @@ -36,7 +36,7 @@ online archive. Our app is a simple way to install it on your TrueNAS SCALE serv ![Configure paperless-ngx](img/configure_paperless-ngx.png) -Scroll to the bottom of the window and click `Save`. Once you hit Save Paperless-ngx will be donwloaded and configured. +Scroll to the bottom of the window and click `Save`. Once you hit Save Paperless-ngx will be donwloaded and configured. Switch back to the `Installed Applications` tab, and wait for the application to switch from `Deploying` to `Active`. Once `paperless-ngx` shows `Active` you can click its `Open` button to launch to its login screen. Use the initial Admin @@ -54,23 +54,6 @@ would best match your use-case. Paperless-ngx only comes with a few OCR language [`PAPERLESS_OCR_LANGUAGES` (plural)](https://docs.paperless-ngx.com/configuration/#docker) configuration option for more information, and note if you need this configured too. -Apply those options to your Paperless-ngx installation as follows: - -- Select `Apps` inside the TrueNAS menu. -- You should be on the `Installed Applications` tab. -- Look for your `paperless-ngx` installation. -- Click the 3-button menu in its box and select `Edit`. This will open the application configuration pane similar to the - configuration page on installation. - - Scroll down to the `Extra Environment Variables` section and click `Add`, once or twice depending on whether you - need to add one or both of the above options. - - Enter each option and its value in a separate box. - -![OCR configuration for paperless-ngx](img/ocr_configuration_for_paperless-ngx.png) - -Scroll to the bottom of the window and click `Save`. This will reconfigure and restart Paperless-ngx. OCR operations -performed on documents imported after this change will take the additional languages into account. Those options can be -changed at any time and will apply to all new OCR operations performed after changes. - ### Configure import share In addition to document uploads via the Web UI, Paperless-ngx can import documents from a [consumption @@ -103,8 +86,7 @@ Once you have set up the NFS share, configure your Paperless-ngx installation as - Scroll down to the `Extra Environment Variables` section and click `Add`. - Enter the name `PAPERLESS_CONSUMER_POLLING` and the value `120`, Paperless-ngx will then look for new documents in the import share every 120 seconds (2 minutes). - - Scroll further down to the `To-be consumed Document Storage` section and set `Type of Storage` to `NFS Share`, `NFS - Server` to `localhost` and `Path on NFS Server` to the path you configured above. + - Scroll further down to the `To-be consumed Document Storage` section and set `Type of Storage` to `NFS Share`, `NFS Server` to `localhost` and `Path on NFS Server` to the path you configured above. ![Consumer polling configuration for paperless-ngx](img/consumer_polling_configuration_for_paperless-ngx.png) ![To-be consumed document storage configuration for paperless-ngx](img/to-be_consumed_document_storage_configuration_for_paperless-ngx.png)