From b89e836e3daf7b7f21259a049ff9f5e6f45c3453 Mon Sep 17 00:00:00 2001 From: Jonas Winkler Date: Wed, 18 Nov 2020 22:56:30 +0100 Subject: [PATCH] updated documentation --- docs/advanced_usage.rst | 2 ++ docs/changelog.rst | 2 ++ docs/faq.rst | 22 +++++++++++++++++++++- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst index 218cfa8b7..6183baae1 100644 --- a/docs/advanced_usage.rst +++ b/docs/advanced_usage.rst @@ -128,6 +128,8 @@ consumer. Once complete, you should see the newly-created document, automatically tagged with the appropriate data. +.. _advanced-automatic_matching: + Automatic matching ================== diff --git a/docs/changelog.rst b/docs/changelog.rst index 36dc9e5cc..9fcf10940 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -96,6 +96,8 @@ paperless-ng 0.9.0 sqlite. * ``PAPERLESS_OCR_THREADS`` is gone and replaced with ``PAPERLESS_TASK_WORKERS`` and ``PAPERLESS_THREADS_PER_WORKER``. Refer to the config example for details. + * ``PAPERLESS_OPTIMIZE_THUMBNAILS`` allows you to disable or enable thumbnail + optimization. This is useful on less powerful devices. * Many more small changes here and there. The usual stuff. diff --git a/docs/faq.rst b/docs/faq.rst index 3f0de32b7..747ffaf53 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -23,12 +23,32 @@ is **Q:** *Will paperless-ng run on Raspberry Pi?* -**A:** The short answer is yes. The long answer is that certain parts of +**A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B. +The long answer is that certain parts of Paperless will run very slow, such as the tesseract OCR. On Rasperry Pi, try to OCR documents before feeding them into paperless so that paperless can reuse the text. The web interface should be alot snappier, since it runs in your browser and paperless has to do much less work to serve the data. +.. note:: + + Consider setting ``PAPERLESS_OPTIMIZE_THUMBNAILS`` to false to speed up + the consumption process. This takes quite a bit of time on Raspberry Pi. + +.. note:: + + Updating the :ref:`automatic matching algorithm ` + takes quite a bit of time. However, the update mechanism checks if your + data has changed before doing the heavy lifting. If you experience the + algorithm taking too much cpu time, consider changing the schedule in the + admin interface to daily or weekly. You can also manually invoke the task + by changing the date and time of the next run to today/now. + + The actual matching of the algorithm is fast and works on Raspberry Pi as + well as on any other device. + + + **Q:** *How do I install paperless-ng on Raspberry Pi?* **A:** There is not docker image for ARM available. If you know how to build