Fixes the management scripts under a non-root install where the user ID is something besides 1000 (#11870)

.github/workflows/ci.yml

@@ -617,7 +617,7 @@ jobs:
           version: ${{ steps.get_version.outputs.version }}
           prerelease: ${{ steps.get_version.outputs.prerelease }}
           publish: true # ensures release is not marked as draft
-          committish: ${{ github.sha }}
+          commitish: ${{ github.sha }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload release archive

docker/management_script.sh

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py management_command "$@"
-elif [[ $(id -un) == "paperless" ]]; then
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
 	python3 manage.py management_command "$@"
-else
-	echo "Unknown user."
+elif [[ $(id -un) == "paperless" ]]; then
+	s6-setuidgid paperless python3 manage.py management_command "$@"
 fi

docker/rootfs/usr/local/bin/convert_mariadb_uuid

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py convert_mariadb_uuid "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py convert_mariadb_uuid "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py convert_mariadb_uuid "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py convert_mariadb_uuid "$@"
 fi

docker/rootfs/usr/local/bin/createsuperuser

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py createsuperuser "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py createsuperuser "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py createsuperuser "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py createsuperuser "$@"
 fi

docker/rootfs/usr/local/bin/decrypt_documents

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py decrypt_documents "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py decrypt_documents "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py decrypt_documents "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py decrypt_documents "$@"
 fi

docker/rootfs/usr/local/bin/document_archiver

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_archiver "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_archiver "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_archiver "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_archiver "$@"
 fi

docker/rootfs/usr/local/bin/document_create_classifier

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_create_classifier "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_create_classifier "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_create_classifier "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_create_classifier "$@"
 fi

docker/rootfs/usr/local/bin/document_exporter

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_exporter "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_exporter "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_exporter "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_exporter "$@"
 fi

docker/rootfs/usr/local/bin/document_fuzzy_match

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_fuzzy_match "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_fuzzy_match "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_fuzzy_match "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_fuzzy_match "$@"
 fi

docker/rootfs/usr/local/bin/document_importer

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_importer "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_importer "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_importer "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_importer "$@"
 fi

docker/rootfs/usr/local/bin/document_index

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_index "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_index "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_index "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_index "$@"
 fi

docker/rootfs/usr/local/bin/document_renamer

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_renamer "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_renamer "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_renamer "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_renamer "$@"
 fi

docker/rootfs/usr/local/bin/document_retagger

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_retagger "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_retagger "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_retagger "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_retagger "$@"
 fi

docker/rootfs/usr/local/bin/document_sanity_checker

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_sanity_checker "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_sanity_checker "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_sanity_checker "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_sanity_checker "$@"
 fi

docker/rootfs/usr/local/bin/document_thumbnails

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py document_thumbnails "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py document_thumbnails "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py document_thumbnails "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py document_thumbnails "$@"
 fi

docker/rootfs/usr/local/bin/mail_fetcher

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py mail_fetcher "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py mail_fetcher "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py mail_fetcher "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py mail_fetcher "$@"
 fi

docker/rootfs/usr/local/bin/manage_superuser

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py manage_superuser "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py manage_superuser "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py manage_superuser "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py manage_superuser "$@"
 fi

docker/rootfs/usr/local/bin/prune_audit_logs

@@ -5,10 +5,8 @@ set -e
 
 cd "${PAPERLESS_SRC_DIR}"
 
-if [[ $(id -u) == 0 ]]; then
-	s6-setuidgid paperless python3 manage.py prune_audit_logs "$@"
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
+		python3 manage.py prune_audit_logs "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py prune_audit_logs "$@"
-else
-	echo "Unknown user."
+	s6-setuidgid paperless python3 manage.py prune_audit_logs "$@"
 fi

docs/changelog.md

@@ -1,60 +1,7 @@
 # Changelog
 
-## paperless-ngx 2.20.5
-
-### Bug Fixes
-
--   Fix: ensure horizontal scroll for long tag names in list, wrap tags without parent [@shamoon](https://github.com/shamoon) ([#11811](https://github.com/paperless-ngx/paperless-ngx/pull/11811))
--   Fix: use explicit order field for workflow actions [@shamoon](https://github.com/shamoon) [@stumpylog](https://github.com/stumpylog) ([#11781](https://github.com/paperless-ngx/paperless-ngx/pull/11781))
-
-### All App Changes
-
-<details>
-<summary>2 changes</summary>
-
--   Fix: ensure horizontal scroll for long tag names in list, wrap tags without parent [@shamoon](https://github.com/shamoon) ([#11811](https://github.com/paperless-ngx/paperless-ngx/pull/11811))
--   Fix: use explicit order field for workflow actions [@shamoon](https://github.com/shamoon) [@stumpylog](https://github.com/stumpylog) ([#11781](https://github.com/paperless-ngx/paperless-ngx/pull/11781))
-</details>
-
-## paperless-ngx 2.20.4
-
-### Security
-
--   Resolve [GHSA-28cf-xvcf-hw6m](https://github.com/paperless-ngx/paperless-ngx/security/advisories/GHSA-28cf-xvcf-hw6m)
-
-### Bug Fixes
-
--   Fix: propagate metadata override created value [@shamoon](https://github.com/shamoon) ([#11659](https://github.com/paperless-ngx/paperless-ngx/pull/11659))
--   Fix: support ordering by storage path name [@shamoon](https://github.com/shamoon) ([#11661](https://github.com/paperless-ngx/paperless-ngx/pull/11661))
--   Fix: validate cf integer values within PostgreSQL range [@shamoon](https://github.com/shamoon) ([#11666](https://github.com/paperless-ngx/paperless-ngx/pull/11666))
--   Fixhancement: add error handling and retry when opening index [@shamoon](https://github.com/shamoon) ([#11731](https://github.com/paperless-ngx/paperless-ngx/pull/11731))
--   Fix: fix recurring workflow to respect latest run time [@shamoon](https://github.com/shamoon) ([#11735](https://github.com/paperless-ngx/paperless-ngx/pull/11735))
-
-### All App Changes
-
-<details>
-<summary>5 changes</summary>
-
--   Fix: propagate metadata override created value [@shamoon](https://github.com/shamoon) ([#11659](https://github.com/paperless-ngx/paperless-ngx/pull/11659))
--   Fix: support ordering by storage path name [@shamoon](https://github.com/shamoon) ([#11661](https://github.com/paperless-ngx/paperless-ngx/pull/11661))
--   Fix: validate cf integer values within PostgreSQL range [@shamoon](https://github.com/shamoon) ([#11666](https://github.com/paperless-ngx/paperless-ngx/pull/11666))
--   Fixhancement: add error handling and retry when opening index [@shamoon](https://github.com/shamoon) ([#11731](https://github.com/paperless-ngx/paperless-ngx/pull/11731))
--   Fix: fix recurring workflow to respect latest run time [@shamoon](https://github.com/shamoon) ([#11735](https://github.com/paperless-ngx/paperless-ngx/pull/11735))
-</details>
-
-## paperless-ngx 2.20.3
-
-### Security
-
--   Resolve [GHSA-7cq3-mhxq-w946](https://github.com/paperless-ngx/paperless-ngx/security/advisories/GHSA-7cq3-mhxq-w946)
-
 ## paperless-ngx 2.20.2
 
-### Security
-
--   Resolve [GHSA-6653-vcx4-69mc](https://github.com/paperless-ngx/paperless-ngx/security/advisories/GHSA-6653-vcx4-69mc)
--   Resolve [GHSA-24x5-wp64-9fcc](https://github.com/paperless-ngx/paperless-ngx/security/advisories/GHSA-24x5-wp64-9fcc)
-
 ### Features / Enhancements
 
 -   Tweakhancement: dim inactive users in users-groups list [@shamoon](https://github.com/shamoon) ([#11537](https://github.com/paperless-ngx/paperless-ngx/pull/11537))

docs/configuration.md

@@ -170,18 +170,11 @@ Available options are `postgresql` and `mariadb`.
 
     !!! note
 
-        A pool of 8-10 connections per worker is typically sufficient.
-        If you encounter error messages such as `couldn't get a connection`
-        or database connection timeouts, you probably need to increase the pool size.
-
-    !!! warning
-        Make sure your PostgreSQL `max_connections` setting is large enough to handle the connection pools:
-        `(NB_PAPERLESS_WORKERS + NB_CELERY_WORKERS) × POOL_SIZE + SAFETY_MARGIN`. For example, with
-        4 Paperless workers and 2 Celery workers, and a pool size of 8:``(4 + 2) × 8 + 10 = 58`,
-        so `max_connections = 60` (or even more) is appropriate.
-
-        This assumes only Paperless-ngx connects to your PostgreSQL instance. If you have other applications,
-        you should increase `max_connections` accordingly.
+        A small pool is typically sufficient — for example, a size of 4.
+        Make sure your PostgreSQL server's max_connections setting is large enough to handle:
+        ```(Paperless workers + Celery workers) × pool size + safety margin```
+        For example, with 4 Paperless workers and 2 Celery workers, and a pool size of 4:
+        (4 + 2) × 4 + 10 = 34 connections required.
 
 #### [`PAPERLESS_DB_READ_CACHE_ENABLED=<bool>`](#PAPERLESS_DB_READ_CACHE_ENABLED) {#PAPERLESS_DB_READ_CACHE_ENABLED}
 
@@ -1014,7 +1007,7 @@ still perform some basic text pre-processing before matching.
 
 : See also `PAPERLESS_NLTK_DIR`.
 
-    Defaults to true, enabling the feature.
+    Defaults to 1.
 
 #### [`PAPERLESS_DATE_PARSER_LANGUAGES=<lang>`](#PAPERLESS_DATE_PARSER_LANGUAGES) {#PAPERLESS_DATE_PARSER_LANGUAGES}
 
@@ -1081,7 +1074,7 @@ valid crontab(5) expression describing when to run.
 
 : Enables compression of the responses from the webserver.
 
-: Defaults to true, enabling compression.
+: Defaults to 1, enabling compression.
 
     !!! note
 

pyproject.toml

@@ -238,7 +238,7 @@ lint.isort.force-single-line = true
 
 [tool.codespell]
 write-changes = true
-ignore-words-list = "criterias,afterall,valeu,ureue,equest,ure,assertIn,Oktober"
+ignore-words-list = "criterias,afterall,valeu,ureue,equest,ure,assertIn,Oktober,commitish"
 skip = "src-ui/src/locale/*,src-ui/pnpm-lock.yaml,src-ui/e2e/*,src/paperless_mail/tests/samples/*,src/documents/tests/samples/*,*.po,*.json"
 
 [tool.pytest.ini_options]

src/documents/data_models.py

@@ -115,7 +115,7 @@ class DocumentMetadataOverrides:
             ).values_list("id", flat=True),
         )
         overrides.custom_fields = {
-            custom_field.id: custom_field.value
+            custom_field.field.id: custom_field.value
             for custom_field in doc.custom_fields.all()
         }