From 69541546ea3aba81e33818b702ae7b6a53169fa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Brunner?= Date: Sun, 2 Feb 2025 17:00:02 +0100 Subject: [PATCH 1/4] Fix URL to django-rest-framework (#8998) --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 050443c19..ac9bac912 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,7 +1,7 @@ # The REST API Paperless makes use of the [Django REST -Framework](https://django-rest-framework.org/) standard API interface. It +Framework](https://www.django-rest-framework.org/) standard API interface. It provides a browsable API for most of its endpoints, which you can inspect at `http://:/api/`. This also documents most of the available filters and ordering fields. From 6a8ec182fa672b1b8b2fdabf04dac2a2aff2b703 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 8 Feb 2025 08:07:04 -0800 Subject: [PATCH 2/4] Documentation: clarify encryption docs --- docs/administration.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/administration.md b/docs/administration.md index 8e646b326..54d918783 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -565,19 +565,15 @@ document. ### Managing encryption {#encryption} -Documents can be stored in Paperless using GnuPG encryption. - !!! warning - Encryption is deprecated since [paperless-ng 0.9](changelog.md#paperless-ng-090) and doesn't really - provide any additional security, since you have to store the passphrase - in a configuration file on the same system as the encrypted documents - for paperless to work. Furthermore, the entire text content of the - documents is stored plain in the database, even if your documents are - encrypted. Filenames are not encrypted as well. - - Also, the web server provides transparent access to your encrypted - documents. + Encryption was removed in [paperless-ng 0.9](changelog.md#paperless-ng-090) + because it did not really provide any additional security, the passphrase + was stored in a configuration file on the same system as the documents. + Furthermore, the entire text content of the documents is stored plain in + the database, even if your documents are encrypted. Filenames are not + encrypted as well. Finally, the web server provides transparent access to + your encrypted documents. Consider running paperless on an encrypted filesystem instead, which will then at least provide security against physical hardware theft. From fc68f55d1a08d895564d52adfd5d8ea1fd5bc86c Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 14 Feb 2025 08:20:43 -0800 Subject: [PATCH 3/4] Documentation: correct modify_tags param requirement --- docs/api.md | 2 +- src/documents/tests/test_api_bulk_edit.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index ac9bac912..327c3220c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -444,7 +444,7 @@ The following methods are supported: - `remove_tag` - Requires `parameters`: `{ "tag": TAG_ID }` - `modify_tags` - - Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and / or `{ "remove_tags": [LIST_OF_TAG_IDS] }` + - Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and `{ "remove_tags": [LIST_OF_TAG_IDS] }` - `delete` - No `parameters` required - `reprocess` diff --git a/src/documents/tests/test_api_bulk_edit.py b/src/documents/tests/test_api_bulk_edit.py index 28c6de336..bcbe5922d 100644 --- a/src/documents/tests/test_api_bulk_edit.py +++ b/src/documents/tests/test_api_bulk_edit.py @@ -211,7 +211,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): def test_api_modify_tags_not_provided(self, m): """ GIVEN: - - API data to modify tags is missing modify_tags field + - API data to modify tags is missing remove_tags field WHEN: - API to edit tags is called THEN: From 90561857e8af70864c6f48c78eed428d32644094 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 24 Feb 2025 14:08:49 -0800 Subject: [PATCH 4/4] Documentation: add note about WAL mode with SQLite --- docs/setup.md | 3 ++- docs/troubleshooting.md | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index f2b82d070..9413ec104 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -713,7 +713,8 @@ Paperless runs on Raspberry Pi. However, some things are rather slow on the Pi and configuring some options in paperless can help improve performance immensely: -- Stick with SQLite to save some resources. +- Stick with SQLite to save some resources. See [troubleshooting](troubleshooting.md#log-reports-creating-paperlesstask-failed) + if you encounter issues with SQLite locking. - Consider setting [`PAPERLESS_OCR_PAGES`](configuration.md#PAPERLESS_OCR_PAGES) to 1, so that paperless will only OCR the first page of your documents. In most cases, this page contains enough information to be able to find it. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index b076baf6b..bbb23c959 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -320,7 +320,9 @@ many workers attempting to access the database simultaneously. Consider changing to the PostgreSQL database if you will be processing many documents at once often. Otherwise, try tweaking the [`PAPERLESS_DB_TIMEOUT`](configuration.md#PAPERLESS_DB_TIMEOUT) setting to allow more time for the database to -unlock. This may have minor performance implications. +unlock. Additionally, you can change your SQLite database to use ["Write-Ahead Logging"](https://sqlite.org/wal.html). +These changes may have minor performance implications but can help +prevent database locking issues. ## gunicorn fails to start with "is not a valid port number"