Compare commits

...

4 Commits
dev ... main

Author SHA1 Message Date
shamoon
90561857e8 Documentation: add note about WAL mode with SQLite 2025-02-24 14:08:49 -08:00
shamoon
fc68f55d1a Documentation: correct modify_tags param requirement 2025-02-14 08:20:43 -08:00
shamoon
6a8ec182fa Documentation: clarify encryption docs 2025-02-08 08:07:04 -08:00
Stéphane Brunner
69541546ea
Fix URL to django-rest-framework (#8998) 2025-02-02 08:00:02 -08:00
5 changed files with 15 additions and 16 deletions

View File

@ -565,19 +565,15 @@ document.
### Managing encryption {#encryption} ### Managing encryption {#encryption}
Documents can be stored in Paperless using GnuPG encryption.
!!! warning !!! warning
Encryption is deprecated since [paperless-ng 0.9](changelog.md#paperless-ng-090) and doesn't really Encryption was removed in [paperless-ng 0.9](changelog.md#paperless-ng-090)
provide any additional security, since you have to store the passphrase because it did not really provide any additional security, the passphrase
in a configuration file on the same system as the encrypted documents was stored in a configuration file on the same system as the documents.
for paperless to work. Furthermore, the entire text content of the Furthermore, the entire text content of the documents is stored plain in
documents is stored plain in the database, even if your documents are the database, even if your documents are encrypted. Filenames are not
encrypted. Filenames are not encrypted as well. encrypted as well. Finally, the web server provides transparent access to
your encrypted documents.
Also, the web server provides transparent access to your encrypted
documents.
Consider running paperless on an encrypted filesystem instead, which Consider running paperless on an encrypted filesystem instead, which
will then at least provide security against physical hardware theft. will then at least provide security against physical hardware theft.

View File

@ -1,7 +1,7 @@
# The REST API # The REST API
Paperless makes use of the [Django REST 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 provides a browsable API for most of its endpoints, which you can
inspect at `http://<paperless-host>:<port>/api/`. This also documents inspect at `http://<paperless-host>:<port>/api/`. This also documents
most of the available filters and ordering fields. most of the available filters and ordering fields.
@ -444,7 +444,7 @@ The following methods are supported:
- `remove_tag` - `remove_tag`
- Requires `parameters`: `{ "tag": TAG_ID }` - Requires `parameters`: `{ "tag": TAG_ID }`
- `modify_tags` - `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` - `delete`
- No `parameters` required - No `parameters` required
- `reprocess` - `reprocess`

View File

@ -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 the Pi and configuring some options in paperless can help improve
performance immensely: 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 - 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 only OCR the first page of your documents. In most cases, this page
contains enough information to be able to find it. contains enough information to be able to find it.

View File

@ -320,7 +320,9 @@ many workers attempting to access the database simultaneously.
Consider changing to the PostgreSQL database if you will be processing Consider changing to the PostgreSQL database if you will be processing
many documents at once often. Otherwise, try tweaking the 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 [`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" ## gunicorn fails to start with "is not a valid port number"

View File

@ -211,7 +211,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
def test_api_modify_tags_not_provided(self, m): def test_api_modify_tags_not_provided(self, m):
""" """
GIVEN: GIVEN:
- API data to modify tags is missing modify_tags field - API data to modify tags is missing remove_tags field
WHEN: WHEN:
- API to edit tags is called - API to edit tags is called
THEN: THEN: