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
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
-	s6-setuidgid paperless python3 manage.py management_command "$@"
-elif [[ $(id -un) == "paperless" ]]; then
 	python3 manage.py management_command "$@"
-else
+elif [[ $(id -un) == "paperless" ]]; then
-	echo "Unknown user."
+	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
+if [[ -n "${USER_IS_NON_ROOT}" ]]; then
-	s6-setuidgid paperless python3 manage.py convert_mariadb_uuid "$@"
+		python3 manage.py convert_mariadb_uuid "$@"
 elif [[ $(id -un) == "paperless" ]]; then
-	python3 manage.py convert_mariadb_uuid "$@"
+	s6-setuidgid paperless python3 manage.py convert_mariadb_uuid "$@"
-else
-	echo "Unknown user."
 fi

docker/rootfs/usr/local/bin/createsuperuser

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

docker/rootfs/usr/local/bin/decrypt_documents

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

docker/rootfs/usr/local/bin/document_archiver

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

docker/rootfs/usr/local/bin/document_create_classifier

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

docker/rootfs/usr/local/bin/document_exporter

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

docker/rootfs/usr/local/bin/document_fuzzy_match

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

docker/rootfs/usr/local/bin/document_importer

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

docker/rootfs/usr/local/bin/document_index

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

docker/rootfs/usr/local/bin/document_renamer

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

docker/rootfs/usr/local/bin/document_retagger

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

docker/rootfs/usr/local/bin/document_sanity_checker

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

docker/rootfs/usr/local/bin/document_thumbnails

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

docker/rootfs/usr/local/bin/mail_fetcher

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

docker/rootfs/usr/local/bin/manage_superuser

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

docker/rootfs/usr/local/bin/prune_audit_logs

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

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()
         }