Move to docs subdomain

[Beta] Paperless-ngx v1.10.0 Release Candidate

.build-config.json

@@ -1,6 +1,6 @@
 {
   "qpdf": {
-      "version": "10.6.3"
+      "version": "11.1.1"
     },
   "jbig2enc": {
       "version": "0.29",

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -13,6 +13,7 @@ body:
         - [The troubleshooting documentation](https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html).
         - [The installation instructions](https://paperless-ngx.readthedocs.io/en/latest/setup.html#installation).
         - [Existing issues and discussions](https://github.com/paperless-ngx/paperless-ngx/search?q=&type=issues).
+        - Disable any customer container initialization scripts, if using any
 
         If you encounter issues while installing or configuring Paperless-ngx, please post in the ["Support" section of the discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=support).
   - type: textarea
@@ -41,7 +42,15 @@ body:
     id: logs
     attributes:
       label: Webserver logs
-      description: If available, post any logs from the web server related to your issue.
+      description: Logs from the web server related to your issue.
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: logs_browser
+    attributes:
+      label: Browser logs
+      description: Logs from the web browser related to your issue, if needed
       render: bash
   - type: input
     id: version

.github/scripts/cleanup-tags.py

@@ -1,168 +1,312 @@
 #!/usr/bin/env python3
-import functools
 import json
 import logging
 import os
-import re
 import shutil
 import subprocess
 from argparse import ArgumentParser
 from typing import Dict
 from typing import Final
 from typing import List
-from urllib.parse import quote
+from typing import Optional
 
-import requests
 from common import get_log_level
+from github import ContainerPackage
+from github import GithubBranchApi
+from github import GithubContainerRegistryApi
 
 logger = logging.getLogger("cleanup-tags")
 
 
-class ContainerPackage:
-    def __init__(self, data: Dict):
+class DockerManifest2:
+    """
+    Data class wrapping the Docker Image Manifest Version 2.
+
+    See https://docs.docker.com/registry/spec/manifest-v2-2/
+    """
+
+    def __init__(self, data: Dict) -> None:
         self._data = data
-        self.name = self._data["name"]
-        self.id = self._data["id"]
-        self.url = self._data["url"]
-        self.tags = self._data["metadata"]["container"]["tags"]
-
-    @functools.cached_property
-    def untagged(self) -> bool:
-        return len(self.tags) == 0
-
-    @functools.cache
-    def tag_matches(self, pattern: str) -> bool:
-        for tag in self.tags:
-            if re.match(pattern, tag) is not None:
-                return True
-        return False
-
-    def __repr__(self):
-        return f"Package {self.name}"
+        # This is the sha256: digest string.  Corresponds to GitHub API name
+        # if the package is an untagged package
+        self.digest = self._data["digest"]
+        platform_data_os = self._data["platform"]["os"]
+        platform_arch = self._data["platform"]["architecture"]
+        platform_variant = self._data["platform"].get(
+            "variant",
+            "",
+        )
+        self.platform = f"{platform_data_os}/{platform_arch}{platform_variant}"
 
 
-class GithubContainerRegistry:
+class RegistryTagsCleaner:
+    """
+    This is the base class for the image registry cleaning.  Given a package
+    name, it will keep all images which are tagged and all untagged images
+    referred to by a manifest.  This results in only images which have been untagged
+    and cannot be referenced except by their SHA in being removed.  None of these
+    images should be referenced, so it is fine to delete them.
+    """
+
     def __init__(
-        self,
-        session: requests.Session,
-        token: str,
-        owner_or_org: str,
-    ):
-        self._session: requests.Session = session
-        self._token = token
-        self._owner_or_org = owner_or_org
-        # https://docs.github.com/en/rest/branches/branches
-        self._BRANCHES_ENDPOINT = "https://api.github.com/repos/{OWNER}/{REPO}/branches"
-        if self._owner_or_org == "paperless-ngx":
-            # https://docs.github.com/en/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization
-            self._PACKAGES_VERSIONS_ENDPOINT = "https://api.github.com/orgs/{ORG}/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions"
-            # https://docs.github.com/en/rest/packages#delete-package-version-for-an-organization
-            self._PACKAGE_VERSION_DELETE_ENDPOINT = "https://api.github.com/orgs/{ORG}/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions/{PACKAGE_VERSION_ID}"
-        else:
-            # https://docs.github.com/en/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user
-            self._PACKAGES_VERSIONS_ENDPOINT = "https://api.github.com/user/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions"
-            # https://docs.github.com/en/rest/packages#delete-a-package-version-for-the-authenticated-user
-            self._PACKAGE_VERSION_DELETE_ENDPOINT = "https://api.github.com/user/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions/{PACKAGE_VERSION_ID}"
-
-    def __enter__(self):
-        """
-        Sets up the required headers for auth and response
-        type from the API
-        """
-        self._session.headers.update(
-            {
-                "Accept": "application/vnd.github.v3+json",
-                "Authorization": f"token {self._token}",
-            },
-        )
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        """
-        Ensures the authorization token is cleaned up no matter
-        the reason for the exit
-        """
-        if "Accept" in self._session.headers:
-            del self._session.headers["Accept"]
-        if "Authorization" in self._session.headers:
-            del self._session.headers["Authorization"]
-
-    def _read_all_pages(self, endpoint):
-        """
-        Internal function to read all pages of an endpoint, utilizing the
-        next.url until exhausted
-        """
-        internal_data = []
-
-        while True:
-            resp = self._session.get(endpoint)
-            if resp.status_code == 200:
-                internal_data += resp.json()
-                if "next" in resp.links:
-                    endpoint = resp.links["next"]["url"]
-                else:
-                    logger.debug("Exiting pagination loop")
-                    break
-            else:
-                logger.warning(f"Request to {endpoint} return HTTP {resp.status_code}")
-                break
-
-        return internal_data
-
-    def get_branches(self, repo: str):
-        """
-        Returns all current branches of the given repository
-        """
-        endpoint = self._BRANCHES_ENDPOINT.format(OWNER=self._owner_or_org, REPO=repo)
-        internal_data = self._read_all_pages(endpoint)
-        return internal_data
-
-    def filter_branches_by_name_pattern(self, branch_data, pattern: str):
-        """
-        Filters the given list of branches to those which start with the given
-        pattern.  Future enhancement could use regex patterns instead.
-        """
-        matches = {}
-
-        for branch in branch_data:
-            if branch["name"].startswith(pattern):
-                matches[branch["name"]] = branch
-
-        return matches
-
-    def get_package_versions(
         self,
         package_name: str,
-        package_type: str = "container",
-    ) -> List[ContainerPackage]:
-        """
-        Returns all the versions of a given package (container images) from
-        the API
-        """
-        package_name = quote(package_name, safe="")
-        endpoint = self._PACKAGES_VERSIONS_ENDPOINT.format(
-            ORG=self._owner_or_org,
-            PACKAGE_TYPE=package_type,
-            PACKAGE_NAME=package_name,
+        repo_owner: str,
+        repo_name: str,
+        package_api: GithubContainerRegistryApi,
+        branch_api: Optional[GithubBranchApi],
+    ):
+        self.actually_delete = False
+        self.package_api = package_api
+        self.branch_api = branch_api
+        self.package_name = package_name
+        self.repo_owner = repo_owner
+        self.repo_name = repo_name
+        self.tags_to_delete: List[str] = []
+        self.tags_to_keep: List[str] = []
+
+        # Get the information about all versions of the given package
+        # These are active, not deleted, the default returned from the API
+        self.all_package_versions = self.package_api.get_active_package_versions(
+            self.package_name,
         )
 
-        pkgs = []
+        # Get a mapping from a tag like "1.7.0" or "feature-xyz" to the ContainerPackage
+        # tagged with it.  It makes certain lookups easy
+        self.all_pkgs_tags_to_version: Dict[str, ContainerPackage] = {}
+        for pkg in self.all_package_versions:
+            for tag in pkg.tags:
+                self.all_pkgs_tags_to_version[tag] = pkg
+        logger.info(
+            f"Located {len(self.all_package_versions)} versions of package {self.package_name}",
+        )
 
-        for data in self._read_all_pages(endpoint):
-            pkgs.append(ContainerPackage(data))
+        self.decide_what_tags_to_keep()
 
-        return pkgs
-
-    def delete_package_version(self, package_data: ContainerPackage):
+    def clean(self):
         """
-        Deletes the given package version from the GHCR
+        This method will delete image versions, based on the selected tags to delete
         """
-        resp = self._session.delete(package_data.url)
-        if resp.status_code != 204:
-            logger.warning(
-                f"Request to delete {package_data.url} returned HTTP {resp.status_code}",
+        for tag_to_delete in self.tags_to_delete:
+            package_version_info = self.all_pkgs_tags_to_version[tag_to_delete]
+
+            if self.actually_delete:
+                logger.info(
+                    f"Deleting {tag_to_delete} (id {package_version_info.id})",
+                )
+                self.package_api.delete_package_version(
+                    package_version_info,
+                )
+
+            else:
+                logger.info(
+                    f"Would delete {tag_to_delete} (id {package_version_info.id})",
+                )
+        else:
+            logger.info("No tags to delete")
+
+    def clean_untagged(self, is_manifest_image: bool):
+        """
+        This method will delete untagged images, that is those which are not named.  It
+        handles if the image tag is actually a manifest, which points to images that look otherwise
+        untagged.
+        """
+
+        def _clean_untagged_manifest():
+            """
+
+            Handles the deletion of untagged images, but where the package is a manifest, ie a multi
+            arch image, which means some "untagged" images need to exist still.
+
+            Ok, bear with me, these are annoying.
+
+            Our images are multi-arch, so the manifest is more like a pointer to a sha256 digest.
+            These images are untagged, but pointed to, and so should not be removed (or every pull fails).
+
+            So for each image getting kept, parse the manifest to find the digest(s) it points to.  Then
+            remove those from the list of untagged images.  The final result is the untagged, not pointed to
+            version which should be safe to remove.
+
+            Example:
+                Tag: ghcr.io/paperless-ngx/paperless-ngx:1.7.1 refers to
+                    amd64: sha256:b9ed4f8753bbf5146547671052d7e91f68cdfc9ef049d06690b2bc866fec2690
+                    armv7: sha256:81605222df4ba4605a2ba4893276e5d08c511231ead1d5da061410e1bbec05c3
+                    arm64: sha256:374cd68db40734b844705bfc38faae84cc4182371de4bebd533a9a365d5e8f3b
+                each of which appears as untagged image, but isn't really.
+
+                So from the list of untagged packages, remove those digests.  Once all tags which
+                are being kept are checked, the remaining untagged packages are actually untagged
+                with no referrals in a manifest to them.
+            """
+            # Simplify the untagged data, mapping name (which is a digest) to the version
+            # At the moment, these are the images which APPEAR untagged.
+            untagged_versions = {}
+            for x in self.all_package_versions:
+                if x.untagged:
+                    untagged_versions[x.name] = x
+
+            skips = 0
+
+            # Parse manifests to locate digests pointed to
+            for tag in sorted(self.tags_to_keep):
+                full_name = f"ghcr.io/{self.repo_owner}/{self.package_name}:{tag}"
+                logger.info(f"Checking manifest for {full_name}")
+                try:
+                    proc = subprocess.run(
+                        [
+                            shutil.which("docker"),
+                            "manifest",
+                            "inspect",
+                            full_name,
+                        ],
+                        capture_output=True,
+                    )
+
+                    manifest_list = json.loads(proc.stdout)
+                    for manifest_data in manifest_list["manifests"]:
+                        manifest = DockerManifest2(manifest_data)
+
+                        if manifest.digest in untagged_versions:
+                            logger.info(
+                                f"Skipping deletion of {manifest.digest},"
+                                f" referred to by {full_name}"
+                                f" for {manifest.platform}",
+                            )
+                            del untagged_versions[manifest.digest]
+                            skips += 1
+
+                except Exception as err:
+                    self.actually_delete = False
+                    logger.exception(err)
+                    return
+
+            logger.info(
+                f"Skipping deletion of {skips} packages referred to by a manifest",
             )
 
+            # Delete the untagged and not pointed at packages
+            logger.info(f"Deleting untagged packages of {self.package_name}")
+            for to_delete_name in untagged_versions:
+                to_delete_version = untagged_versions[to_delete_name]
+
+                if self.actually_delete:
+                    logger.info(
+                        f"Deleting id {to_delete_version.id} named {to_delete_version.name}",
+                    )
+                    self.package_api.delete_package_version(
+                        to_delete_version,
+                    )
+                else:
+                    logger.info(
+                        f"Would delete {to_delete_name} (id {to_delete_version.id})",
+                    )
+
+        def _clean_untagged_non_manifest():
+            """
+            If the package is not a multi-arch manifest, images without tags are safe to delete.
+            """
+
+            for package in self.all_package_versions:
+                if package.untagged:
+                    if self.actually_delete:
+                        logger.info(
+                            f"Deleting id {package.id} named {package.name}",
+                        )
+                        self.package_api.delete_package_version(
+                            package,
+                        )
+                    else:
+                        logger.info(
+                            f"Would delete {package.name} (id {package.id})",
+                        )
+                else:
+                    logger.info(
+                        f"Not deleting tag {package.tags[0]} of package {self.package_name}",
+                    )
+
+        logger.info("Beginning untagged image cleaning")
+
+        if is_manifest_image:
+            _clean_untagged_manifest()
+        else:
+            _clean_untagged_non_manifest()
+
+    def decide_what_tags_to_keep(self):
+        """
+        This method holds the logic to delete what tags to keep and there fore
+        what tags to delete.
+
+        By default, any image with at least 1 tag will be kept
+        """
+        # By default, keep anything which is tagged
+        self.tags_to_keep = list(set(self.all_pkgs_tags_to_version.keys()))
+
+
+class MainImageTagsCleaner(RegistryTagsCleaner):
+    def decide_what_tags_to_keep(self):
+        """
+        Overrides the default logic for deciding what images to keep.  Images tagged as "feature-"
+        will be removed, if the corresponding branch no longer exists.
+        """
+
+        # Default to everything gets kept still
+        super().decide_what_tags_to_keep()
+
+        # Locate the feature branches
+        feature_branches = {}
+        for branch in self.branch_api.get_branches(
+            repo=self.repo_name,
+        ):
+            if branch.name.startswith("feature-"):
+                logger.debug(f"Found feature branch {branch.name}")
+                feature_branches[branch.name] = branch
+
+        logger.info(f"Located {len(feature_branches)} feature branches")
+
+        if not len(feature_branches):
+            # Our work here is done, delete nothing
+            return
+
+        # Filter to packages which are tagged with feature-*
+        packages_tagged_feature: List[ContainerPackage] = []
+        for package in self.all_package_versions:
+            if package.tag_matches("feature-"):
+                packages_tagged_feature.append(package)
+
+        # Map tags like "feature-xyz" to a ContainerPackage
+        feature_pkgs_tags_to_versions: Dict[str, ContainerPackage] = {}
+        for pkg in packages_tagged_feature:
+            for tag in pkg.tags:
+                feature_pkgs_tags_to_versions[tag] = pkg
+
+        logger.info(
+            f'Located {len(feature_pkgs_tags_to_versions)} versions of package {self.package_name} tagged "feature-"',
+        )
+
+        # All the feature tags minus all the feature branches leaves us feature tags
+        # with no corresponding branch
+        self.tags_to_delete = list(
+            set(feature_pkgs_tags_to_versions.keys()) - set(feature_branches.keys()),
+        )
+
+        # All the tags minus the set of going to be deleted tags leaves us the
+        # tags which will be kept around
+        self.tags_to_keep = list(
+            set(self.all_pkgs_tags_to_version.keys()) - set(self.tags_to_delete),
+        )
+        logger.info(
+            f"Located {len(self.tags_to_delete)} versions of package {self.package_name} to delete",
+        )
+
+
+class LibraryTagsCleaner(RegistryTagsCleaner):
+    """
+    Exists for the off change that someday, the installer library images
+    will need their own logic
+    """
+
+    pass
+
 
 def _main():
     parser = ArgumentParser(
@@ -187,6 +331,15 @@ def _main():
         help="If provided, delete untagged containers as well",
     )
 
+    # If given, the package is assumed to be a multi-arch manifest.  Cache packages are
+    # not multi-arch, all other types are
+    parser.add_argument(
+        "--is-manifest",
+        action="store_true",
+        default=False,
+        help="If provided, the package is assumed to be a multi-arch manifest following schema v2",
+    )
+
     # Allows configuration of log level for debugging
     parser.add_argument(
         "--loglevel",
@@ -194,6 +347,12 @@ def _main():
         help="Configures the logging level",
     )
 
+    # Get the name of the package being processed this round
+    parser.add_argument(
+        "package",
+        help="The package to process",
+    )
+
     args = parser.parse_args()
 
     logging.basicConfig(
@@ -207,181 +366,36 @@ def _main():
     repo: Final[str] = os.environ["GITHUB_REPOSITORY"]
     gh_token: Final[str] = os.environ["TOKEN"]
 
-    with requests.session() as sess:
-        with GithubContainerRegistry(sess, gh_token, repo_owner) as gh_api:
-
-            # Step 1 - Get branch information
-
-            # Step 1.1 - Locate all branches of the repo
-            all_branches = gh_api.get_branches("paperless-ngx")
-            logger.info(f"Located {len(all_branches)} branches of {repo_owner}/{repo} ")
-
-            # Step 1.2 - Filter branches to those starting with "feature-"
-            feature_branches = gh_api.filter_branches_by_name_pattern(
-                all_branches,
-                "feature-",
-            )
-            logger.info(f"Located {len(feature_branches)} feature branches")
-
-            # Step 2 - Deal with package information
-            for package_name in ["paperless-ngx", "paperless-ngx/builder/cache/app"]:
-
-                # Step 2.1 - Location all versions of the given package
-                all_package_versions = gh_api.get_package_versions(package_name)
-
-                # Faster lookup, map the tag to their container
-                all_pkgs_tags_to_version = {}
-                for pkg in all_package_versions:
-                    for tag in pkg.tags:
-                        all_pkgs_tags_to_version[tag] = pkg
-                logger.info(
-                    f"Located {len(all_package_versions)} versions of package {package_name}",
+    # Find all branches named feature-*
+    # Note: Only relevant to the main application, but simpler to
+    # leave in for all packages
+    with GithubBranchApi(gh_token) as branch_api:
+        with GithubContainerRegistryApi(gh_token, repo_owner) as container_api:
+            if args.package in {"paperless-ngx", "paperless-ngx/builder/cache/app"}:
+                cleaner = MainImageTagsCleaner(
+                    args.package,
+                    repo_owner,
+                    repo,
+                    container_api,
+                    branch_api,
+                )
+            else:
+                cleaner = LibraryTagsCleaner(
+                    args.package,
+                    repo_owner,
+                    repo,
+                    container_api,
+                    None,
                 )
 
-                # Step 2.2 - Location package versions which have a tag of "feature-"
-                packages_tagged_feature = []
-                for package in all_package_versions:
-                    if package.tag_matches("feature-"):
-                        packages_tagged_feature.append(package)
+            # Set if actually doing a delete vs dry run
+            cleaner.actually_delete = args.delete
 
-                logger.info(
-                    f'Located {len(packages_tagged_feature)} versions of package {package_name} tagged "feature-"',
-                )
+            # Clean images with tags
+            cleaner.clean()
 
-                # Faster lookup, map feature- tags to their container
-                feature_pkgs_tags_to_versions = {}
-                for pkg in packages_tagged_feature:
-                    for tag in pkg.tags:
-                        feature_pkgs_tags_to_versions[tag] = pkg
-
-                # Step 2.3 - Determine which package versions have no matching branch and which tags we're keeping
-                tags_to_delete = list(
-                    set(feature_pkgs_tags_to_versions.keys())
-                    - set(feature_branches.keys()),
-                )
-                tags_to_keep = list(
-                    set(all_pkgs_tags_to_version.keys()) - set(tags_to_delete),
-                )
-                logger.info(
-                    f"Located {len(tags_to_delete)} versions of package {package_name} to delete",
-                )
-
-                # Step 2.4 - Delete certain package versions
-                for tag_to_delete in tags_to_delete:
-                    package_version_info = feature_pkgs_tags_to_versions[tag_to_delete]
-
-                    if args.delete:
-                        logger.info(
-                            f"Deleting {tag_to_delete} (id {package_version_info.id})",
-                        )
-                        gh_api.delete_package_version(
-                            package_version_info,
-                        )
-
-                    else:
-                        logger.info(
-                            f"Would delete {tag_to_delete} (id {package_version_info.id})",
-                        )
-
-                # Step 3 - Deal with untagged and dangling packages
-                if args.untagged:
-
-                    """
-                    Ok, bear with me, these are annoying.
-
-                    Our images are multi-arch, so the manifest is more like a pointer to a sha256 digest.
-                    These images are untagged, but pointed to, and so should not be removed (or every pull fails).
-
-                    So for each image getting kept, parse the manifest to find the digest(s) it points to.  Then
-                    remove those from the list of untagged images.  The final result is the untagged, not pointed to
-                    version which should be safe to remove.
-
-                    Example:
-                        Tag: ghcr.io/paperless-ngx/paperless-ngx:1.7.1 refers to
-                            amd64: sha256:b9ed4f8753bbf5146547671052d7e91f68cdfc9ef049d06690b2bc866fec2690
-                            armv7: sha256:81605222df4ba4605a2ba4893276e5d08c511231ead1d5da061410e1bbec05c3
-                            arm64: sha256:374cd68db40734b844705bfc38faae84cc4182371de4bebd533a9a365d5e8f3b
-                        each of which appears as untagged image
-
-                    """
-
-                    # Step 3.1 - Simplify the untagged data, mapping name (which is a digest) to the version
-                    untagged_versions = {}
-                    for x in all_package_versions:
-                        if x.untagged:
-                            untagged_versions[x.name] = x
-
-                    skips = 0
-                    # Extra security to not delete on an unexpected error
-                    actually_delete = True
-
-                    logger.info(
-                        f"Located {len(tags_to_keep)} tags of package {package_name} to keep",
-                    )
-
-                    # Step 3.2 - Parse manifests to locate digests pointed to
-                    for tag in tags_to_keep:
-                        full_name = f"ghcr.io/{repo_owner}/{package_name}:{tag}"
-                        logger.info(f"Checking manifest for {full_name}")
-                        try:
-                            proc = subprocess.run(
-                                [
-                                    shutil.which("docker"),
-                                    "manifest",
-                                    "inspect",
-                                    full_name,
-                                ],
-                                capture_output=True,
-                            )
-
-                            manifest_list = json.loads(proc.stdout)
-                            for manifest in manifest_list["manifests"]:
-                                digest = manifest["digest"]
-                                platform_data_os = manifest["platform"]["os"]
-                                platform_arch = manifest["platform"]["architecture"]
-                                platform_variant = manifest["platform"].get(
-                                    "variant",
-                                    "",
-                                )
-                                platform = f"{platform_data_os}/{platform_arch}{platform_variant}"
-
-                                if digest in untagged_versions:
-                                    logger.debug(
-                                        f"Skipping deletion of {digest}, referred to by {full_name} for {platform}",
-                                    )
-                                    del untagged_versions[digest]
-                                    skips += 1
-
-                        except json.decoder.JSONDecodeError as err:
-                            # This is probably for a cache image, which isn't a multi-arch digest
-                            # These are ok to delete all on
-                            logger.debug(f"{err} on {full_name}")
-                            continue
-                        except Exception as err:
-                            actually_delete = False
-                            logger.exception(err)
-                            continue
-
-                    logger.info(f"Skipping deletion of {skips} packages")
-
-                    # Step 3.3 - Delete the untagged and not pointed at packages
-                    logger.info(f"Deleting untagged packages of {package_name}")
-                    for to_delete_name in untagged_versions:
-                        to_delete_version = untagged_versions[to_delete_name]
-
-                        if args.delete and actually_delete:
-                            logger.info(
-                                f"Deleting id {to_delete_version.id} named {to_delete_version.name}",
-                            )
-                            gh_api.delete_package_version(
-                                to_delete_version,
-                            )
-                        else:
-                            logger.info(
-                                f"Would delete {to_delete_name} (id {to_delete_version.id})",
-                            )
-                else:
-                    logger.info("Leaving untagged images untouched")
+            # Clean images which are untagged
+            cleaner.clean_untagged(args.is_manifest)
 
 
 if __name__ == "__main__":

.github/scripts/common.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 import logging
-from argparse import ArgumentError
 
 
 def get_image_tag(
@@ -30,6 +29,11 @@ def get_cache_image_tag(
 
 
 def get_log_level(args) -> int:
+    """
+    Returns a logging level, based
+    :param args:
+    :return:
+    """
     levels = {
         "critical": logging.CRITICAL,
         "error": logging.ERROR,

.github/scripts/github.py

@@ -0,0 +1,274 @@
+#!/usr/bin/env python3
+"""
+This module contains some useful classes for interacting with the Github API.
+The full documentation for the API can be found here: https://docs.github.com/en/rest
+
+Mostly, this focusses on two areas, repo branches and repo packages, as the use case
+is cleaning up container images which are no longer referred to.
+
+"""
+import functools
+import logging
+import re
+import urllib.parse
+from typing import Dict
+from typing import List
+from typing import Optional
+
+import httpx
+
+logger = logging.getLogger("github-api")
+
+
+class _GithubApiBase:
+    """
+    A base class for interacting with the Github API.  It
+    will handle the session and setting authorization headers.
+    """
+
+    def __init__(self, token: str) -> None:
+        self._token = token
+        self._client: Optional[httpx.Client] = None
+
+    def __enter__(self) -> "_GithubApiBase":
+        """
+        Sets up the required headers for auth and response
+        type from the API
+        """
+        self._client = httpx.Client()
+        self._client.headers.update(
+            {
+                "Accept": "application/vnd.github.v3+json",
+                "Authorization": f"token {self._token}",
+            },
+        )
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """
+        Ensures the authorization token is cleaned up no matter
+        the reason for the exit
+        """
+        if "Accept" in self._client.headers:
+            del self._client.headers["Accept"]
+        if "Authorization" in self._client.headers:
+            del self._client.headers["Authorization"]
+
+        # Close the session as well
+        self._client.close()
+        self._client = None
+
+    def _read_all_pages(self, endpoint):
+        """
+        Helper function to read all pages of an endpoint, utilizing the
+        next.url until exhausted.  Assumes the endpoint returns a list
+        """
+        internal_data = []
+
+        while True:
+            resp = self._client.get(endpoint)
+            if resp.status_code == 200:
+                internal_data += resp.json()
+                if "next" in resp.links:
+                    endpoint = resp.links["next"]["url"]
+                else:
+                    logger.debug("Exiting pagination loop")
+                    break
+            else:
+                logger.warning(f"Request to {endpoint} return HTTP {resp.status_code}")
+                resp.raise_for_status()
+
+        return internal_data
+
+
+class _EndpointResponse:
+    """
+    For all endpoint JSON responses, store the full
+    response data, for ease of extending later, if need be.
+    """
+
+    def __init__(self, data: Dict) -> None:
+        self._data = data
+
+
+class GithubBranch(_EndpointResponse):
+    """
+    Simple wrapper for a repository branch, only extracts name information
+    for now.
+    """
+
+    def __init__(self, data: Dict) -> None:
+        super().__init__(data)
+        self.name = self._data["name"]
+
+
+class GithubBranchApi(_GithubApiBase):
+    """
+    Wrapper around branch API.
+
+    See https://docs.github.com/en/rest/branches/branches
+
+    """
+
+    def __init__(self, token: str) -> None:
+        super().__init__(token)
+
+        self._ENDPOINT = "https://api.github.com/repos/{REPO}/branches"
+
+    def get_branches(self, repo: str) -> List[GithubBranch]:
+        """
+        Returns all current branches of the given repository owned by the given
+        owner or organization.
+        """
+        # The environment GITHUB_REPOSITORY already contains the owner in the correct location
+        endpoint = self._ENDPOINT.format(REPO=repo)
+        internal_data = self._read_all_pages(endpoint)
+        return [GithubBranch(branch) for branch in internal_data]
+
+
+class ContainerPackage(_EndpointResponse):
+    """
+    Data class wrapping the JSON response from the package related
+    endpoints
+    """
+
+    def __init__(self, data: Dict):
+        super().__init__(data)
+        # This is a numerical ID, required for interactions with this
+        # specific package, including deletion of it or restoration
+        self.id: int = self._data["id"]
+
+        # A string name.  This might be an actual name or it could be a
+        # digest string like "sha256:"
+        self.name: str = self._data["name"]
+
+        # URL to the package, including its ID, can be used for deletion
+        # or restoration without needing to build up a URL ourselves
+        self.url: str = self._data["url"]
+
+        # The list of tags applied to this image. Maybe an empty list
+        self.tags: List[str] = self._data["metadata"]["container"]["tags"]
+
+    @functools.cached_property
+    def untagged(self) -> bool:
+        """
+        Returns True if the image has no tags applied to it, False otherwise
+        """
+        return len(self.tags) == 0
+
+    @functools.cache
+    def tag_matches(self, pattern: str) -> bool:
+        """
+        Returns True if the image has at least one tag which matches the given regex,
+        False otherwise
+        """
+        for tag in self.tags:
+            if re.match(pattern, tag) is not None:
+                return True
+        return False
+
+    def __repr__(self):
+        return f"Package {self.name}"
+
+
+class GithubContainerRegistryApi(_GithubApiBase):
+    """
+    Class wrapper to deal with the Github packages API.  This class only deals with
+    container type packages, the only type published by paperless-ngx.
+    """
+
+    def __init__(self, token: str, owner_or_org: str) -> None:
+        super().__init__(token)
+        self._owner_or_org = owner_or_org
+        if self._owner_or_org == "paperless-ngx":
+            # https://docs.github.com/en/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization
+            self._PACKAGES_VERSIONS_ENDPOINT = "https://api.github.com/orgs/{ORG}/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions"
+            # https://docs.github.com/en/rest/packages#delete-package-version-for-an-organization
+            self._PACKAGE_VERSION_DELETE_ENDPOINT = "https://api.github.com/orgs/{ORG}/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions/{PACKAGE_VERSION_ID}"
+        else:
+            # https://docs.github.com/en/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user
+            self._PACKAGES_VERSIONS_ENDPOINT = "https://api.github.com/user/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions"
+            # https://docs.github.com/en/rest/packages#delete-a-package-version-for-the-authenticated-user
+            self._PACKAGE_VERSION_DELETE_ENDPOINT = "https://api.github.com/user/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions/{PACKAGE_VERSION_ID}"
+        self._PACKAGE_VERSION_RESTORE_ENDPOINT = (
+            f"{self._PACKAGE_VERSION_DELETE_ENDPOINT}/restore"
+        )
+
+    def get_active_package_versions(
+        self,
+        package_name: str,
+    ) -> List[ContainerPackage]:
+        """
+        Returns all the versions of a given package (container images) from
+        the API
+        """
+
+        package_type: str = "container"
+        # Need to quote this for slashes in the name
+        package_name = urllib.parse.quote(package_name, safe="")
+
+        endpoint = self._PACKAGES_VERSIONS_ENDPOINT.format(
+            ORG=self._owner_or_org,
+            PACKAGE_TYPE=package_type,
+            PACKAGE_NAME=package_name,
+        )
+
+        pkgs = []
+
+        for data in self._read_all_pages(endpoint):
+            pkgs.append(ContainerPackage(data))
+
+        return pkgs
+
+    def get_deleted_package_versions(
+        self,
+        package_name: str,
+    ) -> List[ContainerPackage]:
+        package_type: str = "container"
+        # Need to quote this for slashes in the name
+        package_name = urllib.parse.quote(package_name, safe="")
+
+        endpoint = (
+            self._PACKAGES_VERSIONS_ENDPOINT.format(
+                ORG=self._owner_or_org,
+                PACKAGE_TYPE=package_type,
+                PACKAGE_NAME=package_name,
+            )
+            + "?state=deleted"
+        )
+
+        pkgs = []
+
+        for data in self._read_all_pages(endpoint):
+            pkgs.append(ContainerPackage(data))
+
+        return pkgs
+
+    def delete_package_version(self, package_data: ContainerPackage):
+        """
+        Deletes the given package version from the GHCR
+        """
+        resp = self._client.delete(package_data.url)
+        if resp.status_code != 204:
+            logger.warning(
+                f"Request to delete {package_data.url} returned HTTP {resp.status_code}",
+            )
+
+    def restore_package_version(
+        self,
+        package_name: str,
+        package_data: ContainerPackage,
+    ):
+        package_type: str = "container"
+        endpoint = self._PACKAGE_VERSION_RESTORE_ENDPOINT.format(
+            ORG=self._owner_or_org,
+            PACKAGE_TYPE=package_type,
+            PACKAGE_NAME=package_name,
+            PACKAGE_VERSION_ID=package_data.id,
+        )
+
+        resp = self._client.post(endpoint)
+        if resp.status_code != 204:
+            logger.warning(
+                f"Request to delete {endpoint} returned HTTP {resp.status_code}",
+            )

.github/workflows/ci.yml

@@ -44,8 +44,7 @@ jobs:
       -
         name: Install pipenv
         run: |
-          pipx install pipenv==2022.8.5
-          pipenv --version
+          pipx install pipenv==2022.10.12
       -
         name: Set up Python
         uses: actions/setup-python@v4
@@ -82,17 +81,32 @@ jobs:
       matrix:
         python-version: ['3.8', '3.9', '3.10']
       fail-fast: false
+    services:
+      tika:
+        image: ghcr.io/paperless-ngx/tika:latest
+        ports:
+          - "9998:9998/tcp"
+      gotenberg:
+        image: docker.io/gotenberg/gotenberg:7.6
+        ports:
+          - "3000:3000/tcp"
+    env:
+      # Enable Tika end to end testing
+      TIKA_LIVE: 1
+      # Enable paperless_mail testing against real server
+      PAPERLESS_MAIL_TEST_HOST: ${{ secrets.TEST_MAIL_HOST }}
+      PAPERLESS_MAIL_TEST_USER: ${{ secrets.TEST_MAIL_USER }}
+      PAPERLESS_MAIL_TEST_PASSWD: ${{ secrets.TEST_MAIL_PASSWD }}
     steps:
       -
         name: Checkout
         uses: actions/checkout@v3
         with:
-          fetch-depth: 2
+          fetch-depth: 0
       -
         name: Install pipenv
         run: |
-          pipx install pipenv==2022.8.5
-          pipenv --version
+          pipx install pipenv==2022.10.12
       -
         name: Set up Python
         uses: actions/setup-python@v4
@@ -117,11 +131,11 @@ jobs:
         name: Tests
         run: |
           cd src/
-          pipenv run pytest
+          pipenv run pytest -rfEp
       -
         name: Get changed files
         id: changed-files-specific
-        uses: tj-actions/changed-files@v29.0.2
+        uses: tj-actions/changed-files@v34
         with:
           files: |
             src/**
@@ -180,7 +194,7 @@ jobs:
         id: set-ghcr-repository
         run: |
           ghcr_name=$(echo "${GITHUB_REPOSITORY}" | awk '{ print tolower($0) }')
-          echo ::set-output name=repository::${ghcr_name}
+          echo "repository=${ghcr_name}" >> $GITHUB_OUTPUT
       -
         name: Checkout
         uses: actions/checkout@v3
@@ -197,7 +211,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=qpdf-json::${build_json}
+          echo "qpdf-json=${build_json}" >> $GITHUB_OUTPUT
       -
         name: Setup psycopg2 image
         id: psycopg2-setup
@@ -206,7 +220,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=psycopg2-json::${build_json}
+          echo "psycopg2-json=${build_json}" >> $GITHUB_OUTPUT
       -
         name: Setup pikepdf image
         id: pikepdf-setup
@@ -215,7 +229,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=pikepdf-json::${build_json}
+          echo "pikepdf-json=${build_json}" >> $GITHUB_OUTPUT
       -
         name: Setup jbig2enc image
         id: jbig2enc-setup
@@ -224,7 +238,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=jbig2enc-json::${build_json}
+          echo "jbig2enc-json=${build_json}" >> $GITHUB_OUTPUT
 
     outputs:
 
@@ -259,10 +273,10 @@ jobs:
         run: |
           if [[ ${{ needs.prepare-docker-build.outputs.ghcr-repository }} == "paperless-ngx/paperless-ngx" && ( ${{ github.ref_name }} == "main" || ${{ github.ref_name }} == "dev" || ${{ github.ref_name }} == "beta" || ${{ startsWith(github.ref, 'refs/tags/v') }} == "true" ) ]] ; then
             echo "Enabling DockerHub image push"
-            echo ::set-output name=enable::"true"
+            echo "enable=true" >> $GITHUB_OUTPUT
           else
             echo "Not pushing to DockerHub"
-            echo ::set-output name=enable::"false"
+            echo "enable=false" >> $GITHUB_OUTPUT
           fi
       -
         name: Gather Docker metadata
@@ -443,11 +457,11 @@ jobs:
         name: Get version
         id: get_version
         run: |
-          echo ::set-output name=version::${{ github.ref_name }}
+          echo "version=${{ github.ref_name }}" >> $GITHUB_OUTPUT
           if [[ ${{ contains(github.ref_name, '-beta.rc') }} == 'true' ]]; then
-            echo ::set-output name=prerelease::true
+            echo "prerelease=true" >> $GITHUB_OUTPUT
           else
-            echo ::set-output name=prerelease::false
+            echo "prerelease=false" >> $GITHUB_OUTPUT
           fi
       -
         name: Create Release and Changelog
@@ -484,6 +498,18 @@ jobs:
         uses: actions/checkout@v3
         with:
           ref: main
+      -
+        name: Install pipenv
+        run: |
+          pip3 install --upgrade pip setuptools wheel pipx
+          pipx install pipenv
+      -
+        name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: "pipenv"
+          cache-dependency-path: 'Pipfile.lock'
       -
         name: Append Changelog to docs
         id: append-Changelog
@@ -497,9 +523,10 @@ jobs:
           CURRENT_CHANGELOG=`tail --lines +2 changelog.md`
           echo -e "$CURRENT_CHANGELOG" >> changelog-new.md
           mv changelog-new.md changelog.md
+          pipenv run pre-commit run --files changelog.md
           git config --global user.name "github-actions"
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git commit -am "Changelog ${{ steps.get_version.outputs.version }} - GHA"
+          git commit -am "Changelog ${{ needs.publish-release.outputs.version }} - GHA"
           git push origin ${{ needs.publish-release.outputs.version }}-changelog
       -
         name: Create Pull Request

.github/workflows/cleanup-tags.yml

@@ -16,12 +16,34 @@ on:
     paths:
       - ".github/workflows/cleanup-tags.yml"
       - ".github/scripts/cleanup-tags.py"
+      - ".github/scripts/github.py"
       - ".github/scripts/common.py"
 
+concurrency:
+  group: registry-tags-cleanup
+  cancel-in-progress: false
+
 jobs:
-  cleanup:
-    name: Cleanup Image Tags
-    runs-on: ubuntu-20.04
+  cleanup-images:
+    name: Cleanup Image Tags for ${{ matrix.primary-name }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - primary-name: "paperless-ngx"
+            cache-name: "paperless-ngx/builder/cache/app"
+
+          - primary-name: "paperless-ngx/builder/qpdf"
+            cache-name: "paperless-ngx/builder/cache/qpdf"
+
+          - primary-name: "paperless-ngx/builder/pikepdf"
+            cache-name: "paperless-ngx/builder/cache/pikepdf"
+
+          - primary-name: "paperless-ngx/builder/jbig2enc"
+            cache-name: "paperless-ngx/builder/cache/jbig2enc"
+
+          - primary-name: "paperless-ngx/builder/psycopg2"
+            cache-name: "paperless-ngx/builder/cache/psycopg2"
     env:
       # Requires a personal access token with the OAuth scope delete:packages
       TOKEN: ${{ secrets.GHA_CONTAINER_DELETE_TOKEN }}
@@ -31,28 +53,43 @@ jobs:
         uses: actions/checkout@v3
       -
         name: Login to Github Container Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
       -
-        name: Install requests
+        name: Install httpx
         run: |
-          python -m pip install requests
+          python -m pip install httpx
+      #
+      # Clean up primary package
+      #
       -
-        name: Cleanup feature tags
-        # Only run if the token is not empty
+        name: Cleanup for package "${{ matrix.primary-name }}"
         if: "${{ env.TOKEN != '' }}"
         run: |
-          python ${GITHUB_WORKSPACE}/.github/scripts/cleanup-tags.py --loglevel info --untagged --delete
+          python ${GITHUB_WORKSPACE}/.github/scripts/cleanup-tags.py --untagged --is-manifest --delete "${{ matrix.primary-name }}"
+      #
+      # Clean up registry cache package
+      #
+      -
+        name: Cleanup for package "${{ matrix.cache-name }}"
+        if: "${{ env.TOKEN != '' }}"
+        run: |
+          python ${GITHUB_WORKSPACE}/.github/scripts/cleanup-tags.py --untagged --delete "${{ matrix.cache-name }}"
+      #
+      # Verify tags which are left still pull
+      #
       -
         name: Check all tags still pull
         run: |
-          ghcr_name=$(echo "${GITHUB_REPOSITORY}" | awk '{ print tolower($0) }')
-          docker pull --quiet --all-tags ghcr.io/${ghcr_name}
+          ghcr_name=$(echo "ghcr.io/${GITHUB_REPOSITORY_OWNER}/${{ matrix.primary-name }}" | awk '{ print tolower($0) }')
+          echo "Pulling all tags of ${ghcr_name}"
+          docker pull --quiet --all-tags ${ghcr_name}
+          docker image list

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/installer-library.yml

@@ -41,7 +41,7 @@ jobs:
         id: set-ghcr-repository
         run: |
           ghcr_name=$(echo "${GITHUB_REPOSITORY}" | awk '{ print tolower($0) }')
-          echo ::set-output name=repository::${ghcr_name}
+          echo "repository=${ghcr_name}" >> $GITHUB_OUTPUT
       -
         name: Checkout
         uses: actions/checkout@v3
@@ -50,6 +50,11 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: "3.9"
+      -
+        name: Install jq
+        run: |
+          sudo apt-get update
+          sudo apt-get install jq
       -
         name: Setup qpdf image
         id: qpdf-setup
@@ -58,7 +63,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=qpdf-json::${build_json}
+          echo "qpdf-json=${build_json}" >> $GITHUB_OUTPUT
       -
         name: Setup psycopg2 image
         id: psycopg2-setup
@@ -67,7 +72,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=psycopg2-json::${build_json}
+          echo "psycopg2-json=${build_json}" >> $GITHUB_OUTPUT
       -
         name: Setup pikepdf image
         id: pikepdf-setup
@@ -76,7 +81,7 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=pikepdf-json::${build_json}
+          echo "pikepdf-json=${build_json}" >> $GITHUB_OUTPUT
       -
         name: Setup jbig2enc image
         id: jbig2enc-setup
@@ -85,7 +90,19 @@ jobs:
 
           echo ${build_json}
 
-          echo ::set-output name=jbig2enc-json::${build_json}
+          echo "jbig2enc-json=${build_json}" >> $GITHUB_OUTPUT
+      -
+        name: Setup other versions
+        id: cache-bust-setup
+        run: |
+          pillow_version=$(jq ".default.pillow.version" Pipfile.lock | sed 's/=//g' | sed 's/"//g')
+          lxml_version=$(jq ".default.lxml.version" Pipfile.lock | sed 's/=//g' | sed 's/"//g')
+
+          echo "Pillow is ${pillow_version}"
+          echo "lxml is ${lxml_version}"
+
+          echo "pillow-version=${pillow_version}" >> $GITHUB_OUTPUT
+          echo "lxml-version=${lxml_version}" >> $GITHUB_OUTPUT
 
     outputs:
 
@@ -97,7 +114,11 @@ jobs:
 
       psycopg2-json: ${{ steps.psycopg2-setup.outputs.psycopg2-json }}
 
-      jbig2enc-json: ${{ steps.jbig2enc-setup.outputs.jbig2enc-json}}
+      jbig2enc-json: ${{ steps.jbig2enc-setup.outputs.jbig2enc-json }}
+
+      pillow-version: ${{ steps.cache-bust-setup.outputs.pillow-version }}
+
+      lxml-version: ${{ steps.cache-bust-setup.outputs.lxml-version }}
 
   build-qpdf-debs:
     name: qpdf
@@ -145,3 +166,5 @@ jobs:
         REPO=${{ needs.prepare-docker-build.outputs.ghcr-repository }}
         QPDF_VERSION=${{ fromJSON(needs.prepare-docker-build.outputs.qpdf-json).version }}
         PIKEPDF_VERSION=${{ fromJSON(needs.prepare-docker-build.outputs.pikepdf-json).version }}
+        PILLOW_VERSION=${{ needs.prepare-docker-build.outputs.pillow-version }}
+        LXML_VERSION=${{ needs.prepare-docker-build.outputs.lxml-version }}

.github/workflows/project-actions.yml

@@ -28,7 +28,7 @@ jobs:
     if: github.event_name == 'issues' && (github.event.action == 'opened' || github.event.action == 'reopened')
     steps:
       - name: Add issue to project and set status to ${{ env.todo }}
-        uses: leonsteinhaeuser/project-beta-automations@v1.3.0
+        uses: leonsteinhaeuser/project-beta-automations@v2.0.1
         with:
           gh_token: ${{ secrets.GH_TOKEN }}
           organization: paperless-ngx
@@ -44,7 +44,7 @@ jobs:
     if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') && github.event.pull_request.user.login != 'dependabot'
     steps:
       - name: Add PR to project and set status to "Needs Review"
-        uses: leonsteinhaeuser/project-beta-automations@v1.3.0
+        uses: leonsteinhaeuser/project-beta-automations@v2.0.1
         with:
           gh_token: ${{ secrets.GH_TOKEN }}
           organization: paperless-ngx

.gitignore

@@ -93,3 +93,6 @@ scripts/nuke
 
 # mac os
 .DS_Store
+
+# celery schedule file
+celerybeat-schedule*

.pre-commit-config.yaml

@@ -37,7 +37,7 @@ repos:
         exclude: "(^Pipfile\\.lock$)"
   # Python hooks
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.8.2
+    rev: v3.9.0
     hooks:
       - id: reorder-python-imports
         exclude: "(migrations)"
@@ -47,23 +47,23 @@ repos:
       - id: yesqa
         exclude: "(migrations)"
   - repo: https://github.com/asottile/add-trailing-comma
-    rev: "v2.2.3"
+    rev: "v2.3.0"
     hooks:
       - id: add-trailing-comma
         exclude: "(migrations)"
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.2
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
     hooks:
       - id: flake8
         files: ^src/
         args:
           - "--config=./src/setup.cfg"
   - repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.10.0
     hooks:
       - id: black
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.37.3
+    rev: v3.2.2
     hooks:
       - id: pyupgrade
         exclude: "(migrations)"

Dockerfile

@@ -30,6 +30,25 @@ RUN set -eux \
 RUN set -eux \
   && ./node_modules/.bin/ng build --configuration production
 
+FROM --platform=$BUILDPLATFORM python:3.9-slim-bullseye as pipenv-base
+
+# This stage generates the requirements.txt file using pipenv
+# This stage runs once for the native platform, as the outputs are not
+# dependent on target arch
+# This way, pipenv dependencies are not left in the final image
+# nor can pipenv mess up the final image somehow
+# Inputs: None
+
+WORKDIR /usr/src/pipenv
+
+COPY Pipfile* ./
+
+RUN set -eux \
+  && echo "Installing pipenv" \
+    && python3 -m pip install --no-cache-dir --upgrade pipenv \
+  && echo "Generating requirement.txt" \
+    && pipenv requirements > requirements.txt
+
 FROM python:3.9-slim-bullseye as main-app
 
 LABEL org.opencontainers.image.authors="paperless-ngx team <hello@paperless-ngx.com>"
@@ -132,6 +151,7 @@ COPY [ \
   "docker/paperless_cmd.sh", \
   "docker/wait-for-redis.py", \
   "docker/management_script.sh", \
+  "docker/flower-conditional.sh", \
   "docker/install_management_commands.sh", \
   "/usr/src/paperless/src/docker/" \
 ]
@@ -151,6 +171,8 @@ RUN set -eux \
     && chmod 755 /sbin/wait-for-redis.py \
     && mv paperless_cmd.sh /usr/local/bin/paperless_cmd.sh \
     && chmod 755 /usr/local/bin/paperless_cmd.sh \
+    && mv flower-conditional.sh /usr/local/bin/flower-conditional.sh \
+    && chmod 755 /usr/local/bin/flower-conditional.sh \
   && echo "Installing managment commands" \
     && chmod +x install_management_commands.sh \
     && ./install_management_commands.sh
@@ -163,7 +185,7 @@ RUN --mount=type=bind,from=qpdf-builder,target=/qpdf \
     --mount=type=bind,from=pikepdf-builder,target=/pikepdf \
   set -eux \
   && echo "Installing qpdf" \
-    && apt-get install --yes --no-install-recommends /qpdf/usr/src/qpdf/libqpdf28_*.deb \
+    && apt-get install --yes --no-install-recommends /qpdf/usr/src/qpdf/libqpdf29_*.deb \
     && apt-get install --yes --no-install-recommends /qpdf/usr/src/qpdf/qpdf_*.deb \
   && echo "Installing pikepdf and dependencies" \
     && python3 -m pip install --no-cache-dir /pikepdf/usr/src/wheels/pyparsing*.whl \
@@ -180,7 +202,7 @@ WORKDIR /usr/src/paperless/src/
 
 # Python dependencies
 # Change pretty frequently
-COPY Pipfile* ./
+COPY --from=pipenv-base /usr/src/pipenv/requirements.txt ./
 
 # Packages needed only for building a few quick Python
 # dependencies
@@ -195,24 +217,12 @@ RUN set -eux \
     && apt-get update \
     && apt-get install --yes --quiet --no-install-recommends ${BUILD_PACKAGES} \
     && python3 -m pip install --no-cache-dir --upgrade wheel \
-  && echo "Installing pipenv" \
-    && python3 -m pip install --no-cache-dir --upgrade pipenv \
   && echo "Installing Python requirements" \
-    # pipenv tries to be too fancy and prints so much junk
-    && pipenv requirements > requirements.txt \
     && python3 -m pip install --default-timeout=1000 --no-cache-dir --requirement requirements.txt \
-    && rm requirements.txt \
   && echo "Cleaning up image" \
     && apt-get -y purge ${BUILD_PACKAGES} \
     && apt-get -y autoremove --purge \
     && apt-get clean --yes \
-    # Remove pipenv and its unique packages
-    && python3 -m pip uninstall --yes \
-      pipenv \
-      distlib \
-      platformdirs \
-      virtualenv \
-      virtualenv-clone \
     && rm -rf /var/lib/apt/lists/* \
     && rm -rf /tmp/* \
     && rm -rf /var/tmp/* \

Pipfile

@@ -10,40 +10,42 @@ name = "piwheels"
 
 [packages]
 dateparser = "~=1.1"
-django = "~=4.0"
+django = "~=4.1"
 django-cors-headers = "*"
 django-extensions = "*"
 django-filter = "~=22.1"
-django-q = {editable = true, ref = "paperless-main", git = "https://github.com/paperless-ngx/django-q.git"}
-djangorestframework = "~=3.13"
+djangorestframework = "~=3.14"
 filelock = "*"
-fuzzywuzzy = {extras = ["speedup"], version = "*"}
 gunicorn = "*"
 imap-tools = "*"
 langdetect = "*"
 pathvalidate = "*"
-pillow = "~=9.2"
-pikepdf = "~=5.6"
+pillow = "~=9.3"
+pikepdf = "*"
 python-gnupg = "*"
 python-dotenv = "*"
 python-dateutil = "*"
 python-magic = "*"
 psycopg2 = "*"
-redis = "*"
+rapidfuzz = "*"
+redis = {extras = ["hiredis"], version = "*"}
 scikit-learn = "~=1.1"
 # Pin this until piwheels is building 1.9 (see https://www.piwheels.org/project/scipy/)
 scipy = "==1.8.1"
+numpy = "*"
 whitenoise = "~=6.2"
 watchdog = "~=2.1"
 whoosh="~=2.7"
 inotifyrecursive = "~=0.3"
-ocrmypdf = "~=13.7"
+ocrmypdf = "~=14.0"
 tqdm = "*"
 tika = "*"
 # TODO: This will sadly also install daphne+dependencies,
 #  which an ASGI server we don't need. Adds about 15MB image size.
 channels = "~=3.0"
-channels-redis = "*"
+# Locked version until https://github.com/django/channels_redis/issues/332
+# is resolved
+channels-redis = "==3.4.1"
 uvicorn = {extras = ["standard"], version = "*"}
 concurrent-log-handler = "*"
 "pdfminer.six" = "*"
@@ -51,8 +53,13 @@ concurrent-log-handler = "*"
 "importlib-resources" = {version = "*", markers = "python_version < '3.9'"}
 zipp = {version = "*", markers = "python_version < '3.9'"}
 pyzbar = "*"
-pdf2image = "*"
 mysqlclient = "*"
+celery = {extras = ["redis"], version = "*"}
+django-celery-results = "*"
+setproctitle = "*"
+nltk = "*"
+pdf2image = "*"
+flower = "*"
 
 [dev-packages]
 coveralls = "*"
@@ -64,7 +71,7 @@ pytest-django = "*"
 pytest-env = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
-sphinx = "~=5.1"
+sphinx = "~=5.3"
 sphinx_rtd_theme = "*"
 tox = "*"
 black = "*"

README.md

@@ -2,7 +2,7 @@
 [![Crowdin](https://badges.crowdin.net/paperless-ngx/localized.svg)](https://crowdin.com/project/paperless-ngx)
 [![Documentation Status](https://readthedocs.org/projects/paperless-ngx/badge/?version=latest)](https://paperless-ngx.readthedocs.io/en/latest/?badge=latest)
 [![Coverage Status](https://coveralls.io/repos/github/paperless-ngx/paperless-ngx/badge.svg?branch=master)](https://coveralls.io/github/paperless-ngx/paperless-ngx?branch=master)
-[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#paperless:adnidor.de)
+[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/%23paperlessngx%3Amatrix.org)
 
 <p align="center">
 <img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/Black%20logo%20-%20no%20background.png#gh-light-mode-only" width="50%" />
@@ -105,6 +105,7 @@ Paperless has been around a while now, and people are starting to build stuff on
 - [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless-ngx. Also works with the original Paperless and Paperless-ng.
 - [Paperless Share](https://github.com/qcasey/paperless_share). Share any files from your Android application with paperless. Very simple, but works with all of the mobile scanning apps out there that allow you to share scanned documents.
 - [Scan to Paperless](https://github.com/sbrunner/scan-to-paperless): Scan and prepare (crop, deskew, OCR, ...) your documents for Paperless.
+- [Paperless Mobile](https://github.com/astubenbord/paperless-mobile): A modern, feature rich mobile application for Paperless.
 
 These projects also exist, but their status and compatibility with paperless-ngx is unknown.
 

build-docker-image.sh

@@ -23,6 +23,8 @@ fi
 # Parse what we can from Pipfile.lock
 pikepdf_version=$(jq ".default.pikepdf.version" Pipfile.lock  | sed 's/=//g' | sed 's/"//g')
 psycopg2_version=$(jq ".default.psycopg2.version" Pipfile.lock | sed 's/=//g' | sed 's/"//g')
+pillow_version=$(jq ".default.pillow.version" Pipfile.lock | sed 's/=//g' | sed 's/"//g')
+lxml_version=$(jq ".default.lxml.version" Pipfile.lock | sed 's/=//g' | sed 's/"//g')
 # Read this from the other config file
 qpdf_version=$(jq ".qpdf.version" .build-config.json | sed 's/"//g')
 jbig2enc_version=$(jq ".jbig2enc.version" .build-config.json | sed 's/"//g')
@@ -40,4 +42,6 @@ docker build --file "$1" \
 	--build-arg JBIG2ENC_VERSION="${jbig2enc_version}" \
 	--build-arg QPDF_VERSION="${qpdf_version}" \
 	--build-arg PIKEPDF_VERSION="${pikepdf_version}" \
+	--build-arg PILLOW_VERSION="${pillow_version}" \
+	--build-arg LXML_VERSION="${lxml_version}" \
 	--build-arg PSYCOPG2_VERSION="${psycopg2_version}" "${@:2}" .

docker-builders/Dockerfile.frontend

@@ -1,14 +0,0 @@
-# This Dockerfile compiles the frontend
-# Inputs: None
-
-FROM node:16-bullseye-slim AS compile-frontend
-
-COPY ./src /src/src
-COPY ./src-ui /src/src-ui
-
-WORKDIR /src/src-ui
-RUN set -eux \
-  && npm update npm -g \
-  && npm ci --omit=optional
-RUN set -eux \
-  && ./node_modules/.bin/ng build --configuration production

docker-builders/Dockerfile.pikepdf

@@ -18,6 +18,10 @@ LABEL org.opencontainers.image.description="A intermediate image with pikepdf wh
 
 ARG DEBIAN_FRONTEND=noninteractive
 ARG PIKEPDF_VERSION
+# These are not used, but will still bust the cache if one changes
+# Otherwise, the main image will try to build thing (and fail)
+ARG PILLOW_VERSION
+ARG LXML_VERSION
 
 ARG BUILD_PACKAGES="\
   build-essential \
@@ -60,7 +64,7 @@ RUN set -eux \
     && apt-get update --quiet \
     && apt-get install --yes --quiet --no-install-recommends ${BUILD_PACKAGES} \
   && echo "Installing qpdf" \
-    && dpkg --install libqpdf28_*.deb \
+    && dpkg --install libqpdf29_*.deb \
     && dpkg --install libqpdf-dev_*.deb \
   && echo "Installing Python tools" \
     && python3 -m pip install --no-cache-dir --upgrade \

docker-builders/Dockerfile.qpdf

@@ -1,7 +1,7 @@
 # This Dockerfile compiles the jbig2enc library
 # Inputs:
 #    - QPDF_VERSION - the version of qpdf to build a .deb.
-#                     Must be preset as a deb-src
+#                     Must be present as a deb-src in bookworm
 
 FROM debian:bullseye-slim as main
 
@@ -22,27 +22,23 @@ ARG BUILD_PACKAGES="\
   libjpeg62-turbo-dev \
   libgnutls28-dev \
   packaging-dev \
+  cmake \
   zlib1g-dev"
 
 WORKDIR /usr/src
 
-# As this is an base image for a multi-stage final image
-# the added size of the install is basically irrelevant
-
 RUN set -eux \
   && echo "Installing build tools" \
     && apt-get update --quiet \
     && apt-get install --yes --quiet --no-install-recommends $BUILD_PACKAGES \
-  && echo "Building qpdf" \
+  && echo "Getting qpdf src" \
     && echo "deb-src http://deb.debian.org/debian/ bookworm main" > /etc/apt/sources.list.d/bookworm-src.list \
     && apt-get update \
     && mkdir qpdf \
     && cd qpdf \
     && apt-get source --yes --quiet qpdf=${QPDF_VERSION}-1/bookworm \
+  && echo "Building qpdf" \
     && cd qpdf-$QPDF_VERSION \
-    # We don't need to build the tests (also don't run them)
-    && rm -rf libtests \
-    && DEBEMAIL=hello@paperless-ngx.com debchange --bpo \
     && export DEB_BUILD_OPTIONS="terse nocheck nodoc parallel=2" \
     && dpkg-buildpackage --build=binary --unsigned-source --unsigned-changes --post-clean \
     && ls -ahl ../*.deb \

docker/compose/docker-compose.mariadb-tika.yml

@@ -77,18 +77,19 @@ services:
       PAPERLESS_REDIS: redis://broker:6379
       PAPERLESS_DBENGINE: mariadb
       PAPERLESS_DBHOST: db
-      PAPERLESS_DBUSER: paperless
-      PAPERLESS_DBPASSWORD: paperless
+      PAPERLESS_DBUSER: paperless # only needed if non-default username
+      PAPERLESS_DBPASS: paperless # only needed if non-default password
       PAPERLESS_DBPORT: 3306
       PAPERLESS_TIKA_ENABLED: 1
       PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.4
+    image: docker.io/gotenberg/gotenberg:7.6
     restart: unless-stopped
-    environment:
-      CHROMIUM_DISABLE_ROUTES: 1
+    command:
+      - "gotenberg"
+      - "--chromium-disable-routes=true"
 
   tika:
     image: ghcr.io/paperless-ngx/tika:latest

docker/compose/docker-compose.mariadb.yml

@@ -71,8 +71,8 @@ services:
       PAPERLESS_REDIS: redis://broker:6379
       PAPERLESS_DBENGINE: mariadb
       PAPERLESS_DBHOST: db
-      PAPERLESS_DBUSER: paperless
-      PAPERLESS_DBPASSWORD: paperless
+      PAPERLESS_DBUSER: paperless # only needed if non-default username
+      PAPERLESS_DBPASS: paperless # only needed if non-default password
       PAPERLESS_DBPORT: 3306
 
 

docker/compose/docker-compose.postgres-tika.yml

@@ -77,7 +77,7 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.4
+    image: docker.io/gotenberg/gotenberg:7.6
     restart: unless-stopped
     command:
       - "gotenberg"

docker/compose/docker-compose.sqlite-tika.yml

@@ -65,7 +65,7 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.4
+    image: docker.io/gotenberg/gotenberg:7.6
     restart: unless-stopped
     command:
       - "gotenberg"

docker/docker-entrypoint.sh

@@ -9,8 +9,8 @@ set -e
 # fill in the value of "$XYZ_DB_PASSWORD" from a file, especially for Docker's
 # secrets feature
 file_env() {
-	local var="$1"
-	local fileVar="${var}_FILE"
+	local -r var="$1"
+	local -r fileVar="${var}_FILE"
 
 	# Basic validation
 	if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then
@@ -35,14 +35,14 @@ file_env() {
 
 # Source: https://github.com/sameersbn/docker-gitlab/
 map_uidgid() {
-	USERMAP_ORIG_UID=$(id -u paperless)
-	USERMAP_ORIG_GID=$(id -g paperless)
-	USERMAP_NEW_UID=${USERMAP_UID:-$USERMAP_ORIG_UID}
-	USERMAP_NEW_GID=${USERMAP_GID:-${USERMAP_ORIG_GID:-$USERMAP_NEW_UID}}
-	if [[ ${USERMAP_NEW_UID} != "${USERMAP_ORIG_UID}" || ${USERMAP_NEW_GID} != "${USERMAP_ORIG_GID}" ]]; then
-		echo "Mapping UID and GID for paperless:paperless to $USERMAP_NEW_UID:$USERMAP_NEW_GID"
-		usermod -o -u "${USERMAP_NEW_UID}" paperless
-		groupmod -o -g "${USERMAP_NEW_GID}" paperless
+	local -r usermap_original_uid=$(id -u paperless)
+	local -r usermap_original_gid=$(id -g paperless)
+	local -r usermap_new_uid=${USERMAP_UID:-$usermap_original_uid}
+	local -r usermap_new_gid=${USERMAP_GID:-${usermap_original_gid:-$usermap_new_uid}}
+	if [[ ${usermap_new_uid} != "${usermap_original_uid}" || ${usermap_new_gid} != "${usermap_original_gid}" ]]; then
+		echo "Mapping UID and GID for paperless:paperless to $usermap_new_uid:$usermap_new_gid"
+		usermod -o -u "${usermap_new_uid}" paperless
+		groupmod -o -g "${usermap_new_gid}" paperless
 	fi
 }
 
@@ -50,6 +50,31 @@ map_folders() {
 	# Export these so they can be used in docker-prepare.sh
 	export DATA_DIR="${PAPERLESS_DATA_DIR:-/usr/src/paperless/data}"
 	export MEDIA_ROOT_DIR="${PAPERLESS_MEDIA_ROOT:-/usr/src/paperless/media}"
+	export CONSUME_DIR="${PAPERLESS_CONSUMPTION_DIR:-/usr/src/paperless/consume}"
+}
+
+nltk_data () {
+	# Store the NLTK data outside the Docker container
+	local -r nltk_data_dir="${DATA_DIR}/nltk"
+	local -r truthy_things=("yes y 1 t true")
+
+	# If not set, or it looks truthy
+	if [[ -z "${PAPERLESS_ENABLE_NLTK}" ]] || [[ "${truthy_things[*]}" =~ ${PAPERLESS_ENABLE_NLTK,} ]]; then
+
+		# Download or update the snowball stemmer data
+		python3 -W ignore::RuntimeWarning -m nltk.downloader -d "${nltk_data_dir}" snowball_data
+
+		# Download or update the stopwords corpus
+		python3 -W ignore::RuntimeWarning -m nltk.downloader -d "${nltk_data_dir}" stopwords
+
+		# Download or update the punkt tokenizer data
+		python3 -W ignore::RuntimeWarning -m nltk.downloader -d "${nltk_data_dir}" punkt
+
+	else
+		echo "Skipping NLTK data download"
+
+	fi
+
 }
 
 initialize() {
@@ -75,23 +100,33 @@ initialize() {
 	# Check for overrides of certain folders
 	map_folders
 
-	local export_dir="/usr/src/paperless/export"
+	local -r export_dir="/usr/src/paperless/export"
 
-	for dir in "${export_dir}" "${DATA_DIR}" "${DATA_DIR}/index" "${MEDIA_ROOT_DIR}" "${MEDIA_ROOT_DIR}/documents" "${MEDIA_ROOT_DIR}/documents/originals" "${MEDIA_ROOT_DIR}/documents/thumbnails"; do
+	for dir in \
+		"${export_dir}" \
+		"${DATA_DIR}" "${DATA_DIR}/index" \
+		"${MEDIA_ROOT_DIR}" "${MEDIA_ROOT_DIR}/documents" "${MEDIA_ROOT_DIR}/documents/originals" "${MEDIA_ROOT_DIR}/documents/thumbnails" \
+		"${CONSUME_DIR}"; do
 		if [[ ! -d "${dir}" ]]; then
 			echo "Creating directory ${dir}"
 			mkdir "${dir}"
 		fi
 	done
 
-	local tmp_dir="/tmp/paperless"
+	local -r tmp_dir="/tmp/paperless"
 	echo "Creating directory ${tmp_dir}"
 	mkdir -p "${tmp_dir}"
 
+	nltk_data
+
 	set +e
 	echo "Adjusting permissions of paperless files. This may take a while."
 	chown -R paperless:paperless ${tmp_dir}
-	for dir in "${export_dir}" "${DATA_DIR}" "${MEDIA_ROOT_DIR}"; do
+	for dir in \
+		"${export_dir}" \
+		"${DATA_DIR}" \
+		"${MEDIA_ROOT_DIR}" \
+		"${CONSUME_DIR}"; do
 		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown paperless:paperless {} +
 	done
 	set -e
@@ -102,8 +137,7 @@ initialize() {
 install_languages() {
 	echo "Installing languages..."
 
-	local langs="$1"
-	read -ra langs <<<"$langs"
+	read -ra langs <<<"$1"
 
 	# Check that it is not empty
 	if [ ${#langs[@]} -eq 0 ]; then

docker/docker-prepare.sh

@@ -4,12 +4,12 @@ set -e
 
 wait_for_postgres() {
 	local attempt_num=1
-	local max_attempts=5
+	local -r max_attempts=5
 
 	echo "Waiting for PostgreSQL to start..."
 
-	local host="${PAPERLESS_DBHOST:-localhost}"
-	local port="${PAPERLESS_DBPORT:-5432}"
+	local -r host="${PAPERLESS_DBHOST:-localhost}"
+	local -r port="${PAPERLESS_DBPORT:-5432}"
 
 	# Disable warning, host and port can't have spaces
 	# shellcheck disable=SC2086
@@ -31,11 +31,11 @@ wait_for_postgres() {
 wait_for_mariadb() {
 	echo "Waiting for MariaDB to start..."
 
-	host="${PAPERLESS_DBHOST:=localhost}"
-	port="${PAPERLESS_DBPORT:=3306}"
+	local -r host="${PAPERLESS_DBHOST:=localhost}"
+	local -r port="${PAPERLESS_DBPORT:=3306}"
 
-	attempt_num=1
-	max_attempts=5
+	local attempt_num=1
+	local -r max_attempts=5
 
 	while ! true > /dev/tcp/$host/$port; do
 
@@ -73,8 +73,8 @@ migrations() {
 
 search_index() {
 
-	local index_version=1
-	local index_version_file=${DATA_DIR}/.index_version
+	local -r index_version=1
+	local -r index_version_file=${DATA_DIR}/.index_version
 
 	if [[ (! -f "${index_version_file}") || $(<"${index_version_file}") != "$index_version" ]]; then
 		echo "Search index out of date. Updating..."
@@ -89,6 +89,46 @@ superuser() {
 	fi
 }
 
+custom_container_init() {
+	# Mostly borrowed from the LinuxServer.io base image
+	# https://github.com/linuxserver/docker-baseimage-ubuntu/tree/bionic/root/etc/cont-init.d
+	local -r custom_script_dir="/custom-cont-init.d"
+	# Tamper checking.
+	# Don't run files which are owned by anyone except root
+	# Don't run files which are writeable by others
+	if [ -d "${custom_script_dir}" ]; then
+		if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 ! -user root)" ]; then
+			echo "**** Potential tampering with custom scripts detected ****"
+			echo "**** The folder '${custom_script_dir}' must be owned by root ****"
+			return 0
+		fi
+		if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 -perm -o+w)" ]; then
+			echo "**** The folder '${custom_script_dir}' or some of contents have write permissions for others, which is a security risk. ****"
+			echo "**** Please review the permissions and their contents to make sure they are owned by root, and can only be modified by root. ****"
+			return 0
+		fi
+
+		# Make sure custom init directory has files in it
+		if [ -n "$(/bin/ls -A "${custom_script_dir}" 2>/dev/null)" ]; then
+			echo "[custom-init] files found in ${custom_script_dir} executing"
+			# Loop over files in the directory
+			for SCRIPT in "${custom_script_dir}"/*; do
+				NAME="$(basename "${SCRIPT}")"
+				if [ -f "${SCRIPT}" ]; then
+					echo "[custom-init] ${NAME}: executing..."
+					/bin/bash "${SCRIPT}"
+					echo "[custom-init] ${NAME}: exited $?"
+				elif [ ! -f "${SCRIPT}" ]; then
+					echo "[custom-init] ${NAME}: is not a file"
+				fi
+			done
+		else
+			echo "[custom-init] no custom files found exiting..."
+		fi
+
+	fi
+}
+
 do_work() {
 	if [[ "${PAPERLESS_DBENGINE}" == "mariadb" ]]; then
 		wait_for_mariadb
@@ -104,6 +144,9 @@ do_work() {
 
 	superuser
 
+	# Leave this last thing
+	custom_container_init
+
 }
 
 do_work

docker/flower-conditional.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+echo "Checking if we should start flower..."
+
+if [[ -n  "${PAPERLESS_ENABLE_FLOWER}" ]]; then
+	celery --app paperless flower
+fi

docker/paperless_cmd.sh

@@ -12,4 +12,4 @@ if [ "$(id -u)" == "$(id -u paperless)" ]; then
 	)
 fi
 
-/usr/local/bin/supervisord -c /etc/supervisord.conf "${rootless_args[@]}"
+exec /usr/local/bin/supervisord -c /etc/supervisord.conf "${rootless_args[@]}"

docker/supervisord.conf

@@ -10,7 +10,7 @@ user=root
 [program:gunicorn]
 command=gunicorn -c /usr/src/paperless/gunicorn.conf.py paperless.asgi:application
 user=paperless
-
+priority = 1
 stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
@@ -20,17 +20,40 @@ stderr_logfile_maxbytes=0
 command=python3 manage.py document_consumer
 user=paperless
 stopsignal=INT
-
+priority = 20
 stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
 stderr_logfile_maxbytes=0
 
-[program:scheduler]
-command=python3 manage.py qcluster
+[program:celery]
+
+command = celery --app paperless worker --loglevel INFO
 user=paperless
 stopasgroup = true
-
+stopwaitsecs = 60
+priority = 5
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+
+[program:celery-beat]
+
+command = celery --app paperless beat --loglevel INFO
+user=paperless
+stopasgroup = true
+priority = 10
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+
+[program:celery-flower]
+command = /usr/local/bin/flower-conditional.sh
+user = paperless
+startsecs = 0
+priority = 40
 stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr

docs/_static/css/custom.css

@@ -595,3 +595,11 @@ html.writer-html5 .rst-content dl.footnote code {
 .wy-nav-content-wrap {
   z-index: 20;
 }
+
+.rst-content .toctree-wrapper {
+  display: none;
+}
+
+.redirect-notice {
+  font-size: 2.5rem;
+}

docs/_templates/layout.html

@@ -8,6 +8,31 @@
 
         document.documentElement.classList.toggle("dark-mode", darkModeState);
         document.documentElement.classList.toggle("light-mode", !darkModeState);
+
+        const RTD_TO_MKD = {
+            "index.html": "",
+            "setup.html": "setup",
+            "usage_overview.html": "usage",
+            "advanced_usage.html": "advanced_usage",
+            "administration.html": "administration",
+            "configuration.html": "configuration",
+            "api.html": "api",
+            "faq.html": "faq",
+            "troubleshooting.html": "troubleshooting",
+            "extending.html": "development",
+            "scanners.html": "",
+            "screenshots.html": "",
+            "changelog.html": "changelog",
+        }
+
+        const path = (RTD_TO_MKD[window.location.pathname.substring(window.location.pathname.lastIndexOf("/") + 1)] ?? "") + "/";
+        const hash = window.location.hash;
+        const redirectURL = new URL(path  + hash, "https://docs.paperless-ngx.com/");
+        console.log(`Redirecting to ${redirectURL} in 3 seconds...`);
+
+        setTimeout(() => {
+            window.location.replace(redirectURL);
+        }, 3000);
     </script>
     {{ super() }}
 {% endblock %}

docs/administration.rst

@@ -1,523 +1,11 @@
+.. _administration:
 
 **************
 Administration
 **************
 
-.. _administration-backup:
+.. cssclass:: redirect-notice
 
-Making backups
-##############
+    The Paperless-ngx documentation has permanently moved.
 
-Multiple options exist for making backups of your paperless instance,
-depending on how you installed paperless.
-
-Before making backups, make sure that paperless is not running.
-
-Options available to any installation of paperless:
-
-*   Use the :ref:`document exporter <utilities-exporter>`.
-    The document exporter exports all your documents, thumbnails and
-    metadata to a specific folder. You may import your documents into a
-    fresh instance of paperless again or store your documents in another
-    DMS with this export.
-*   The document exporter is also able to update an already existing export.
-    Therefore, incremental backups with ``rsync`` are entirely possible.
-
-.. caution::
-
-    You cannot import the export generated with one version of paperless in a
-    different version of paperless. The export contains an exact image of the
-    database, and migrations may change the database layout.
-
-Options available to docker installations:
-
-*   Backup the docker volumes. These usually reside within
-    ``/var/lib/docker/volumes`` on the host and you need to be root in order
-    to access them.
-
-    Paperless uses 4 volumes:
-
-    *   ``paperless_media``: This is where your documents are stored.
-    *   ``paperless_data``: This is where auxillary data is stored. This
-        folder also contains the SQLite database, if you use it.
-    *   ``paperless_pgdata``: Exists only if you use PostgreSQL and contains
-        the database.
-    *   ``paperless_dbdata``: Exists only if you use MariaDB and contains
-        the database.
-
-Options available to bare-metal and non-docker installations:
-
-*   Backup the entire paperless folder. This ensures that if your paperless instance
-    crashes at some point or your disk fails, you can simply copy the folder back
-    into place and it works.
-
-    When using PostgreSQL or MariaDB, you'll also have to backup the database.
-
-.. _migrating-restoring:
-
-Restoring
-=========
-
-.. _administration-updating:
-
-Updating Paperless
-##################
-
-Docker Route
-============
-
-If a new release of paperless-ngx is available, upgrading depends on how you
-installed paperless-ngx in the first place. The releases are available at the
-`release page <https://github.com/paperless-ngx/paperless-ngx/releases>`_.
-
-First of all, ensure that paperless is stopped.
-
-.. code:: shell-session
-
-    $ cd /path/to/paperless
-    $ docker-compose down
-
-After that, :ref:`make a backup <administration-backup>`.
-
-A.  If you pull the image from the docker hub, all you need to do is:
-
-    .. code:: shell-session
-
-        $ docker-compose pull
-        $ docker-compose up
-
-    The docker-compose files refer to the ``latest`` version, which is always the latest
-    stable release.
-
-B.  If you built the image yourself, do the following:
-
-    .. code:: shell-session
-
-        $ git pull
-        $ docker-compose build
-        $ docker-compose up
-
-Running ``docker-compose up`` will also apply any new database migrations.
-If you see everything working, press CTRL+C once to gracefully stop paperless.
-Then you can start paperless-ngx with ``-d`` to have it run in the background.
-
-    .. note::
-
-        In version 0.9.14, the update process was changed. In 0.9.13 and earlier, the
-        docker-compose files specified exact versions and pull won't automatically
-        update to newer versions. In order to enable updates as described above, either
-        get the new ``docker-compose.yml`` file from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_
-        or edit the ``docker-compose.yml`` file, find the line that says
-
-            .. code::
-
-                image: ghcr.io/paperless-ngx/paperless-ngx:0.9.x
-
-        and replace the version with ``latest``:
-
-            .. code::
-
-                image: ghcr.io/paperless-ngx/paperless-ngx:latest
-
-    .. note::
-        In version 1.7.1 and onwards, the Docker image can now be pinned to a release series.
-        This is often combined with automatic updaters such as Watchtower to allow safer
-        unattended upgrading to new bugfix releases only.  It is still recommended to always
-        review release notes before upgrading.  To pin your install to a release series, edit
-        the ``docker-compose.yml`` find the line that says
-
-            .. code::
-
-                image: ghcr.io/paperless-ngx/paperless-ngx:latest
-
-        and replace the version with the series you want to track, for example:
-
-            .. code::
-
-                image: ghcr.io/paperless-ngx/paperless-ngx:1.7
-
-Bare Metal Route
-================
-
-After grabbing the new release and unpacking the contents, do the following:
-
-1.  Update dependencies. New paperless version may require additional
-    dependencies. The dependencies required are listed in the section about
-    :ref:`bare metal installations <setup-bare_metal>`.
-
-2.  Update python requirements. Keep in mind to activate your virtual environment
-    before that, if you use one.
-
-    .. code:: shell-session
-
-        $ pip install -r requirements.txt
-
-3.  Migrate the database.
-
-    .. code:: shell-session
-
-        $ cd src
-        $ python3 manage.py migrate
-
-    This might not actually do anything. Not every new paperless version comes with new
-    database migrations.
-
-Downgrading Paperless
-#####################
-
-Downgrades are possible. However, some updates also contain database migrations (these change the layout of the database and may move data).
-In order to move back from a version that applied database migrations, you'll have to revert the database migration *before* downgrading,
-and then downgrade paperless.
-
-This table lists the compatible versions for each database migration number.
-
-+------------------+-----------------+
-| Migration number | Version range   |
-+------------------+-----------------+
-| 1011             | 1.0.0           |
-+------------------+-----------------+
-| 1012             | 1.1.0 - 1.2.1   |
-+------------------+-----------------+
-| 1014             | 1.3.0 - 1.3.1   |
-+------------------+-----------------+
-| 1016             | 1.3.2 - current |
-+------------------+-----------------+
-
-Execute the following management command to migrate your database:
-
-.. code:: shell-session
-
-    $ python3 manage.py migrate documents <migration number>
-
-.. note::
-
-    Some migrations cannot be undone. The command will issue errors if that happens.
-
-.. _utilities-management-commands:
-
-Management utilities
-####################
-
-Paperless comes with some management commands that perform various maintenance
-tasks on your paperless instance. You can invoke these commands in the following way:
-
-With docker-compose, while paperless is running:
-
-.. code:: shell-session
-
-    $ cd /path/to/paperless
-    $ docker-compose exec webserver <command> <arguments>
-
-With docker, while paperless is running:
-
-.. code:: shell-session
-
-    $ docker exec -it <container-name> <command> <arguments>
-
-Bare metal:
-
-.. code:: shell-session
-
-    $ cd /path/to/paperless/src
-    $ python3 manage.py <command> <arguments>
-
-All commands have built-in help, which can be accessed by executing them with
-the argument ``--help``.
-
-.. _utilities-exporter:
-
-Document exporter
-=================
-
-The document exporter exports all your data from paperless into a folder for
-backup or migration to another DMS.
-
-If you use the document exporter within a cronjob to backup your data you might use the ``-T`` flag behind exec to suppress "The input device is not a TTY" errors. For example: ``docker-compose exec -T webserver document_exporter ../export``
-
-.. code::
-
-    document_exporter target [-c] [-f] [-d]
-
-    optional arguments:
-    -c, --compare-checksums
-    -f, --use-filename-format
-    -d, --delete
-
-``target`` is a folder to which the data gets written. This includes documents,
-thumbnails and a ``manifest.json`` file. The manifest contains all metadata from
-the database (correspondents, tags, etc).
-
-When you use the provided docker compose script, specify ``../export`` as the
-target. This path inside the container is automatically mounted on your host on
-the folder ``export``.
-
-If the target directory already exists and contains files, paperless will assume
-that the contents of the export directory are a previous export and will attempt
-to update the previous export. Paperless will only export changed and added files.
-Paperless determines whether a file has changed by inspecting the file attributes
-"date/time modified" and "size". If that does not work out for you, specify
-``--compare-checksums`` and paperless will attempt to compare file checksums instead.
-This is slower.
-
-Paperless will not remove any existing files in the export directory. If you want
-paperless to also remove files that do not belong to the current export such as files
-from deleted documents, specify ``--delete``. Be careful when pointing paperless to
-a directory that already contains other files.
-
-The filenames generated by this command follow the format
-``[date created] [correspondent] [title].[extension]``.
-If you want paperless to use ``PAPERLESS_FILENAME_FORMAT`` for exported filenames
-instead, specify ``--use-filename-format``.
-
-
-.. _utilities-importer:
-
-Document importer
-=================
-
-The document importer takes the export produced by the `Document exporter`_ and
-imports it into paperless.
-
-The importer works just like the exporter.  You point it at a directory, and
-the script does the rest of the work:
-
-.. code::
-
-    document_importer source
-
-When you use the provided docker compose script, put the export inside the
-``export`` folder in your paperless source directory. Specify ``../export``
-as the ``source``.
-
-.. note::
-
-    Importing from a previous version of Paperless may work, but for best results
-    it is suggested to match the versions.
-
-.. _utilities-retagger:
-
-Document retagger
-=================
-
-Say you've imported a few hundred documents and now want to introduce
-a tag or set up a new correspondent, and apply its matching to all of
-the currently-imported docs. This problem is common enough that
-there are tools for it.
-
-.. code::
-
-    document_retagger [-h] [-c] [-T] [-t] [-i] [--use-first] [-f]
-
-    optional arguments:
-    -c, --correspondent
-    -T, --tags
-    -t, --document_type
-    -s, --storage_path
-    -i, --inbox-only
-    --use-first
-    -f, --overwrite
-
-Run this after changing or adding matching rules. It'll loop over all
-of the documents in your database and attempt to match documents
-according to the new rules.
-
-Specify any combination of ``-c``, ``-T``, ``-t`` and ``-s`` to have the
-retagger perform matching of the specified metadata type. If you don't
-specify any of these options, the document retagger won't do anything.
-
-Specify ``-i`` to have the document retagger work on documents tagged
-with inbox tags only. This is useful when you don't want to mess with
-your already processed documents.
-
-When multiple document types or correspondents match a single document,
-the retagger won't assign these to the document. Specify ``--use-first``
-to override this behavior and just use the first correspondent or type
-it finds. This option does not apply to tags, since any amount of tags
-can be applied to a document.
-
-Finally, ``-f`` specifies that you wish to overwrite already assigned
-correspondents, types and/or tags. The default behavior is to not
-assign correspondents and types to documents that have this data already
-assigned. ``-f`` works differently for tags: By default, only additional tags get
-added to documents, no tags will be removed. With ``-f``, tags that don't
-match a document anymore get removed as well.
-
-
-Managing the Automatic matching algorithm
-=========================================
-
-The *Auto* matching algorithm requires a trained neural network to work.
-This network needs to be updated whenever somethings in your data
-changes. The docker image takes care of that automatically with the task
-scheduler. You can manually renew the classifier by invoking the following
-management command:
-
-.. code::
-
-    document_create_classifier
-
-This command takes no arguments.
-
-.. _`administration-index`:
-
-Managing the document search index
-==================================
-
-The document search index is responsible for delivering search results for the
-website. The document index is automatically updated whenever documents get
-added to, changed, or removed from paperless. However, if the search yields
-non-existing documents or won't find anything, you may need to recreate the
-index manually.
-
-.. code::
-
-    document_index {reindex,optimize}
-
-Specify ``reindex`` to have the index created from scratch. This may take some
-time.
-
-Specify ``optimize`` to optimize the index. This updates certain aspects of
-the index and usually makes queries faster and also ensures that the
-autocompletion works properly. This command is regularly invoked by the task
-scheduler.
-
-.. _utilities-renamer:
-
-Managing filenames
-==================
-
-If you use paperless' feature to
-:ref:`assign custom filenames to your documents <advanced-file_name_handling>`,
-you can use this command to move all your files after changing
-the naming scheme.
-
-.. warning::
-
-    Since this command moves your documents, it is advised to do
-    a backup beforehand. The renaming logic is robust and will never overwrite
-    or delete a file, but you can't ever be careful enough.
-
-.. code::
-
-    document_renamer
-
-The command takes no arguments and processes all your documents at once.
-
-Learn how to use :ref:`Management Utilities<utilities-management-commands>`.
-
-
-.. _utilities-sanity-checker:
-
-Sanity checker
-==============
-
-Paperless has a built-in sanity checker that inspects your document collection for issues.
-
-The issues detected by the sanity checker are as follows:
-
-* Missing original files.
-* Missing archive files.
-* Inaccessible original files due to improper permissions.
-* Inaccessible archive files due to improper permissions.
-* Corrupted original documents by comparing their checksum against what is stored in the database.
-* Corrupted archive documents by comparing their checksum against what is stored in the database.
-* Missing thumbnails.
-* Inaccessible thumbnails due to improper permissions.
-* Documents without any content (warning).
-* Orphaned files in the media directory (warning). These are files that are not referenced by any document im paperless.
-
-
-.. code::
-
-    document_sanity_checker
-
-The command takes no arguments. Depending on the size of your document archive, this may take some time.
-
-
-Fetching e-mail
-===============
-
-Paperless automatically fetches your e-mail every 10 minutes by default. If
-you want to invoke the email consumer manually, call the following management
-command:
-
-.. code::
-
-    mail_fetcher
-
-The command takes no arguments and processes all your mail accounts and rules.
-
-.. _utilities-archiver:
-
-Creating archived documents
-===========================
-
-Paperless stores archived PDF/A documents alongside your original documents.
-These archived documents will also contain selectable text for image-only
-originals.
-These documents are derived from the originals, which are always stored
-unmodified. If coming from an earlier version of paperless, your documents
-won't have archived versions.
-
-This command creates PDF/A documents for your documents.
-
-.. code::
-
-    document_archiver --overwrite --document <id>
-
-This command will only attempt to create archived documents when no archived
-document exists yet, unless ``--overwrite`` is specified. If ``--document <id>``
-is specified, the archiver will only process that document.
-
-.. note::
-
-    This command essentially performs OCR on all your documents again,
-    according to your settings. If you run this with ``PAPERLESS_OCR_MODE=redo``,
-    it will potentially run for a very long time. You can cancel the command
-    at any time, since this command will skip already archived versions the next time
-    it is run.
-
-.. note::
-
-    Some documents will cause errors and cannot be converted into PDF/A documents,
-    such as encrypted PDF documents. The archiver will skip over these documents
-    each time it sees them.
-
-.. _utilities-encyption:
-
-Managing encryption
-===================
-
-Documents can be stored in Paperless using GnuPG encryption.
-
-.. danger::
-
-    Encryption is deprecated since paperless-ngx 0.9 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.
-
-    Consider running paperless on an encrypted filesystem instead, which will then
-    at least provide security against physical hardware theft.
-
-
-Enabling encryption
--------------------
-
-Enabling encryption is no longer supported.
-
-
-Disabling encryption
---------------------
-
-Basic usage to disable encryption of your document store:
-
-(Note: If ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here)
-
-.. code::
-
-    decrypt_documents [--passphrase SECR3TP4SSPHRA$E]
+    You will be redirected shortly...

docs/advanced_usage.rst

@@ -1,365 +1,11 @@
+.. _advanced_usage:
+
 ***************
 Advanced topics
 ***************
 
-Paperless offers a couple features that automate certain tasks and make your life
-easier.
+.. cssclass:: redirect-notice
 
-.. _advanced-matching:
+    The Paperless-ngx documentation has permanently moved.
 
-Matching tags, correspondents, document types, and storage paths
-################################################################
-
-Paperless will compare the matching algorithms defined by every tag, correspondent,
-document type, and storage path in your database to see if they apply to the text
-in a document. In other words, if you define a tag called ``Home Utility``
-that had a ``match`` property of ``bc hydro`` and a ``matching_algorithm`` of
-``literal``, Paperless will automatically tag your newly-consumed document with
-your ``Home Utility`` tag so long as the text ``bc hydro`` appears in the body
-of the document somewhere.
-
-The matching logic is quite powerful. It supports searching the text of your
-document with different algorithms, and as such, some experimentation may be
-necessary to get things right.
-
-In order to have a tag, correspondent, document type, or storage path assigned
-automatically to newly consumed documents, assign a match and matching algorithm
-using the web interface. These settings define when to assign tags, correspondents,
-document types, and storage paths to documents.
-
-The following algorithms are available:
-
-* **Any:** Looks for any occurrence of any word provided in match in the PDF.
-  If you define the match as ``Bank1 Bank2``, it will match documents containing
-  either of these terms.
-* **All:** Requires that every word provided appears in the PDF, albeit not in the
-  order provided.
-* **Literal:** Matches only if the match appears exactly as provided (i.e. preserve ordering) in the PDF.
-* **Regular expression:** Parses the match as a regular expression and tries to
-  find a match within the document.
-* **Fuzzy match:** I don't know. Look at the source.
-* **Auto:** Tries to automatically match new documents. This does not require you
-  to set a match. See the notes below.
-
-When using the *any* or *all* matching algorithms, you can search for terms
-that consist of multiple words by enclosing them in double quotes. For example,
-defining a match text of ``"Bank of America" BofA`` using the *any* algorithm,
-will match documents that contain either "Bank of America" or "BofA", but will
-not match documents containing "Bank of South America".
-
-Then just save your tag, correspondent, document type, or storage path and run
-another document through the consumer.  Once complete, you should see the
-newly-created document, automatically tagged with the appropriate data.
-
-
-.. _advanced-automatic_matching:
-
-Automatic matching
-==================
-
-Paperless-ngx comes with a new matching algorithm called *Auto*. This matching
-algorithm tries to assign tags, correspondents, document types, and storage paths
-to your documents based on how you have already assigned these on existing documents.
-It uses a neural network under the hood.
-
-If, for example, all your bank statements of your account 123 at the Bank of
-America are tagged with the tag "bofa_123" and the matching algorithm of this
-tag is set to *Auto*, this neural network will examine your documents and
-automatically learn when to assign this tag.
-
-Paperless tries to hide much of the involved complexity with this approach.
-However, there are a couple caveats you need to keep in mind when using this
-feature:
-
-* Changes to your documents are not immediately reflected by the matching
-  algorithm. The neural network needs to be *trained* on your documents after
-  changes. Paperless periodically (default: once each hour) checks for changes
-  and does this automatically for you.
-* The Auto matching algorithm only takes documents into account which are NOT
-  placed in your inbox (i.e. have any inbox tags assigned to them). This ensures
-  that the neural network only learns from documents which you have correctly
-  tagged before.
-* The matching algorithm can only work if there is a correlation between the
-  tag, correspondent, document type, or storage path and the document itself.
-  Your bank statements usually contain your bank account number and the name
-  of the bank, so this works reasonably well, However, tags such as "TODO"
-  cannot be automatically assigned.
-* The matching algorithm needs a reasonable number of documents to identify when
-  to assign tags, correspondents, storage paths, and types. If one out of a
-  thousand documents has the correspondent "Very obscure web shop I bought
-  something five years ago", it will probably not assign this correspondent
-  automatically if you buy something from them again. The more documents, the better.
-* Paperless also needs a reasonable amount of negative examples to decide when
-  not to assign a certain tag, correspondent, document type, or storage path. This will
-  usually be the case as you start filling up paperless with documents.
-  Example: If all your documents are either from "Webshop" and "Bank", paperless
-  will assign one of these correspondents to ANY new document, if both are set
-  to automatic matching.
-
-Hooking into the consumption process
-####################################
-
-Sometimes you may want to do something arbitrary whenever a document is
-consumed.  Rather than try to predict what you may want to do, Paperless lets
-you execute scripts of your own choosing just before or after a document is
-consumed using a couple simple hooks.
-
-Just write a script, put it somewhere that Paperless can read & execute, and
-then put the path to that script in ``paperless.conf`` or ``docker-compose.env`` with the variable name
-of either ``PAPERLESS_PRE_CONSUME_SCRIPT`` or
-``PAPERLESS_POST_CONSUME_SCRIPT``.
-
-.. important::
-
-    These scripts are executed in a **blocking** process, which means that if
-    a script takes a long time to run, it can significantly slow down your
-    document consumption flow.  If you want things to run asynchronously,
-    you'll have to fork the process in your script and exit.
-
-
-Pre-consumption script
-======================
-
-Executed after the consumer sees a new document in the consumption folder, but
-before any processing of the document is performed. This script can access the
-following relevant environment variables set:
-
-* ``DOCUMENT_SOURCE_PATH``
-
-A simple but common example for this would be creating a simple script like
-this:
-
-``/usr/local/bin/ocr-pdf``
-
-.. code:: bash
-
-    #!/usr/bin/env bash
-    pdf2pdfocr.py -i ${DOCUMENT_SOURCE_PATH}
-
-``/etc/paperless.conf``
-
-.. code:: bash
-
-    ...
-    PAPERLESS_PRE_CONSUME_SCRIPT="/usr/local/bin/ocr-pdf"
-    ...
-
-This will pass the path to the document about to be consumed to ``/usr/local/bin/ocr-pdf``,
-which will in turn call `pdf2pdfocr.py`_ on your document, which will then
-overwrite the file with an OCR'd version of the file and exit.  At which point,
-the consumption process will begin with the newly modified file.
-
-.. _pdf2pdfocr.py: https://github.com/LeoFCardoso/pdf2pdfocr
-
-.. _advanced-post_consume_script:
-
-Post-consumption script
-=======================
-
-Executed after the consumer has successfully processed a document and has moved it
-into paperless. It receives the following environment variables:
-
-* ``DOCUMENT_ID``
-* ``DOCUMENT_FILE_NAME``
-* ``DOCUMENT_CREATED``
-* ``DOCUMENT_MODIFIED``
-* ``DOCUMENT_ADDED``
-* ``DOCUMENT_SOURCE_PATH``
-* ``DOCUMENT_ARCHIVE_PATH``
-* ``DOCUMENT_THUMBNAIL_PATH``
-* ``DOCUMENT_DOWNLOAD_URL``
-* ``DOCUMENT_THUMBNAIL_URL``
-* ``DOCUMENT_CORRESPONDENT``
-* ``DOCUMENT_TAGS``
-* ``DOCUMENT_ORIGINAL_FILENAME``
-
-The script can be in any language, but for a simple shell script
-example, you can take a look at `post-consumption-example.sh`_ in this project.
-
-The post consumption script cannot cancel the consumption process.
-
-Docker
-------
-Assumed you have ``/home/foo/paperless-ngx/scripts/post-consumption-example.sh``.
-
-You can pass that script into the consumer container via a host mount in your ``docker-compose.yml``.
-
-.. code:: bash
-
-  ...
-  consumer:
-    ...
-    volumes:
-      ...
-      - /home/paperless-ngx/scripts:/path/in/container/scripts/
-  ...
-
-Example (docker-compose.yml): ``- /home/foo/paperless-ngx/scripts:/usr/src/paperless/scripts``
-
-which in turn requires the variable ``PAPERLESS_POST_CONSUME_SCRIPT`` in ``docker-compose.env``  to point to ``/path/in/container/scripts/post-consumption-example.sh``.
-
-Example (docker-compose.env): ``PAPERLESS_POST_CONSUME_SCRIPT=/usr/src/paperless/scripts/post-consumption-example.sh``
-
-Troubleshooting:
-
-- Monitor the docker-compose log ``cd ~/paperless-ngx; docker-compose logs -f``
-- Check your script's permission e.g. in case of permission error ``sudo chmod 755 post-consumption-example.sh``
-- Pipe your scripts's output to a log file e.g. ``echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log``
-
-.. _post-consumption-example.sh: https://github.com/paperless-ngx/paperless-ngx/blob/main/scripts/post-consumption-example.sh
-
-.. _advanced-file_name_handling:
-
-File name handling
-##################
-
-By default, paperless stores your documents in the media directory and renames them
-using the identifier which it has assigned to each document. You will end up getting
-files like ``0000123.pdf`` in your media directory. This isn't necessarily a bad
-thing, because you normally don't have to access these files manually. However, if
-you wish to name your files differently, you can do that by adjusting the
-``PAPERLESS_FILENAME_FORMAT`` configuration option.
-
-This variable allows you to configure the filename (folders are allowed) using
-placeholders. For example, configuring this to
-
-.. code:: bash
-
-    PAPERLESS_FILENAME_FORMAT={created_year}/{correspondent}/{title}
-
-will create a directory structure as follows:
-
-.. code::
-
-    2019/
-      My bank/
-        Statement January.pdf
-        Statement February.pdf
-    2020/
-      My bank/
-        Statement January.pdf
-        Letter.pdf
-        Letter_01.pdf
-      Shoe store/
-        My new shoes.pdf
-
-.. danger::
-
-    Do not manually move your files in the media folder. Paperless remembers the
-    last filename a document was stored as. If you do rename a file, paperless will
-    report your files as missing and won't be able to find them.
-
-Paperless provides the following placeholders within filenames:
-
-* ``{asn}``: The archive serial number of the document, or "none".
-* ``{correspondent}``: The name of the correspondent, or "none".
-* ``{document_type}``: The name of the document type, or "none".
-* ``{tag_list}``: A comma separated list of all tags assigned to the document.
-* ``{title}``: The title of the document.
-* ``{created}``: The full date (ISO format) the document was created.
-* ``{created_year}``: Year created only.
-* ``{created_month}``: Month created only (number 01-12).
-* ``{created_day}``: Day created only (number 01-31).
-* ``{added}``: The full date (ISO format) the document was added to paperless.
-* ``{added_year}``: Year added only.
-* ``{added_month}``: Month added only (number 01-12).
-* ``{added_day}``: Day added only (number 01-31).
-
-
-Paperless will try to conserve the information from your database as much as possible.
-However, some characters that you can use in document titles and correspondent names (such
-as ``: \ /`` and a couple more) are not allowed in filenames and will be replaced with dashes.
-
-If paperless detects that two documents share the same filename, paperless will automatically
-append ``_01``, ``_02``, etc to the filename. This happens if all the placeholders in a filename
-evaluate to the same value.
-
-.. hint::
-    You can affect how empty placeholders are treated by changing the following setting to
-    `true`.
-
-    .. code::
-
-        PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=True
-
-    Doing this results in all empty placeholders resolving to "" instead of "none" as stated above.
-    Spaces before empty placeholders are removed as well, empty directories are omitted.
-
-.. hint::
-
-    Paperless checks the filename of a document whenever it is saved. Therefore,
-    you need to update the filenames of your documents and move them after altering
-    this setting by invoking the :ref:`document renamer <utilities-renamer>`.
-
-.. warning::
-
-    Make absolutely sure you get the spelling of the placeholders right, or else
-    paperless will use the default naming scheme instead.
-
-.. caution::
-
-    As of now, you could totally tell paperless to store your files anywhere outside
-    the media directory by setting
-
-    .. code::
-
-        PAPERLESS_FILENAME_FORMAT=../../my/custom/location/{title}
-
-    However, keep in mind that inside docker, if files get stored outside of the
-    predefined volumes, they will be lost after a restart of paperless.
-
-
-Storage paths
-#############
-
-One of the best things in Paperless is that you can not only access the documents via the
-web interface, but also via the file system.
-
-When as single storage layout is not sufficient for your use case, storage paths come to
-the rescue. Storage paths allow you to configure more precisely where each document is stored
-in the file system.
-
-- Each storage path is a `PAPERLESS_FILENAME_FORMAT` and follows the rules described above
-- Each document is assigned a storage path using the matching algorithms described above, but
-  can be overwritten at any time
-
-For example, you could define the following two storage paths:
-
-1. Normal communications are put into a folder structure sorted by `year/correspondent`
-2. Communications with insurance companies are stored in a flat structure with longer file names,
-   but containing the full date of the correspondence.
-
-.. code::
-
-    By Year = {created_year}/{correspondent}/{title}
-    Insurances = Insurances/{correspondent}/{created_year}-{created_month}-{created_day} {title}
-
-
-If you then map these storage paths to the documents, you might get the following result.
-For simplicity, `By Year` defines the same structure as in the previous example above.
-
-.. code:: text
-
-   2019/                                   # By Year
-      My bank/
-        Statement January.pdf
-        Statement February.pdf
-
-    Insurances/                           # Insurances
-      Healthcare 123/
-        2022-01-01 Statement January.pdf
-        2022-02-02 Letter.pdf
-        2022-02-03 Letter.pdf
-      Dental 456/
-        2021-12-01 New Conditions.pdf
-
-
-.. hint::
-
-    Defining a storage path is optional. If no storage path is defined for a document, the global
-    `PAPERLESS_FILENAME_FORMAT` is applied.
-
-.. caution::
-
-    If you adjust the format of an existing storage path, old documents don't get relocated automatically.
-    You need to run the :ref:`document renamer <utilities-renamer>` to adjust their pathes.
+    You will be redirected shortly...

docs/api.rst

@@ -1,303 +1,12 @@
+.. _api:
 
 ************
 The REST API
 ************
 
 
-Paperless makes use of the `Django REST Framework`_ standard API interface.
-It provides a browsable API for most of its endpoints, which you can inspect
-at ``http://<paperless-host>:<port>/api/``. This also documents most of the
-available filters and ordering fields.
+.. cssclass:: redirect-notice
 
-.. _Django REST Framework: http://django-rest-framework.org/
+    The Paperless-ngx documentation has permanently moved.
 
-The API provides 5 main endpoints:
-
-*   ``/api/documents/``: Full CRUD support, except POSTing new documents. See below.
-*   ``/api/correspondents/``: Full CRUD support.
-*   ``/api/document_types/``: Full CRUD support.
-*   ``/api/logs/``: Read-Only.
-*   ``/api/tags/``: Full CRUD support.
-
-All of these endpoints except for the logging endpoint
-allow you to fetch, edit and delete individual objects
-by appending their primary key to the path, for example ``/api/documents/454/``.
-
-The objects served by the document endpoint contain the following fields:
-
-*   ``id``: ID of the document. Read-only.
-*   ``title``: Title of the document.
-*   ``content``: Plain text content of the document.
-*   ``tags``: List of IDs of tags assigned to this document, or empty list.
-*   ``document_type``: Document type of this document, or null.
-*   ``correspondent``:  Correspondent of this document or null.
-*   ``created``: The date time at which this document was created.
-*   ``created_date``: The date (YYYY-MM-DD) at which this document was created. Optional. If also passed with created, this is ignored.
-*   ``modified``: The date at which this document was last edited in paperless. Read-only.
-*   ``added``: The date at which this document was added to paperless. Read-only.
-*   ``archive_serial_number``: The identifier of this document in a physical document archive.
-*   ``original_file_name``: Verbose filename of the original document. Read-only.
-*   ``archived_file_name``: Verbose filename of the archived document. Read-only. Null if no archived document is available.
-
-
-Downloading documents
-#####################
-
-In addition to that, the document endpoint offers these additional actions on
-individual documents:
-
-*   ``/api/documents/<pk>/download/``: Download the document.
-*   ``/api/documents/<pk>/preview/``: Display the document inline,
-    without downloading it.
-*   ``/api/documents/<pk>/thumb/``: Download the PNG thumbnail of a document.
-
-Paperless generates archived PDF/A documents from consumed files and stores both
-the original files as well as the archived files. By default, the endpoints
-for previews and downloads serve the archived file, if it is available.
-Otherwise, the original file is served.
-Some document cannot be archived.
-
-The endpoints correctly serve the response header fields ``Content-Disposition``
-and ``Content-Type`` to indicate the filename for download and the type of content of
-the document.
-
-In order to download or preview the original document when an archived document is available,
-supply the query parameter ``original=true``.
-
-.. hint::
-
-    Paperless used to provide these functionality at ``/fetch/<pk>/preview``,
-    ``/fetch/<pk>/thumb`` and ``/fetch/<pk>/doc``. Redirects to the new URLs
-    are in place. However, if you use these old URLs to access documents, you
-    should update your app or script to use the new URLs.
-
-
-Getting document metadata
-#########################
-
-The api also has an endpoint to retrieve read-only metadata about specific documents. this
-information is not served along with the document objects, since it requires reading
-files and would therefore slow down document lists considerably.
-
-Access the metadata of a document with an ID ``id`` at ``/api/documents/<id>/metadata/``.
-
-The endpoint reports the following data:
-
-*   ``original_checksum``: MD5 checksum of the original document.
-*   ``original_size``: Size of the original document, in bytes.
-*   ``original_mime_type``: Mime type of the original document.
-*   ``media_filename``: Current filename of the document, under which it is stored inside the media directory.
-*   ``has_archive_version``: True, if this document is archived, false otherwise.
-*   ``original_metadata``: A list of metadata associated with the original document. See below.
-*   ``archive_checksum``: MD5 checksum of the archived document, or null.
-*   ``archive_size``: Size of the archived document in bytes, or null.
-*   ``archive_metadata``: Metadata associated with the archived document, or null. See below.
-
-File metadata is reported as a list of objects in the following form:
-
-.. code:: json
-
-    [
-        {
-            "namespace": "http://ns.adobe.com/pdf/1.3/",
-            "prefix": "pdf",
-            "key": "Producer",
-            "value": "SparklePDF, Fancy edition"
-        },
-    ]
-
-``namespace`` and ``prefix`` can be null. The actual metadata reported depends on the file type and the metadata
-available in that specific document. Paperless only reports PDF metadata at this point.
-
-Authorization
-#############
-
-The REST api provides three different forms of authentication.
-
-1.  Basic authentication
-
-    Authorize by providing a HTTP header in the form
-
-    .. code::
-
-        Authorization: Basic <credentials>
-
-    where ``credentials`` is a base64-encoded string of ``<username>:<password>``
-
-2.  Session authentication
-
-    When you're logged into paperless in your browser, you're automatically
-    logged into the API as well and don't need to provide any authorization
-    headers.
-
-3.  Token authentication
-
-    Paperless also offers an endpoint to acquire authentication tokens.
-
-    POST a username and password as a form or json string to ``/api/token/``
-    and paperless will respond with a token, if the login data is correct.
-    This token can be used to authenticate other requests with the
-    following HTTP header:
-
-    .. code::
-
-        Authorization: Token <token>
-
-    Tokens can be managed and revoked in the paperless admin.
-
-Searching for documents
-#######################
-
-Full text searching is available on the ``/api/documents/`` endpoint. Two specific
-query parameters cause the API to return full text search results:
-
-*   ``/api/documents/?query=your%20search%20query``: Search for a document using a full text query.
-    For details on the syntax, see :ref:`basic-usage_searching`.
-
-*   ``/api/documents/?more_like=1234``: Search for documents similar to the document with id 1234.
-
-Pagination works exactly the same as it does for normal requests on this endpoint.
-
-Certain limitations apply to full text queries:
-
-*   Results are always sorted by search score. The results matching the query best will show up first.
-
-*   Only a small subset of filtering parameters are supported.
-
-Furthermore, each returned document has an additional ``__search_hit__`` attribute with various information
-about the search results:
-
-.. code::
-
-    {
-        "count": 31,
-        "next": "http://localhost:8000/api/documents/?page=2&query=test",
-        "previous": null,
-        "results": [
-
-            ...
-
-            {
-                "id": 123,
-                "title": "title",
-                "content": "content",
-
-                ...
-
-                "__search_hit__": {
-                    "score": 0.343,
-                    "highlights": "text <span class=\"match\">Test</span> text",
-                    "rank": 23
-                }
-            },
-
-            ...
-
-        ]
-    }
-
-*   ``score`` is an indication how well this document matches the query relative to the other search results.
-*   ``highlights`` is an excerpt from the document content and highlights the search terms with ``<span>`` tags as shown above.
-*   ``rank`` is the index of the search results. The first result will have rank 0.
-
-``/api/search/autocomplete/``
-=============================
-
-Get auto completions for a partial search term.
-
-Query parameters:
-
-*   ``term``: The incomplete term.
-*   ``limit``: Amount of results. Defaults to 10.
-
-Results returned by the endpoint are ordered by importance of the term in the
-document index. The first result is the term that has the highest Tf/Idf score
-in the index.
-
-.. code:: json
-
-    [
-        "term1",
-        "term3",
-        "term6",
-        "term4"
-    ]
-
-
-.. _api-file_uploads:
-
-POSTing documents
-#################
-
-The API provides a special endpoint for file uploads:
-
-``/api/documents/post_document/``
-
-POST a multipart form to this endpoint, where the form field ``document`` contains
-the document that you want to upload to paperless. The filename is sanitized and
-then used to store the document in a temporary directory, and the consumer will
-be instructed to consume the document from there.
-
-The endpoint supports the following optional form fields:
-
-*   ``title``: Specify a title that the consumer should use for the document.
-*   ``created``: Specify a DateTime where the document was created (e.g. "2016-04-19" or "2016-04-19 06:15:00+02:00").
-*   ``correspondent``: Specify the ID of a correspondent that the consumer should use for the document.
-*   ``document_type``: Similar to correspondent.
-*   ``tags``: Similar to correspondent. Specify this multiple times to have multiple tags added
-    to the document.
-
-
-The endpoint will immediately return "OK" if the document consumption process
-was started successfully. No additional status information about the consumption
-process itself is available, since that happens in a different process.
-
-
-.. _api-versioning:
-
-API Versioning
-##############
-
-The REST API is versioned since Paperless-ngx 1.3.0.
-
-* Versioning ensures that changes to the API don't break older clients.
-* Clients specify the specific version of the API they wish to use with every request and Paperless will handle the request using the specified API version.
-* Even if the underlying data model changes, older API versions will always serve compatible data.
-* If no version is specified, Paperless will serve version 1 to ensure compatibility with older clients that do not request a specific API version.
-
-API versions are specified by submitting an additional HTTP ``Accept`` header with every request:
-
-.. code::
-
-    Accept: application/json; version=6
-
-If an invalid version is specified, Paperless 1.3.0 will respond with "406 Not Acceptable" and an error message in the body.
-Earlier versions of Paperless will serve API version 1 regardless of whether a version is specified via the ``Accept`` header.
-
-If a client wishes to verify whether it is compatible with any given server, the following procedure should be performed:
-
-1.  Perform an *authenticated* request against any API endpoint. If the server is on version 1.3.0 or newer, the server will
-    add two custom headers to the response:
-
-    .. code::
-
-        X-Api-Version: 2
-        X-Version: 1.3.0
-
-2.  Determine whether the client is compatible with this server based on the presence/absence of these headers and their values if present.
-
-
-API Changelog
-=============
-
-Version 1
----------
-
-Initial API version.
-
-Version 2
----------
-
-* Added field ``Tag.color``. This read/write string field contains a hex color such as ``#a6cee3``.
-* Added read-only field ``Tag.text_color``. This field contains the text color to use for a specific tag, which is either black or white depending on the brightness of ``Tag.color``.
-* Removed field ``Tag.colour``.
+    You will be redirected shortly...

docs/changelog.rst

@@ -0,0 +1,11 @@
+.. _changelog:
+
+*********
+Changelog
+*********
+
+.. cssclass:: redirect-notice
+
+    The Paperless-ngx documentation has permanently moved.
+
+    You will be redirected shortly...

docs/configuration.rst

@@ -4,922 +4,9 @@
 Configuration
 *************
 
-Paperless provides a wide range of customizations.
-Depending on how you run paperless, these settings have to be defined in different
-places.
 
-*   If you run paperless on docker, ``paperless.conf`` is not used. Rather, configure
-    paperless by copying necessary options to ``docker-compose.env``.
-*   If you are running paperless on anything else, paperless will search for the
-    configuration file in these locations and use the first one it finds:
+.. cssclass:: redirect-notice
 
-    .. code::
+    The Paperless-ngx documentation has permanently moved.
 
-        /path/to/paperless/paperless.conf
-        /etc/paperless.conf
-        /usr/local/etc/paperless.conf
-
-
-Required services
-#################
-
-PAPERLESS_REDIS=<url>
-    This is required for processing scheduled tasks such as email fetching, index
-    optimization and for training the automatic document matcher.
-
-    * If your Redis server needs login credentials PAPERLESS_REDIS = ``redis://<username>:<password>@<host>:<port>``
-
-    * With the requirepass option PAPERLESS_REDIS = ``redis://:<password>@<host>:<port>``
-
-    `More information on securing your Redis Instance <https://redis.io/docs/getting-started/#securing-redis>`_.
-
-    Defaults to redis://localhost:6379.
-
-PAPERLESS_DBENGINE=<engine_name>
-    Optional, gives the ability to choose Postgres or MariaDB for database engine.
-    Available options are `postgresql` and `mariadb`.
-    Default is `postgresql`.
-
-PAPERLESS_DBHOST=<hostname>
-    By default, sqlite is used as the database backend. This can be changed here.
-
-    Set PAPERLESS_DBHOST and another database will be used instead of sqlite.
-
-PAPERLESS_DBPORT=<port>
-    Adjust port if necessary.
-
-    Default is 5432.
-
-PAPERLESS_DBNAME=<name>
-    Database name in PostgreSQL or MariaDB.
-
-    Defaults to "paperless".
-
-PAPERLESS_DBUSER=<name>
-    Database user in PostgreSQL or MariaDB.
-
-    Defaults to "paperless".
-
-PAPERLESS_DBPASS=<password>
-    Database password for PostgreSQL or MariaDB.
-
-    Defaults to "paperless".
-
-PAPERLESS_DBSSLMODE=<mode>
-    SSL mode to use when connecting to PostgreSQL.
-
-    See `the official documentation about sslmode <https://www.postgresql.org/docs/current/libpq-ssl.html>`_.
-
-    Default is ``prefer``.
-
-PAPERLESS_DB_TIMEOUT=<float>
-    Amount of time for a database connection to wait for the database to unlock.
-    Mostly applicable for an sqlite based installation, consider changing to postgresql
-    if you need to increase this.
-
-    Defaults to unset, keeping the Django defaults.
-
-Paths and folders
-#################
-
-PAPERLESS_CONSUMPTION_DIR=<path>
-    This where your documents should go to be consumed.  Make sure that it exists
-    and that the user running the paperless service can read/write its contents
-    before you start Paperless.
-
-    Don't change this when using docker, as it only changes the path within the
-    container. Change the local consumption directory in the docker-compose.yml
-    file instead.
-
-    Defaults to "../consume/", relative to the "src" directory.
-
-PAPERLESS_DATA_DIR=<path>
-    This is where paperless stores all its data (search index, SQLite database,
-    classification model, etc).
-
-    Defaults to "../data/", relative to the "src" directory.
-
-PAPERLESS_TRASH_DIR=<path>
-    Instead of removing deleted documents, they are moved to this directory.
-
-    This must be writeable by the user running paperless. When running inside
-    docker, ensure that this path is within a permanent volume (such as
-    "../media/trash") so it won't get lost on upgrades.
-
-    Defaults to empty (i.e. really delete documents).
-
-PAPERLESS_MEDIA_ROOT=<path>
-    This is where your documents and thumbnails are stored.
-
-    You can set this and PAPERLESS_DATA_DIR to the same folder to have paperless
-    store all its data within the same volume.
-
-    Defaults to "../media/", relative to the "src" directory.
-
-PAPERLESS_STATICDIR=<path>
-    Override the default STATIC_ROOT here.  This is where all static files
-    created using "collectstatic" manager command are stored.
-
-    Unless you're doing something fancy, there is no need to override this.
-
-    Defaults to "../static/", relative to the "src" directory.
-
-PAPERLESS_FILENAME_FORMAT=<format>
-    Changes the filenames paperless uses to store documents in the media directory.
-    See :ref:`advanced-file_name_handling` for details.
-
-    Default is none, which disables this feature.
-
-PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=<bool>
-    Tells paperless to replace placeholders in `PAPERLESS_FILENAME_FORMAT` that would resolve
-    to 'none' to be omitted from the resulting filename. This also holds true for directory
-    names.
-    See :ref:`advanced-file_name_handling` for details.
-
-    Defaults to `false` which disables this feature.
-
-PAPERLESS_LOGGING_DIR=<path>
-    This is where paperless will store log files.
-
-    Defaults to "``PAPERLESS_DATA_DIR``/log/".
-
-
-Logging
-#######
-
-PAPERLESS_LOGROTATE_MAX_SIZE=<num>
-    Maximum file size for log files before they are rotated, in bytes.
-
-    Defaults to 1 MiB.
-
-PAPERLESS_LOGROTATE_MAX_BACKUPS=<num>
-    Number of rotated log files to keep.
-
-    Defaults to 20.
-
-.. _hosting-and-security:
-
-Hosting & Security
-##################
-
-PAPERLESS_SECRET_KEY=<key>
-    Paperless uses this to make session tokens. If you expose paperless on the
-    internet, you need to change this, since the default secret is well known.
-
-    Use any sequence of characters. The more, the better. You don't need to
-    remember this. Just face-roll your keyboard.
-
-    Default is listed in the file ``src/paperless/settings.py``.
-
-PAPERLESS_URL=<url>
-    This setting can be used to set the three options below (ALLOWED_HOSTS,
-    CORS_ALLOWED_HOSTS and CSRF_TRUSTED_ORIGINS). If the other options are
-    set the values will be combined with this one. Do not include a trailing
-    slash. E.g. https://paperless.domain.com
-
-    Defaults to empty string, leaving the other settings unaffected.
-
-PAPERLESS_CSRF_TRUSTED_ORIGINS=<comma-separated-list>
-    A list of trusted origins for unsafe requests (e.g. POST). As of Django 4.0
-    this is required to access the Django admin via the web.
-    See https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins
-
-    Can also be set using PAPERLESS_URL (see above).
-
-    Defaults to empty string, which does not add any origins to the trusted list.
-
-PAPERLESS_ALLOWED_HOSTS=<comma-separated-list>
-    If you're planning on putting Paperless on the open internet, then you
-    really should set this value to the domain name you're using.  Failing to do
-    so leaves you open to HTTP host header attacks:
-    https://docs.djangoproject.com/en/3.1/topics/security/#host-header-validation
-
-    Just remember that this is a comma-separated list, so "example.com" is fine,
-    as is "example.com,www.example.com", but NOT " example.com" or "example.com,"
-
-    Can also be set using PAPERLESS_URL (see above).
-
-    If manually set, please remember to include "localhost". Otherwise docker
-    healthcheck will fail.
-
-    Defaults to "*", which is all hosts.
-
-PAPERLESS_CORS_ALLOWED_HOSTS=<comma-separated-list>
-    You need to add your servers to the list of allowed hosts that can do CORS
-    calls. Set this to your public domain name.
-
-    Can also be set using PAPERLESS_URL (see above).
-
-    Defaults to "http://localhost:8000".
-
-PAPERLESS_FORCE_SCRIPT_NAME=<path>
-    To host paperless under a subpath url like example.com/paperless you set
-    this value to /paperless. No trailing slash!
-
-    Defaults to none, which hosts paperless at "/".
-
-PAPERLESS_STATIC_URL=<path>
-    Override the STATIC_URL here.  Unless you're hosting Paperless off a
-    subdomain like /paperless/, you probably don't need to change this.
-    If you do change it, be sure to include the trailing slash.
-
-    Defaults to "/static/".
-
-    .. note::
-
-        When hosting paperless behind a reverse proxy like Traefik or Nginx at a subpath e.g.
-        example.com/paperlessngx you will also need to set ``PAPERLESS_FORCE_SCRIPT_NAME``
-        (see above).
-
-PAPERLESS_AUTO_LOGIN_USERNAME=<username>
-    Specify a username here so that paperless will automatically perform login
-    with the selected user.
-
-    .. danger::
-
-        Do not use this when exposing paperless on the internet. There are no
-        checks in place that would prevent you from doing this.
-
-    Defaults to none, which disables this feature.
-
-PAPERLESS_ADMIN_USER=<username>
-    If this environment variable is specified, Paperless automatically creates
-    a superuser with the provided username at start. This is useful in cases
-    where you can not run the `createsuperuser` command separately, such as Kubernetes
-    or AWS ECS.
-
-    Requires `PAPERLESS_ADMIN_PASSWORD` to be set.
-
-    .. note::
-
-        This will not change an existing [super]user's password, nor will
-        it recreate a user that already exists. You can leave this throughout
-        the lifecycle of the containers.
-
-PAPERLESS_ADMIN_MAIL=<email>
-    (Optional) Specify superuser email address. Only used when
-    `PAPERLESS_ADMIN_USER` is set.
-
-    Defaults to ``root@localhost``.
-
-PAPERLESS_ADMIN_PASSWORD=<password>
-    Only used when `PAPERLESS_ADMIN_USER` is set.
-    This will be the password of the automatically created superuser.
-
-
-PAPERLESS_COOKIE_PREFIX=<str>
-    Specify a prefix that is added to the cookies used by paperless to identify
-    the currently logged in user. This is useful for when you're running two
-    instances of paperless on the same host.
-
-    After changing this, you will have to login again.
-
-    Defaults to ``""``, which does not alter the cookie names.
-
-PAPERLESS_ENABLE_HTTP_REMOTE_USER=<bool>
-    Allows authentication via HTTP_REMOTE_USER which is used by some SSO
-    applications.
-
-    .. warning::
-
-        This will allow authentication by simply adding a ``Remote-User: <username>`` header
-        to a request. Use with care! You especially *must* ensure that any such header is not
-        passed from your proxy server to paperless.
-
-        If you're exposing paperless to the internet directly, do not use this.
-
-        Also see the warning `in the official documentation <https://docs.djangoproject.com/en/3.1/howto/auth-remote-user/#configuration>`.
-
-    Defaults to `false` which disables this feature.
-
-PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=<str>
-    If `PAPERLESS_ENABLE_HTTP_REMOTE_USER` is enabled, this property allows to
-    customize the name of the HTTP header from which the authenticated username
-    is extracted. Values are in terms of
-    [HttpRequest.META](https://docs.djangoproject.com/en/3.1/ref/request-response/#django.http.HttpRequest.META).
-    Thus, the configured value must start with `HTTP_` followed by the
-    normalized actual header name.
-
-    Defaults to `HTTP_REMOTE_USER`.
-
-PAPERLESS_LOGOUT_REDIRECT_URL=<str>
-    URL to redirect the user to after a logout. This can be used together with
-    `PAPERLESS_ENABLE_HTTP_REMOTE_USER` to redirect the user back to the SSO
-    application's logout page.
-
-    Defaults to None, which disables this feature.
-
-.. _configuration-ocr:
-
-OCR settings
-############
-
-Paperless uses `OCRmyPDF <https://ocrmypdf.readthedocs.io/en/latest/>`_ for
-performing OCR on documents and images. Paperless uses sensible defaults for
-most settings, but all of them can be configured to your needs.
-
-PAPERLESS_OCR_LANGUAGE=<lang>
-    Customize the language that paperless will attempt to use when
-    parsing documents.
-
-    It should be a 3-letter language code consistent with ISO
-    639: https://www.loc.gov/standards/iso639-2/php/code_list.php
-
-    Set this to the language most of your documents are written in.
-
-    This can be a combination of multiple languages such as ``deu+eng``,
-    in which case tesseract will use whatever language matches best.
-    Keep in mind that tesseract uses much more cpu time with multiple
-    languages enabled.
-
-    Defaults to "eng".
-
-		Note: If your language contains a '-' such as chi-sim, you must use chi_sim
-
-PAPERLESS_OCR_MODE=<mode>
-    Tell paperless when and how to perform ocr on your documents. Four modes
-    are available:
-
-    *   ``skip``: Paperless skips all pages and will perform ocr only on pages
-        where no text is present. This is the safest option.
-    *   ``skip_noarchive``: In addition to skip, paperless won't create an
-        archived version of your documents when it finds any text in them.
-        This is useful if you don't want to have two almost-identical versions
-        of your digital documents in the media folder. This is the fastest option.
-    *   ``redo``: Paperless will OCR all pages of your documents and attempt to
-        replace any existing text layers with new text. This will be useful for
-        documents from scanners that already performed OCR with insufficient
-        results. It will also perform OCR on purely digital documents.
-
-        This option may fail on some documents that have features that cannot
-        be removed, such as forms. In this case, the text from the document is
-        used instead.
-    *   ``force``: Paperless rasterizes your documents, converting any text
-        into images and puts the OCRed text on top. This works for all documents,
-        however, the resulting document may be significantly larger and text
-        won't appear as sharp when zoomed in.
-
-    The default is ``skip``, which only performs OCR when necessary and always
-    creates archived documents.
-
-    Read more about this in the `OCRmyPDF documentation <https://ocrmypdf.readthedocs.io/en/latest/advanced.html#when-ocr-is-skipped>`_.
-
-PAPERLESS_OCR_CLEAN=<mode>
-    Tells paperless to use ``unpaper`` to clean any input document before
-    sending it to tesseract. This uses more resources, but generally results
-    in better OCR results. The following modes are available:
-
-    *   ``clean``: Apply unpaper.
-    *   ``clean-final``: Apply unpaper, and use the cleaned images to build the
-        output file instead of the original images.
-    *   ``none``: Do not apply unpaper.
-
-    Defaults to ``clean``.
-
-    .. note::
-
-        ``clean-final`` is incompatible with ocr mode ``redo``. When both
-        ``clean-final`` and the ocr mode ``redo`` is configured, ``clean``
-        is used instead.
-
-PAPERLESS_OCR_DESKEW=<bool>
-    Tells paperless to correct skewing (slight rotation of input images mainly
-    due to improper scanning)
-
-    Defaults to ``true``, which enables this feature.
-
-    .. note::
-
-        Deskewing is incompatible with ocr mode ``redo``. Deskewing will get
-        disabled automatically if ``redo`` is used as the ocr mode.
-
-PAPERLESS_OCR_ROTATE_PAGES=<bool>
-    Tells paperless to correct page rotation (90°, 180° and 270° rotation).
-
-    If you notice that paperless is not rotating incorrectly rotated
-    pages (or vice versa), try adjusting the threshold up or down (see below).
-
-    Defaults to ``true``, which enables this feature.
-
-
-PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD=<num>
-    Adjust the threshold for automatic page rotation by ``PAPERLESS_OCR_ROTATE_PAGES``.
-    This is an arbitrary value reported by tesseract. "15" is a very conservative value,
-    whereas "2" is a very aggressive option and will often result in correctly rotated pages
-    being rotated as well.
-
-    Defaults to "12".
-
-PAPERLESS_OCR_OUTPUT_TYPE=<type>
-    Specify the the type of PDF documents that paperless should produce.
-
-    *   ``pdf``: Modify the PDF document as little as possible.
-    *   ``pdfa``: Convert PDF documents into PDF/A-2b documents, which is a
-        subset of the entire PDF specification and meant for storing
-        documents long term.
-    *   ``pdfa-1``, ``pdfa-2``, ``pdfa-3`` to specify the exact version of
-        PDF/A you wish to use.
-
-    If not specified, ``pdfa`` is used. Remember that paperless also keeps
-    the original input file as well as the archived version.
-
-
-PAPERLESS_OCR_PAGES=<num>
-    Tells paperless to use only the specified amount of pages for OCR. Documents
-    with less than the specified amount of pages get OCR'ed completely.
-
-    Specifying 1 here will only use the first page.
-
-    When combined with ``PAPERLESS_OCR_MODE=redo`` or ``PAPERLESS_OCR_MODE=force``,
-    paperless will not modify any text it finds on excluded pages and copy it
-    verbatim.
-
-    Defaults to 0, which disables this feature and always uses all pages.
-
-PAPERLESS_OCR_IMAGE_DPI=<num>
-    Paperless will OCR any images you put into the system and convert them
-    into PDF documents. This is useful if your scanner produces images.
-    In order to do so, paperless needs to know the DPI of the image.
-    Most images from scanners will have this information embedded and
-    paperless will detect and use that information. In case this fails, it
-    uses this value as a fallback.
-
-    Set this to the DPI your scanner produces images at.
-
-    Default is none, which will automatically calculate image DPI so that
-    the produced PDF documents are A4 sized.
-
-PAPERLESS_OCR_MAX_IMAGE_PIXELS=<num>
-    Paperless will raise a warning when OCRing images which are over this limit and
-    will not OCR images which are more than twice this limit.  Note this does not
-    prevent the document from being consumed, but could result in missing text content.
-
-    If unset, will default to the value determined by
-    `Pillow <https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.MAX_IMAGE_PIXELS>`_.
-
-    .. note::
-
-        Increasing this limit could cause Paperless to consume additional resources
-        when consuming a file.  Be sure you have sufficient system resources.
-
-    .. caution::
-
-        The limit is intended to prevent malicious files from consuming system resources
-        and causing crashes and other errors.  Only increase this value if you are certain
-        your documents are not malicious and you need the text which was not OCRed
-
-PAPERLESS_OCR_USER_ARGS=<json>
-    OCRmyPDF offers many more options. Use this parameter to specify any
-    additional arguments you wish to pass to OCRmyPDF. Since Paperless uses
-    the API of OCRmyPDF, you have to specify these in a format that can be
-    passed to the API. See `the API reference of OCRmyPDF <https://ocrmypdf.readthedocs.io/en/latest/api.html#reference>`_
-    for valid parameters. All command line options are supported, but they
-    use underscores instead of dashes.
-
-    .. caution::
-
-        Paperless has been tested to work with the OCR options provided
-        above. There are many options that are incompatible with each other,
-        so specifying invalid options may prevent paperless from consuming
-        any documents.
-
-    Specify arguments as a JSON dictionary. Keep note of lower case booleans
-    and double quoted parameter names and strings. Examples:
-
-    .. code:: json
-
-        {"deskew": true, "optimize": 3, "unpaper_args": "--pre-rotate 90"}
-
-.. _configuration-tika:
-
-Tika settings
-#############
-
-Paperless can make use of `Tika <https://tika.apache.org/>`_ and
-`Gotenberg <https://gotenberg.dev/>`_ for parsing and
-converting "Office" documents (such as ".doc", ".xlsx" and ".odt"). If you
-wish to use this, you must provide a Tika server and a Gotenberg server,
-configure their endpoints, and enable the feature.
-
-PAPERLESS_TIKA_ENABLED=<bool>
-    Enable (or disable) the Tika parser.
-
-    Defaults to false.
-
-PAPERLESS_TIKA_ENDPOINT=<url>
-    Set the endpoint URL were Paperless can reach your Tika server.
-
-    Defaults to "http://localhost:9998".
-
-PAPERLESS_TIKA_GOTENBERG_ENDPOINT=<url>
-    Set the endpoint URL were Paperless can reach your Gotenberg server.
-
-    Defaults to "http://localhost:3000".
-
-If you run paperless on docker, you can add those services to the docker-compose
-file (see the provided ``docker-compose.sqlite-tika.yml`` file for reference). The changes
-requires are as follows:
-
-.. code:: yaml
-
-    services:
-        # ...
-
-        webserver:
-            # ...
-
-            environment:
-                # ...
-
-                PAPERLESS_TIKA_ENABLED: 1
-                PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
-                PAPERLESS_TIKA_ENDPOINT: http://tika:9998
-
-        # ...
-
-        gotenberg:
-            image: gotenberg/gotenberg:7.4
-            restart: unless-stopped
-            command:
-                - "gotenberg"
-                - "--chromium-disable-routes=true"
-
-        tika:
-            image: ghcr.io/paperless-ngx/tika:latest
-            restart: unless-stopped
-
-Add the configuration variables to the environment of the webserver (alternatively
-put the configuration in the ``docker-compose.env`` file) and add the additional
-services below the webserver service. Watch out for indentation.
-
-Make sure to use the correct format `PAPERLESS_TIKA_ENABLED = 1` so python_dotenv can parse the statement correctly.
-
-Software tweaks
-###############
-
-PAPERLESS_TASK_WORKERS=<num>
-    Paperless does multiple things in the background: Maintain the search index,
-    maintain the automatic matching algorithm, check emails, consume documents,
-    etc. This variable specifies how many things it will do in parallel.
-
-    Defaults to 1
-
-
-PAPERLESS_THREADS_PER_WORKER=<num>
-    Furthermore, paperless uses multiple threads when consuming documents to
-    speed up OCR. This variable specifies how many pages paperless will process
-    in parallel on a single document.
-
-    .. caution::
-
-        Ensure that the product
-
-            PAPERLESS_TASK_WORKERS * PAPERLESS_THREADS_PER_WORKER
-
-        does not exceed your CPU core count or else paperless will be extremely slow.
-        If you want paperless to process many documents in parallel, choose a high
-        worker count. If you want paperless to process very large documents faster,
-        use a higher thread per worker count.
-
-    The default is a balance between the two, according to your CPU core count,
-    with a slight favor towards threads per worker:
-
-    +----------------+---------+---------+
-    | CPU core count | Workers | Threads |
-    +----------------+---------+---------+
-    |              1 |       1 |       1 |
-    +----------------+---------+---------+
-    |              2 |       2 |       1 |
-    +----------------+---------+---------+
-    |              4 |       2 |       2 |
-    +----------------+---------+---------+
-    |              6 |       2 |       3 |
-    +----------------+---------+---------+
-    |              8 |       2 |       4 |
-    +----------------+---------+---------+
-    |             12 |       3 |       4 |
-    +----------------+---------+---------+
-    |             16 |       4 |       4 |
-    +----------------+---------+---------+
-
-    If you only specify PAPERLESS_TASK_WORKERS, paperless will adjust
-    PAPERLESS_THREADS_PER_WORKER automatically.
-
-
-PAPERLESS_WORKER_TIMEOUT=<num>
-    Machines with few cores or weak ones might not be able to finish OCR on
-    large documents within the default 1800 seconds. So extending this timeout
-    may prove to be useful on weak hardware setups.
-
-PAPERLESS_WORKER_RETRY=<num>
-    If PAPERLESS_WORKER_TIMEOUT has been configured, the retry time for a task can
-    also be configured.  By default, this value will be set to 10s more than the
-    worker timeout.  This value should never be set less than the worker timeout.
-
-PAPERLESS_TIME_ZONE=<timezone>
-    Set the time zone here.
-    See https://docs.djangoproject.com/en/3.1/ref/settings/#std:setting-TIME_ZONE
-    for details on how to set it.
-
-    Defaults to UTC.
-
-
-.. _configuration-polling:
-
-PAPERLESS_CONSUMER_POLLING=<num>
-    If paperless won't find documents added to your consume folder, it might
-    not be able to automatically detect filesystem changes. In that case,
-    specify a polling interval in seconds here, which will then cause paperless
-    to periodically check your consumption directory for changes. This will also
-    disable listening for file system changes with ``inotify``.
-
-    Defaults to 0, which disables polling and uses filesystem notifications.
-
-PAPERLESS_CONSUMER_POLLING_RETRY_COUNT=<num>
-    If consumer polling is enabled, sets the number of times paperless will check for a
-    file to remain unmodified.
-
-    Defaults to 5.
-
-PAPERLESS_CONSUMER_POLLING_DELAY=<num>
-    If consumer polling is enabled, sets the delay in seconds between each check (above) paperless
-    will do while waiting for a file to remain unmodified.
-
-    Defaults to 5.
-
-.. _configuration-inotify:
-
-PAPERLESS_CONSUMER_INOTIFY_DELAY=<num>
-    Sets the time in seconds the consumer will wait for additional events
-    from inotify before the consumer will consider a file ready and begin consumption.
-    Certain scanners or network setups may generate multiple events for a single file,
-    leading to multiple consumers working on the same file.  Configure this to
-    prevent that.
-
-    Defaults to 0.5 seconds.
-
-PAPERLESS_CONSUMER_DELETE_DUPLICATES=<bool>
-    When the consumer detects a duplicate document, it will not touch the
-    original document. This default behavior can be changed here.
-
-    Defaults to false.
-
-
-PAPERLESS_CONSUMER_RECURSIVE=<bool>
-    Enable recursive watching of the consumption directory. Paperless will
-    then pickup files from files in subdirectories within your consumption
-    directory as well.
-
-    Defaults to false.
-
-
-PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS=<bool>
-    Set the names of subdirectories as tags for consumed files.
-    E.g. <CONSUMPTION_DIR>/foo/bar/file.pdf will add the tags "foo" and "bar" to
-    the consumed file. Paperless will create any tags that don't exist yet.
-
-    This is useful for sorting documents with certain tags such as ``car`` or
-    ``todo`` prior to consumption. These folders won't be deleted.
-
-    PAPERLESS_CONSUMER_RECURSIVE must be enabled for this to work.
-
-    Defaults to false.
-
-PAPERLESS_CONSUMER_ENABLE_BARCODES=<bool>
-    Enables the scanning and page separation based on detected barcodes.
-    This allows for scanning and adding multiple documents per uploaded
-    file, which are separated by one or multiple barcode pages.
-
-    For ease of use, it is suggested to use a standardized separation page,
-    e.g. `here <https://www.alliancegroup.co.uk/patch-codes.htm>`_.
-
-    If no barcodes are detected in the uploaded file, no page separation
-    will happen.
-
-    The original document will be removed and the separated pages will be
-    saved as pdf.
-
-    Defaults to false.
-
-PAPERLESS_CONSUMER_BARCODE_TIFF_SUPPORT=<bool>
-    Whether TIFF image files should be scanned for barcodes.
-    This will automatically convert any TIFF image(s) to pdfs for later
-    processing.
-    This only has an effect, if PAPERLESS_CONSUMER_ENABLE_BARCODES has been
-    enabled.
-
-    Defaults to false.
-
-PAPERLESS_CONSUMER_BARCODE_STRING=PATCHT
-  Defines the string to be detected as a separator barcode.
-  If paperless is used with the PATCH-T separator pages, users
-  shouldn't change this.
-
-  Defaults to "PATCHT"
-
-PAPERLESS_CONVERT_MEMORY_LIMIT=<num>
-    On smaller systems, or even in the case of Very Large Documents, the consumer
-    may explode, complaining about how it's "unable to extend pixel cache".  In
-    such cases, try setting this to a reasonably low value, like 32.  The
-    default is to use whatever is necessary to do everything without writing to
-    disk, and units are in megabytes.
-
-    For more information on how to use this value, you should search
-    the web for "MAGICK_MEMORY_LIMIT".
-
-    Defaults to 0, which disables the limit.
-
-PAPERLESS_CONVERT_TMPDIR=<path>
-    Similar to the memory limit, if you've got a small system and your OS mounts
-    /tmp as tmpfs, you should set this to a path that's on a physical disk, like
-    /home/your_user/tmp or something.  ImageMagick will use this as scratch space
-    when crunching through very large documents.
-
-    For more information on how to use this value, you should search
-    the web for "MAGICK_TMPDIR".
-
-    Default is none, which disables the temporary directory.
-
-PAPERLESS_POST_CONSUME_SCRIPT=<filename>
-    After a document is consumed, Paperless can trigger an arbitrary script if
-    you like.  This script will be passed a number of arguments for you to work
-    with. For more information, take a look at :ref:`advanced-post_consume_script`.
-
-    The default is blank, which means nothing will be executed.
-
-PAPERLESS_FILENAME_DATE_ORDER=<format>
-    Paperless will check the document text for document date information.
-    Use this setting to enable checking the document filename for date
-    information. The date order can be set to any option as specified in
-    https://dateparser.readthedocs.io/en/latest/settings.html#date-order.
-    The filename will be checked first, and if nothing is found, the document
-    text will be checked as normal.
-
-    A date in a filename must have some separators (`.`, `-`, `/`, etc)
-    for it to be parsed.
-
-    Defaults to none, which disables this feature.
-
-PAPERLESS_NUMBER_OF_SUGGESTED_DATES=<num>
-    Paperless searches an entire document for dates. The first date found will
-    be used as the initial value for the created date. When this variable is
-    greater than 0 (or left to it's default value), paperless will also suggest
-    other dates found in the document, up to a maximum of this setting. Note that
-    duplicates will be removed, which can result in fewer dates displayed in the
-    frontend than this setting value.
-
-    The task to find all dates can be time-consuming and increases with a higher
-    (maximum) number of suggested dates and slower hardware.
-
-    Defaults to 3. Set to 0 to disable this feature.
-
-PAPERLESS_THUMBNAIL_FONT_NAME=<filename>
-    Paperless creates thumbnails for plain text files by rendering the content
-    of the file on an image and uses a predefined font for that. This
-    font can be changed here.
-
-    Note that this won't have any effect on already generated thumbnails.
-
-    Defaults to ``/usr/share/fonts/liberation/LiberationSerif-Regular.ttf``.
-
-PAPERLESS_IGNORE_DATES=<string>
-    Paperless parses a documents creation date from filename and file content.
-    You may specify a comma separated list of dates that should be ignored during
-    this process. This is useful for special dates (like date of birth) that appear
-    in documents regularly but are very unlikely to be the documents creation date.
-
-    The date is parsed using the order specified in PAPERLESS_DATE_ORDER
-
-    Defaults to an empty string to not ignore any dates.
-
-PAPERLESS_DATE_ORDER=<format>
-    Paperless will try to determine the document creation date from its contents.
-    Specify the date format Paperless should expect to see within your documents.
-
-    This option defaults to DMY which translates to day first, month second, and year
-    last order. Characters D, M, or Y can be shuffled to meet the required order.
-
-PAPERLESS_CONSUMER_IGNORE_PATTERNS=<json>
-    By default, paperless ignores certain files and folders in the consumption
-    directory, such as system files created by the Mac OS.
-
-    This can be adjusted by configuring a custom json array with patterns to exclude.
-
-    Defaults to ``[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini"]``.
-
-Binaries
-########
-
-There are a few external software packages that Paperless expects to find on
-your system when it starts up.  Unless you've done something creative with
-their installation, you probably won't need to edit any of these.  However,
-if you've installed these programs somewhere where simply typing the name of
-the program doesn't automatically execute it (ie. the program isn't in your
-$PATH), then you'll need to specify the literal path for that program.
-
-PAPERLESS_CONVERT_BINARY=<path>
-    Defaults to "convert".
-
-PAPERLESS_GS_BINARY=<path>
-    Defaults to "gs".
-
-
-.. _configuration-docker:
-
-Docker-specific options
-#######################
-
-These options don't have any effect in ``paperless.conf``. These options adjust
-the behavior of the docker container. Configure these in `docker-compose.env`.
-
-PAPERLESS_WEBSERVER_WORKERS=<num>
-    The number of worker processes the webserver should spawn. More worker processes
-    usually result in the front end to load data much quicker. However, each worker process
-    also loads the entire application into memory separately, so increasing this value
-    will increase RAM usage.
-
-    Defaults to 1.
-
-PAPERLESS_BIND_ADDR=<ip address>
-    The IP address the webserver will listen on inside the container. There are
-    special setups where you may need to configure this value to restrict the
-    Ip address or interface the webserver listens on.
-
-    Defaults to [::], meaning all interfaces, including IPv6.
-
-PAPERLESS_PORT=<port>
-    The port number the webserver will listen on inside the container. There are
-    special setups where you may need this to avoid collisions with other
-    services (like using podman with multiple containers in one pod).
-
-    Don't change this when using Docker. To change the port the webserver is
-    reachable outside of the container, instead refer to the "ports" key in
-    ``docker-compose.yml``.
-
-    Defaults to 8000.
-
-USERMAP_UID=<uid>
-    The ID of the paperless user in the container. Set this to your actual user ID on the
-    host system, which you can get by executing
-
-    .. code:: shell-session
-
-        $ id -u
-
-    Paperless will change ownership on its folders to this user, so you need to get this right
-    in order to be able to write to the consumption directory.
-
-    Defaults to 1000.
-
-USERMAP_GID=<gid>
-    The ID of the paperless Group in the container. Set this to your actual group ID on the
-    host system, which you can get by executing
-
-    .. code:: shell-session
-
-        $ id -g
-
-    Paperless will change ownership on its folders to this group, so you need to get this right
-    in order to be able to write to the consumption directory.
-
-    Defaults to 1000.
-
-PAPERLESS_OCR_LANGUAGES=<list>
-    Additional OCR languages to install. By default, paperless comes with
-    English, German, Italian, Spanish and French. If your language is not in this list, install
-    additional languages with this configuration option:
-
-    .. code:: bash
-
-        PAPERLESS_OCR_LANGUAGES=tur ces
-
-    To actually use these languages, also set the default OCR language of paperless:
-
-    .. code:: bash
-
-        PAPERLESS_OCR_LANGUAGE=tur
-
-    Defaults to none, which does not install any additional languages.
-
-
-.. _configuration-update-checking:
-
-Update Checking
-###############
-
-PAPERLESS_ENABLE_UPDATE_CHECK=<bool>
-    Enable (or disable) the automatic check for available updates. This feature is disabled
-    by default but if it is not explicitly set Paperless-ngx will show a message about this.
-
-    If enabled, the feature works by pinging the the Github API for the latest release e.g.
-    https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest
-    to determine whether a new version is available.
-
-    Actual updating of the app must still be performed manually.
-
-    Note that for users of thirdy-party containers e.g. linuxserver.io this notification
-    may be 'ahead' of a new release from the third-party maintainers.
-
-    In either case, no tracking data is collected by the app in any way.
-
-    Defaults to none, which disables the feature.
+    You will be redirected shortly...

docs/extending.rst

@@ -1,431 +1,12 @@
 .. _extending:
 
+*************************
 Paperless-ngx Development
-#########################
+*************************
 
-This section describes the steps you need to take to start development on paperless-ngx.
 
-Check out the source from github. The repository is organized in the following way:
+.. cssclass:: redirect-notice
 
-*   ``main`` always represents the latest release and will only see changes
-    when a new release is made.
-*   ``dev`` contains the code that will be in the next release.
-*   ``feature-X`` contain bigger changes that will be in some release, but not
-    necessarily the next one.
+    The Paperless-ngx documentation has permanently moved.
 
-When making functional changes to paperless, *always* make your changes on the ``dev`` branch.
-
-Apart from that, the folder structure is as follows:
-
-*   ``docs/`` - Documentation.
-*   ``src-ui/`` - Code of the front end.
-*   ``src/`` - Code of the back end.
-*   ``scripts/`` - Various scripts that help with different parts of development.
-*   ``docker/`` - Files required to build the docker image.
-
-Contributing to Paperless
-=========================
-
-Maybe you've been using Paperless for a while and want to add a feature or two,
-or maybe you've come across a bug that you have some ideas how to solve.  The
-beauty of open source software is that you can see what's wrong and help to get
-it fixed for everyone!
-
-Before contributing please review our `code of conduct`_ and other important
-information in the `contributing guidelines`_.
-
-.. _code-formatting-with-pre-commit-hooks:
-
-Code formatting with pre-commit Hooks
-=====================================
-
-To ensure a consistent style and formatting across the project source, the project
-utilizes a Git `pre-commit` hook to perform some formatting and linting before a
-commit is allowed. That way, everyone uses the same style and some common issues
-can be caught early on. See below for installation instructions.
-
-Once installed, hooks will run when you commit. If the formatting isn't quite right
-or a linter catches something, the commit will be rejected. You'll need to look at the
-output and fix the issue. Some hooks, such as the Python formatting tool `black`,
-will format failing files, so all you need to do is `git add` those files again and
-retry your commit.
-
-Initial setup and first start
-=============================
-
-After you forked and cloned the code from github you need to perform a first-time setup.
-To do the setup you need to perform the steps from the following chapters in a certain order:
-
-1.  Install prerequisites + pipenv as mentioned in :ref:`Bare metal route <setup-bare_metal>`
-2.  Copy ``paperless.conf.example`` to ``paperless.conf`` and enable debug mode.
-3.  Install the Angular CLI interface:
-
-    .. code:: shell-session
-
-        $ npm install -g @angular/cli
-
-4.  Install pre-commit
-
-    .. code:: shell-session
-
-        pre-commit install
-
-5.  Create ``consume`` and ``media`` folders in the cloned root folder.
-
-    .. code:: shell-session
-
-        mkdir -p consume media
-
-6.  You can now either ...
-
-    *  install redis or
-    *  use the included scripts/start-services.sh to use docker to fire up a redis instance (and some other services such as tika, gotenberg and a database server) or
-    *  spin up a bare redis container
-
-        .. code:: shell-session
-
-            docker run -d -p 6379:6379 --restart unless-stopped redis:latest
-
-7.  Install the python dependencies by performing in the src/ directory.
-
-    .. code:: shell-session
-
-        pipenv install --dev
-
-  * Make sure you're using python 3.9.x or lower. Otherwise you might get issues with building dependencies. You can use `pyenv <https://github.com/pyenv/pyenv>`_ to install a specific python version.
-
-8.  Generate the static UI so you can perform a login to get session that is required for frontend development (this needs to be done one time only). From src-ui directory:
-
-    .. code:: shell-session
-
-        npm install .
-        ./node_modules/.bin/ng build --configuration production
-
-9.  Apply migrations and create a superuser for your dev instance:
-
-    .. code:: shell-session
-
-        python3 manage.py migrate
-        python3 manage.py createsuperuser
-
-10.  Now spin up the dev backend. Depending on which part of paperless you're developing for, you need to have some or all of them running.
-
-    .. code:: shell-session
-
-        python3 manage.py runserver & python3 manage.py document_consumer & python3 manage.py qcluster
-
-11. Login with the superuser credentials provided in step 8 at ``http://localhost:8000`` to create a session that enables you to use the backend.
-
-Backend development environment is now ready, to start Frontend development go to ``/src-ui`` and run ``ng serve``. From there you can use ``http://localhost:4200`` for a preview.
-
-Back end development
-====================
-
-The backend is a django application. PyCharm works well for development, but you can use whatever
-you want.
-
-Configure the IDE to use the src/ folder as the base source folder. Configure the following
-launch configurations in your IDE:
-
-*   python3 manage.py runserver
-*   python3 manage.py qcluster
-*   python3 manage.py document_consumer
-
-To start them all:
-
-.. code:: shell-session
-
-    python3 manage.py runserver & python3 manage.py document_consumer & python3 manage.py qcluster
-
-Testing and code style:
-
-*   Run ``pytest`` in the src/ directory to execute all tests. This also generates a HTML coverage
-    report. When runnings test, paperless.conf is loaded as well. However: the tests rely on the default
-    configuration. This is not ideal. But for now, make sure no settings except for DEBUG are overridden when testing.
-*   Coding style is enforced by the Git pre-commit hooks.  These will ensure your code is formatted and do some
-    linting when you do a `git commit`.
-*   You can also run ``black`` manually to format your code
-
-    .. note::
-
-        The line length rule E501 is generally useful for getting multiple source files
-        next to each other on the screen. However, in some cases, its just not possible
-        to make some lines fit, especially complicated IF cases. Append ``# NOQA: E501``
-        to disable this check for certain lines.
-
-Front end development
-=====================
-
-The front end is built using Angular. In order to get started, you need ``npm``.
-Install the Angular CLI interface with
-
-.. code:: shell-session
-
-    $ npm install -g @angular/cli
-
-and make sure that it's on your path. Next, in the src-ui/ directory, install the
-required dependencies of the project.
-
-.. code:: shell-session
-
-    $ npm install
-
-You can launch a development server by running
-
-.. code:: shell-session
-
-    $ ng serve
-
-This will automatically update whenever you save. However, in-place compilation might fail
-on syntax errors, in which case you need to restart it.
-
-By default, the development server is available on ``http://localhost:4200/`` and is configured
-to access the API at ``http://localhost:8000/api/``, which is the default of the backend.
-If you enabled DEBUG on the back end, several security overrides for allowed hosts, CORS and
-X-Frame-Options are in place so that the front end behaves exactly as in production. This also
-relies on you being logged into the back end. Without a valid session, The front end will simply
-not work.
-
-Testing and code style:
-
-*   The frontend code (.ts, .html, .scss) use ``prettier`` for code formatting via the Git
-    ``pre-commit`` hooks which run automatically on commit. See
-    :ref:`above <code-formatting-with-pre-commit-hooks>` for installation. You can also run this
-    via cli with a command such as
-
-    .. code:: shell-session
-
-        $ git ls-files -- '*.ts' | xargs pre-commit run prettier --files
-
-*   Frontend testing uses jest and cypress. There is currently a need for significantly more
-    frontend tests. Unit tests and e2e tests, respectively, can be run non-interactively with:
-
-    .. code:: shell-session
-
-        $ ng test
-        $ npm run e2e:ci
-
-    Cypress also includes a UI which can be run from within the ``src-ui`` directory with
-
-    .. code:: shell-session
-
-        $ ./node_modules/.bin/cypress open
-
-In order to build the front end and serve it as part of django, execute
-
-.. code:: shell-session
-
-    $ ng build --prod
-
-This will build the front end and put it in a location from which the Django server will serve
-it as static content. This way, you can verify that authentication is working.
-
-
-Localization
-============
-
-Paperless is available in many different languages. Since paperless consists both of a django
-application and an Angular front end, both these parts have to be translated separately.
-
-Front end localization
-----------------------
-
-*   The Angular front end does localization according to the `Angular documentation <https://angular.io/guide/i18n>`_.
-*   The source language of the project is "en_US".
-*   The source strings end up in the file "src-ui/messages.xlf".
-*   The translated strings need to be placed in the "src-ui/src/locale/" folder.
-*   In order to extract added or changed strings from the source files, call ``ng xi18n --ivy``.
-
-Adding new languages requires adding the translated files in the "src-ui/src/locale/" folder and adjusting a couple files.
-
-1.  Adjust "src-ui/angular.json":
-
-    .. code:: json
-
-        "i18n": {
-            "sourceLocale": "en-US",
-            "locales": {
-                "de": "src/locale/messages.de.xlf",
-                "nl-NL": "src/locale/messages.nl_NL.xlf",
-                "fr": "src/locale/messages.fr.xlf",
-                "en-GB": "src/locale/messages.en_GB.xlf",
-                "pt-BR": "src/locale/messages.pt_BR.xlf",
-                "language-code": "language-file"
-            }
-        }
-
-2.  Add the language to the available options in "src-ui/src/app/services/settings.service.ts":
-
-    .. code:: typescript
-
-        getLanguageOptions(): LanguageOption[] {
-            return [
-                {code: "en-us", name: $localize`English (US)`, englishName: "English (US)", dateInputFormat: "mm/dd/yyyy"},
-                {code: "en-gb", name: $localize`English (GB)`, englishName: "English (GB)", dateInputFormat: "dd/mm/yyyy"},
-                {code: "de", name: $localize`German`, englishName: "German", dateInputFormat: "dd.mm.yyyy"},
-                {code: "nl", name: $localize`Dutch`, englishName: "Dutch", dateInputFormat: "dd-mm-yyyy"},
-                {code: "fr", name: $localize`French`, englishName: "French", dateInputFormat: "dd/mm/yyyy"},
-                {code: "pt-br", name: $localize`Portuguese (Brazil)`, englishName: "Portuguese (Brazil)", dateInputFormat: "dd/mm/yyyy"}
-                // Add your new language here
-            ]
-        }
-
-    ``dateInputFormat`` is a special string that defines the behavior of the date input fields and absolutely needs to contain "dd", "mm" and "yyyy".
-
-3.  Import and register the Angular data for this locale in "src-ui/src/app/app.module.ts":
-
-    .. code:: typescript
-
-        import localeDe from '@angular/common/locales/de';
-        registerLocaleData(localeDe)
-
-Back end localization
----------------------
-
-A majority of the strings that appear in the back end appear only when the admin is used. However,
-some of these are still shown on the front end (such as error messages).
-
-*   The django application does localization according to the `django documentation <https://docs.djangoproject.com/en/3.1/topics/i18n/translation/>`_.
-*   The source language of the project is "en_US".
-*   Localization files end up in the folder "src/locale/".
-*   In order to extract strings from the application, call ``python3 manage.py makemessages -l en_US``. This is important after making changes to translatable strings.
-*   The message files need to be compiled for them to show up in the application. Call ``python3 manage.py compilemessages`` to do this. The generated files don't get
-    committed into git, since these are derived artifacts. The build pipeline takes care of executing this command.
-
-Adding new languages requires adding the translated files in the "src/locale/" folder and adjusting the file "src/paperless/settings.py" to include the new language:
-
-.. code:: python
-
-    LANGUAGES = [
-        ("en-us", _("English (US)")),
-        ("en-gb", _("English (GB)")),
-        ("de", _("German")),
-        ("nl-nl", _("Dutch")),
-        ("fr", _("French")),
-        ("pt-br", _("Portuguese (Brazil)")),
-        # Add language here.
-    ]
-
-
-Building the documentation
-==========================
-
-The documentation is built using sphinx. I've configured ReadTheDocs to automatically build
-the documentation when changes are pushed. If you want to build the documentation locally,
-this is how you do it:
-
-1.  Install python dependencies.
-
-    .. code:: shell-session
-
-        $ cd /path/to/paperless
-        $ pipenv install --dev
-
-2.  Build the documentation
-
-    .. code:: shell-session
-
-        $ cd /path/to/paperless/docs
-        $ pipenv run make clean html
-
-This will build the HTML documentation, and put the resulting files in the ``_build/html``
-directory.
-
-Building the Docker image
-=========================
-
-The docker image is primarily built by the GitHub actions workflow, but it can be
-faster when developing to build and tag an image locally.
-
-To provide the build arguments automatically, build the image using the helper
-script ``build-docker-image.sh``.
-
-Building the docker image from source:
-
-    .. code:: shell-session
-
-        ./build-docker-image.sh Dockerfile -t <your-tag>
-
-Extending Paperless
-===================
-
-Paperless does not have any fancy plugin systems and will probably never have. However,
-some parts of the application have been designed to allow easy integration of additional
-features without any modification to the base code.
-
-Making custom parsers
----------------------
-
-Paperless uses parsers to add documents to paperless. A parser is responsible for:
-
-*   Retrieve the content from the original
-*   Create a thumbnail
-*   Optional: Retrieve a created date from the original
-*   Optional: Create an archived document from the original
-
-Custom parsers can be added to paperless to support more file types. In order to do that,
-you need to write the parser itself and announce its existence to paperless.
-
-The parser itself must extend ``documents.parsers.DocumentParser`` and must implement the
-methods ``parse`` and ``get_thumbnail``. You can provide your own implementation to
-``get_date`` if you don't want to rely on paperless' default date guessing mechanisms.
-
-.. code:: python
-
-    class MyCustomParser(DocumentParser):
-
-        def parse(self, document_path, mime_type):
-            # This method does not return anything. Rather, you should assign
-            # whatever you got from the document to the following fields:
-
-            # The content of the document.
-            self.text = "content"
-
-            # Optional: path to a PDF document that you created from the original.
-            self.archive_path = os.path.join(self.tempdir, "archived.pdf")
-
-            # Optional: "created" date of the document.
-            self.date = get_created_from_metadata(document_path)
-
-        def get_thumbnail(self, document_path, mime_type):
-            # This should return the path to a thumbnail you created for this
-            # document.
-            return os.path.join(self.tempdir, "thumb.png")
-
-If you encounter any issues during parsing, raise a ``documents.parsers.ParseError``.
-
-The ``self.tempdir`` directory is a temporary directory that is guaranteed to be empty
-and removed after consumption finished. You can use that directory to store any
-intermediate files and also use it to store the thumbnail / archived document.
-
-After that, you need to announce your parser to paperless. You need to connect a
-handler to the ``document_consumer_declaration`` signal. Have a look in the file
-``src/paperless_tesseract/apps.py`` on how that's done. The handler is a method
-that returns information about your parser:
-
-.. code:: python
-
-    def myparser_consumer_declaration(sender, **kwargs):
-        return {
-            "parser": MyCustomParser,
-            "weight": 0,
-            "mime_types": {
-                "application/pdf": ".pdf",
-                "image/jpeg": ".jpg",
-            }
-        }
-
-*   ``parser`` is a reference to a class that extends ``DocumentParser``.
-
-*   ``weight`` is used whenever two or more parsers are able to parse a file: The parser with
-    the higher weight wins. This can be used to override the parsers provided by
-    paperless.
-
-*   ``mime_types`` is a dictionary. The keys are the mime types your parser supports and the value
-    is the default file extension that paperless should use when storing files and serving them for
-    download. We could guess that from the file extensions, but some mime types have many extensions
-    associated with them and the python methods responsible for guessing the extension do not always
-    return the same value.
-
-.. _code of conduct: https://github.com/paperless-ngx/paperless-ngx/blob/main/CODE_OF_CONDUCT.md
-.. _contributing guidelines: https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md
+    You will be redirected shortly...

docs/faq.rst

@@ -1,117 +1,12 @@
+.. _faq:
 
 **************************
 Frequently asked questions
 **************************
 
-**Q:** *What's the general plan for Paperless-ngx?*
 
-**A:** While Paperless-ngx is already considered largely "feature-complete" it is a community-driven
-project and development will be guided in this way. New features can be submitted via
-GitHub discussions and "up-voted" by the community but this is not a guarantee the feature
-will be implemented. This project will always be open to collaboration in the form of PRs,
-ideas etc.
+.. cssclass:: redirect-notice
 
-**Q:** *I'm using docker. Where are my documents?*
+    The Paperless-ngx documentation has permanently moved.
 
-**A:** Your documents are stored inside the docker volume ``paperless_media``.
-Docker manages this volume automatically for you. It is a persistent storage
-and will persist as long as you don't explicitly delete it. The actual location
-depends on your host operating system. On Linux, chances are high that this location
-is
-
-.. code::
-
-    /var/lib/docker/volumes/paperless_media/_data
-
-.. caution::
-
-    Do not mess with this folder. Don't change permissions and don't move
-    files around manually. This folder is meant to be entirely managed by docker
-    and paperless.
-
-**Q:** *Let's say I want to switch tools in a year. Can I easily move to other systems?*
-
-**A:** Your documents are stored as plain files inside the media folder. You can always drag those files
-out of that folder to use them elsewhere. Here are a couple notes about that.
-
-*   Paperless-ngx never modifies your original documents. It keeps checksums of all documents and uses a
-    scheduled sanity checker to check that they remain the same.
-*   By default, paperless uses the internal ID of each document as its filename. This might not be very
-    convenient for export. However, you can adjust the way files are stored in paperless by
-    :ref:`configuring the filename format <advanced-file_name_handling>`.
-*   :ref:`The exporter <utilities-exporter>` is another easy way to get your files out of paperless with reasonable file names.
-
-**Q:** *What file types does paperless-ngx support?*
-
-**A:** Currently, the following files are supported:
-
-*   PDF documents, PNG images, JPEG images, TIFF images and GIF images are processed with OCR and converted into PDF documents.
-*   Plain text documents are supported as well and are added verbatim
-    to paperless.
-*   With the optional Tika integration enabled (see :ref:`Configuration <configuration-tika>`), Paperless also supports various
-    Office documents (.docx, .doc, odt, .ppt, .pptx, .odp, .xls, .xlsx, .ods).
-
-Paperless-ngx determines the type of a file by inspecting its content. The
-file extensions do not matter.
-
-**Q:** *Will paperless-ngx run on Raspberry Pi?*
-
-**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 OCR. On Raspberry Pi,
-try to OCR documents before feeding them into paperless so that paperless can
-reuse the text. The web interface is a lot snappier, since it runs
-in your browser and paperless has to do much less work to serve the data.
-
-.. note::
-
-    You can adjust some of the settings so that paperless uses less processing
-    power. See :ref:`setup-less_powerful_devices` for details.
-
-
-**Q:** *How do I install paperless-ngx on Raspberry Pi?*
-
-**A:** Docker images are available for arm and arm64 hardware, so just follow
-the docker-compose instructions. Apart from more required disk space compared to
-a bare metal installation, docker comes with close to zero overhead, even on
-Raspberry Pi.
-
-If you decide to got with the bare metal route, be aware that some of the
-python requirements do not have precompiled packages for ARM / ARM64. Installation
-of these will require additional development libraries and compilation will take
-a long time.
-
-**Q:** *How do I run this on Unraid?*
-
-**A:** Paperless-ngx is available as `community app <https://unraid.net/community/apps?q=paperless-ngx>`_
-in Unraid. `Uli Fahrer <https://github.com/Tooa>`_ created a container template for that.
-
-**Q:** *How do I run this on my toaster?*
-
-**A:** I honestly don't know! As for all other devices that might be able
-to run paperless, you're a bit on your own. If you can't run the docker image,
-the documentation has instructions for bare metal installs. I'm running
-paperless on an i3 processor from 2015 or so. This is also what I use to test
-new releases with. Apart from that, I also have a Raspberry Pi, which I
-occasionally build the image on and see if it works.
-
-**Q:** *How do I proxy this with NGINX?*
-
-**A:** See :ref:`here <setup-nginx>`.
-
-.. _faq-mod_wsgi:
-
-**Q:** *How do I get WebSocket support with Apache mod_wsgi*?
-
-**A:** ``mod_wsgi`` by itself does not support ASGI. Paperless will continue
-to work with WSGI, but certain features such as status notifications about
-document consumption won't be available.
-
-If you want to continue using ``mod_wsgi``, you will have to run an ASGI-enabled
-web server as well that processes WebSocket connections, and configure Apache to
-redirect WebSocket connections to this server. Multiple options for ASGI servers
-exist:
-
-* ``gunicorn`` with ``uvicorn`` as the worker implementation (the default of paperless)
-* ``daphne`` as a standalone server, which is the reference implementation for ASGI.
-* ``uvicorn`` as a standalone server
+    You will be redirected shortly...

docs/index.rst

@@ -2,74 +2,24 @@
 Paperless
 *********
 
-Paperless is a simple Django application running in two parts:
-a *Consumer* (the thing that does the indexing) and
-the *Web server* (the part that lets you search &
-download already-indexed documents). If you want to learn more about its
-functions keep on reading after the installation section.
 
+.. cssclass:: redirect-notice
 
-Why This Exists
-===============
+    The Paperless-ngx documentation has permanently moved.
 
-Paper is a nightmare.  Environmental issues aside, there's no excuse for it in
-the 21st century.  It takes up space, collects dust, doesn't support any form
-of a search feature, indexing is tedious, it's heavy and prone to damage &
-loss.
-
-I wrote this to make "going paperless" easier.  I do not have to worry about
-finding stuff again. I feed documents right from the post box into the scanner
-and then shred them.  Perhaps you might find it useful too.
-
-
-Paperless-ngx
-=============
-
-Paperless-ngx is a document management system that transforms your physical
-documents into a searchable online archive so you can keep, well, *less paper*.
-
-Paperless-ngx forked from paperless-ng to continue the great work and
-distribute responsibility of supporting and advancing the project among a team
-of people.
-
-NG stands for both Angular (the framework used for the
-Frontend) and next-gen. Publishing this project under a different name also
-avoids confusion between paperless and paperless-ngx.
-
-If you want to learn about what's different in paperless-ngx from Paperless, check out these
-resources in the documentation:
-
-*   :ref:`Some screenshots <screenshots>` of the new UI are available.
-*   Read :ref:`this section <advanced-automatic_matching>` if you want to
-    learn about how paperless automates all tagging using machine learning.
-*   Paperless now comes with a :ref:`proper email consumer <usage-email>`
-    that's fully tested and production ready.
-*   Paperless creates searchable PDF/A documents from whatever you put into
-    the consumption directory. This means that you can select text in
-    image-only documents coming from your scanner.
-*   See :ref:`this note <utilities-encyption>` about GnuPG encryption in
-    paperless-ngx.
-*   Paperless is now integrated with a
-    :ref:`task processing queue <setup-task_processor>` that tells you
-    at a glance when and why something is not working.
-*   The :doc:`changelog </changelog>` contains a detailed list of all changes
-    in paperless-ngx.
-
-Contents
-========
+    You will be redirected shortly...
 
 .. toctree::
-   :maxdepth: 1
 
-   setup
-   usage_overview
-   advanced_usage
-   administration
-   configuration
-   api
-   faq
-   troubleshooting
-   extending
-   scanners
-   screenshots
-   changelog
+    screenshots
+    scanners
+    administration
+    advanced_usage
+    usage_overview
+    setup
+    troubleshooting
+    changelog
+    configuration
+    extending
+    api
+    faq

docs/requirements.txt

@@ -1 +1 @@
-myst-parser==0.17.2
+myst-parser==0.18.1

docs/scanners.rst

@@ -1,8 +1,12 @@
-
 .. _scanners:
 
 *******************
 Scanners & Software
 *******************
 
-Paperless-ngx is compatible with many different scanners and scanning tools. A user-maintained list of scanners and other software is available on `the wiki <https://github.com/paperless-ngx/paperless-ngx/wiki/Scanner-&-Software-Recommendations>`_.
+
+.. cssclass:: redirect-notice
+
+    The Paperless-ngx documentation has permanently moved.
+
+    You will be redirected shortly...

docs/screenshots.rst

@@ -4,60 +4,9 @@
 Screenshots
 ***********
 
-This is what Paperless-ngx looks like.
 
-The dashboard shows customizable views on your document and allows document uploads:
+.. cssclass:: redirect-notice
 
-.. image:: _static/screenshots/dashboard.png
-    :target: _static/screenshots/dashboard.png
+    The Paperless-ngx documentation has permanently moved.
 
-The document list provides three different styles to scroll through your documents:
-
-.. image:: _static/screenshots/documents-table.png
-    :target: _static/screenshots/documents-table.png
-.. image:: _static/screenshots/documents-smallcards.png
-    :target: _static/screenshots/documents-smallcards.png
-.. image:: _static/screenshots/documents-largecards.png
-    :target: _static/screenshots/documents-largecards.png
-
-Paperless-ngx also supports "dark mode":
-
-.. image:: _static/screenshots/documents-smallcards-dark.png
-    :target: _static/screenshots/documents-smallcards-dark.png
-
-Extensive filtering mechanisms:
-
-.. image:: _static/screenshots/documents-filter.png
-    :target: _static/screenshots/documents-filter.png
-
-Bulk editing of document tags, correspondents, etc.:
-
-.. image:: _static/screenshots/bulk-edit.png
-    :target: _static/screenshots/bulk-edit.png
-
-Side-by-side editing of documents:
-
-.. image:: _static/screenshots/editing.png
-    :target: _static/screenshots/editing.png
-
-Tag editing. This looks about the same for correspondents and document types.
-
-.. image:: _static/screenshots/new-tag.png
-    :target: _static/screenshots/new-tag.png
-
-Searching provides auto complete and highlights the results.
-
-.. image:: _static/screenshots/search-preview.png
-    :target: _static/screenshots/search-preview.png
-.. image:: _static/screenshots/search-results.png
-    :target: _static/screenshots/search-results.png
-
-Fancy mail filters!
-
-.. image:: _static/screenshots/mail-rules-edited.png
-    :target: _static/screenshots/mail-rules-edited.png
-
-Mobile devices are supported.
-
-.. image:: _static/screenshots/mobile.png
-    :target: _static/screenshots/mobile.png
+    You will be redirected shortly...

docs/setup.rst

@@ -1,830 +1,12 @@
+.. _setup:
 
 *****
 Setup
 *****
 
-Overview of Paperless-ngx
-#########################
 
-Compared to paperless, paperless-ngx works a little different under the hood and has
-more moving parts that work together. While this increases the complexity of
-the system, it also brings many benefits.
+.. cssclass:: redirect-notice
 
-Paperless consists of the following components:
+    The Paperless-ngx documentation has permanently moved.
 
-*   **The webserver:** This is pretty much the same as in paperless. It serves
-    the administration pages, the API, and the new frontend. This is the main
-    tool you'll be using to interact with paperless. You may start the webserver
-    with
-
-    .. code:: shell-session
-
-        $ cd /path/to/paperless/src/
-        $ gunicorn -c ../gunicorn.conf.py paperless.wsgi
-
-    or by any other means such as Apache ``mod_wsgi``.
-
-*   **The consumer:** This is what watches your consumption folder for documents.
-    However, the consumer itself does not really consume your documents.
-    Now it notifies a task processor that a new file is ready for consumption.
-    I suppose it should be named differently.
-    This was also used to check your emails, but that's now done elsewhere as well.
-
-    Start the consumer with the management command ``document_consumer``:
-
-    .. code:: shell-session
-
-        $ cd /path/to/paperless/src/
-        $ python3 manage.py document_consumer
-
-    .. _setup-task_processor:
-
-*   **The task processor:** Paperless relies on `Django Q <https://django-q.readthedocs.io/en/latest/>`_
-    for doing most of the heavy lifting. This is a task queue that accepts tasks from
-    multiple sources and processes these in parallel. It also comes with a scheduler that executes
-    certain commands periodically.
-
-    This task processor is responsible for:
-
-    *   Consuming documents. When the consumer finds new documents, it notifies the task processor to
-        start a consumption task.
-    *   The task processor also performs the consumption of any documents you upload through
-        the web interface.
-    *   Consuming emails. It periodically checks your configured accounts for new emails and
-        notifies the task processor to consume the attachment of an email.
-    *   Maintaining the search index and the automatic matching algorithm. These are things that paperless
-        needs to do from time to time in order to operate properly.
-
-    This allows paperless to process multiple documents from your consumption folder in parallel! On
-    a modern multi core system, this makes the consumption process with full OCR blazingly fast.
-
-    The task processor comes with a built-in admin interface that you can use to check whenever any of the
-    tasks fail and inspect the errors (i.e., wrong email credentials, errors during consuming a specific
-    file, etc).
-
-    You may start the task processor by executing:
-
-    .. code:: shell-session
-
-        $ cd /path/to/paperless/src/
-        $ python3 manage.py qcluster
-
-*   A `redis <https://redis.io/>`_ message broker: This is a really lightweight service that is responsible
-    for getting the tasks from the webserver and the consumer to the task scheduler. These run in a different
-    process (maybe even on different machines!), and therefore, this is necessary.
-
-*   Optional: A database server. Paperless supports PostgreSQL, MariaDB and SQLite for storing its data.
-
-
-Installation
-############
-
-You can go multiple routes to setup and run Paperless:
-
-* :ref:`Use the easy install docker script <setup-docker_script>`
-* :ref:`Pull the image from Docker Hub <setup-docker_hub>`
-* :ref:`Build the Docker image yourself <setup-docker_build>`
-* :ref:`Install Paperless directly on your system manually (bare metal) <setup-bare_metal>`
-
-The Docker routes are quick & easy. These are the recommended routes. This configures all the stuff
-from the above automatically so that it just works and uses sensible defaults for all configuration options.
-Here you find a cheat-sheet for docker beginners: `CLI Basics <https://www.sehn.tech/refs/devops-with-docker/>`_
-
-The bare metal route is complicated to setup but makes it easier
-should you want to contribute some code back. You need to configure and
-run the above mentioned components yourself.
-
-.. _CLI Basics: https://www.sehn.tech/refs/devops-with-docker/
-
-.. _setup-docker_script:
-
-Install Paperless from Docker Hub using the installation script
-===============================================================
-
-Paperless provides an interactive installation script. This script will ask you
-for a couple configuration options, download and create the necessary configuration files, pull the docker image, start paperless and create your user account. This script essentially
-performs all the steps described in :ref:`setup-docker_hub` automatically.
-
-1.  Make sure that docker and docker-compose are installed.
-2.  Download and run the installation script:
-
-    .. code:: shell-session
-
-        $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
-
-.. _setup-docker_hub:
-
-Install Paperless from Docker Hub
-=================================
-
-1.  Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ngx` to have a place for your configuration files and consumption directory.
-
-2.  Go to the `/docker/compose directory on the project page <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_
-    and download one of the `docker-compose.*.yml` files, depending on which database backend you
-    want to use. Rename this file to `docker-compose.yml`.
-    If you want to enable optional support for Office documents, download a file with `-tika` in the file name.
-    Download the ``docker-compose.env`` file and the ``.env`` file as well and store them
-    in the same directory.
-
-    .. hint::
-
-        For new installations, it is recommended to use PostgreSQL as the database
-        backend.
-
-3.  Install `Docker`_ and `docker-compose`_.
-
-    .. caution::
-
-        If you want to use the included ``docker-compose.*.yml`` file, you
-        need to have at least Docker version **17.09.0** and docker-compose
-        version **1.17.0**.
-        To check do: `docker-compose -v` or `docker -v`
-
-        See the `Docker installation guide`_ on how to install the current
-        version of Docker for your operating system or Linux distribution of
-        choice. To get the latest version of docker-compose, follow the
-        `docker-compose installation guide`_ if your package repository doesn't
-        include it.
-
-        .. _Docker installation guide: https://docs.docker.com/engine/installation/
-        .. _docker-compose installation guide: https://docs.docker.com/compose/install/
-
-4.  Modify ``docker-compose.yml`` to your preferences. You may want to change the path
-    to the consumption directory. Find the line that specifies where
-    to mount the consumption directory:
-
-    .. code::
-
-        - ./consume:/usr/src/paperless/consume
-
-    Replace the part BEFORE the colon with a local directory of your choice:
-
-    .. code::
-
-        - /home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume
-
-    Don't change the part after the colon or paperless wont find your documents.
-
-    You may also need to change the default port that the webserver will use
-    from the default (8000):
-
-     .. code::
-
-        ports:
-          - 8000:8000
-
-    Replace the part BEFORE the colon with a port of your choice:
-
-     .. code::
-
-        ports:
-          - 8010:8000
-
-    Don't change the part after the colon or edit other lines that refer to
-    port 8000. Modifying the part before the colon will map requests on another
-    port to the webserver running on the default port.
-
-    **Rootless**
-
-    If you want to run Paperless as a rootless container, you will need to do the
-    following in your ``docker-compose.yml``:
-
-    - set the ``user`` running the container to map to the ``paperless`` user in the
-      container.
-      This value (``user_id`` below), should be the same id that ``USERMAP_UID`` and
-      ``USERMAP_GID`` are set to in the next step.
-      See ``USERMAP_UID`` and ``USERMAP_GID`` :ref:`here <configuration-docker>`.
-
-    Your entry for Paperless should contain something like:
-
-     .. code::
-
-        webserver:
-          image: ghcr.io/paperless-ngx/paperless-ngx:latest
-          user: <user_id>
-
-5.  Modify ``docker-compose.env``, following the comments in the file. The
-    most important change is to set ``USERMAP_UID`` and ``USERMAP_GID``
-    to the uid and gid of your user on the host system. Use ``id -u`` and
-    ``id -g`` to get these.
-
-    This ensures that
-    both the docker container and you on the host machine have write access
-    to the consumption directory. If your UID and GID on the host system is
-    1000 (the default for the first normal user on most systems), it will
-    work out of the box without any modifications. `id "username"` to check.
-
-    .. note::
-
-        You can copy any setting from the file ``paperless.conf.example`` and paste it here.
-        Have a look at :ref:`configuration` to see what's available.
-
-    .. note::
-
-        You can utilize Docker secrets for some configuration settings by
-        appending `_FILE` to some configuration values.  This is supported currently
-        only by:
-
-          * PAPERLESS_DBUSER
-          * PAPERLESS_DBPASS
-          * PAPERLESS_SECRET_KEY
-          * PAPERLESS_AUTO_LOGIN_USERNAME
-          * PAPERLESS_ADMIN_USER
-          * PAPERLESS_ADMIN_MAIL
-          * PAPERLESS_ADMIN_PASSWORD
-
-    .. caution::
-
-        Some file systems such as NFS network shares don't support file system
-        notifications with ``inotify``. When storing the consumption directory
-        on such a file system, paperless will not pick up new files
-        with the default configuration. You will need to use ``PAPERLESS_CONSUMER_POLLING``,
-        which will disable inotify. See :ref:`here <configuration-polling>`.
-
-6.  Run ``docker-compose pull``, followed by ``docker-compose up -d``.
-    This will pull the image, create and start the necessary containers.
-
-7.  To be able to login, you will need a super user. To create it, execute the
-    following command:
-
-    .. code-block:: shell-session
-
-        $ docker-compose run --rm webserver createsuperuser
-
-    This will prompt you to set a username, an optional e-mail address and
-    finally a password (at least 8 characters).
-
-8.  The default ``docker-compose.yml`` exports the webserver on your local port
-    8000. If you did not change this, you should now be able to visit your
-    Paperless instance at ``http://127.0.0.1:8000`` or your servers IP-Address:8000.
-    Use the login credentials you have created with the previous step.
-
-.. _Docker: https://www.docker.com/
-.. _docker-compose: https://docs.docker.com/compose/install/
-
-.. _setup-docker_build:
-
-Build the Docker image yourself
-===============================
-
-1.  Clone the entire repository of paperless:
-
-    .. code:: shell-session
-
-        git clone https://github.com/paperless-ngx/paperless-ngx
-
-    The master branch always reflects the latest stable version.
-
-2.  Copy one of the ``docker/compose/docker-compose.*.yml`` to ``docker-compose.yml`` in the root folder,
-    depending on which database backend you want to use. Copy
-    ``docker-compose.env`` into the project root as well.
-
-3.  In the ``docker-compose.yml`` file, find the line that instructs docker-compose to pull the paperless image from Docker Hub:
-
-    .. code:: yaml
-
-        webserver:
-            image: ghcr.io/paperless-ngx/paperless-ngx:latest
-
-    and replace it with a line that instructs docker-compose to build the image from the current working directory instead:
-
-    .. code:: yaml
-
-        webserver:
-            build: .
-
-4.  Follow steps 3 to 8 of :ref:`setup-docker_hub`. When asked to run
-    ``docker-compose pull`` to pull the image, do
-
-    .. code:: shell-session
-
-        $ docker-compose build
-
-    instead to build the image.
-
-.. _setup-bare_metal:
-
-Bare Metal Route
-================
-
-Paperless runs on linux only. The following procedure has been tested on a minimal
-installation of Debian/Buster, which is the current stable release at the time of
-writing. Windows is not and will never be supported.
-
-1.  Install dependencies. Paperless requires the following packages.
-
-    *   ``python3`` 3.8, 3.9
-    *   ``python3-pip``
-    *   ``python3-dev``
-
-    *   ``default-libmysqlclient-dev`` for MariaDB
-    *   ``fonts-liberation`` for generating thumbnails for plain text files
-    *   ``imagemagick`` >= 6 for PDF conversion
-    *   ``gnupg`` for handling encrypted documents
-    *   ``libpq-dev`` for PostgreSQL
-    *   ``libmagic-dev`` for mime type detection
-    *   ``mariadb-client`` for MariaDB compile time
-    *   ``mime-support`` for mime type detection
-    *   ``libzbar0`` for barcode detection
-    *   ``poppler-utils`` for barcode detection
-
-    Use this list for your preferred package management:
-
-    .. code::
-
-        python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev libmagic-dev mime-support libzbar0 poppler-utils
-
-    These dependencies are required for OCRmyPDF, which is used for text recognition.
-
-    *   ``unpaper``
-    *   ``ghostscript``
-    *   ``icc-profiles-free``
-    *   ``qpdf``
-    *   ``liblept5``
-    *   ``libxml2``
-    *   ``pngquant`` (suggested for certain PDF image optimizations)
-    *   ``zlib1g``
-    *   ``tesseract-ocr`` >= 4.0.0 for OCR
-    *   ``tesseract-ocr`` language packs (``tesseract-ocr-eng``, ``tesseract-ocr-deu``, etc)
-
-    Use this list for your preferred package management:
-
-    .. code::
-
-        unpaper ghostscript icc-profiles-free qpdf liblept5 libxml2 pngquant zlib1g tesseract-ocr
-
-    On Raspberry Pi, these libraries are required as well:
-
-    *   ``libatlas-base-dev``
-    *   ``libxslt1-dev``
-
-    You will also need ``build-essential``, ``python3-setuptools`` and ``python3-wheel``
-    for installing some of the python dependencies.
-
-2.  Install ``redis`` >= 5.0 and configure it to start automatically.
-
-3.  Optional. Install ``postgresql`` and configure a database, user and password for paperless. If you do not wish
-    to use PostgreSQL, MariaDB and SQLite are available as well.
-
-    .. note::
-
-        On bare-metal installations using SQLite, ensure the
-        `JSON1 extension <https://code.djangoproject.com/wiki/JSON1Extension>`_ is enabled. This is
-        usually the case, but not always.
-
-4.  Get the release archive from `<https://github.com/paperless-ngx/paperless-ngx/releases>`_.
-    If you clone the git repo as it is, you also have to compile the front end by yourself.
-    Extract the archive to a place from where you wish to execute it, such as ``/opt/paperless``.
-
-5.  Configure paperless. See :ref:`configuration` for details. Edit the included ``paperless.conf`` and adjust the
-    settings to your needs. Required settings for getting paperless running are:
-
-    *   ``PAPERLESS_REDIS`` should point to your redis server, such as redis://localhost:6379.
-    *   ``PAPERLESS_DBENGINE`` optional, and should be one of `postgres, mariadb, or sqlite`
-    *   ``PAPERLESS_DBHOST`` should be the hostname on which your PostgreSQL server is running. Do not configure this
-        to use SQLite instead. Also configure port, database name, user and password as necessary.
-    *   ``PAPERLESS_CONSUMPTION_DIR`` should point to a folder which paperless should watch for documents. You might
-        want to have this somewhere else. Likewise, ``PAPERLESS_DATA_DIR`` and ``PAPERLESS_MEDIA_ROOT`` define where
-        paperless stores its data. If you like, you can point both to the same directory.
-    *   ``PAPERLESS_SECRET_KEY`` should be a random sequence of characters. It's used for authentication. Failure
-        to do so allows third parties to forge authentication credentials.
-    *   ``PAPERLESS_URL`` if you are behind a reverse proxy. This should point to your domain. Please see
-        :ref:`configuration` for more information.
-
-    Many more adjustments can be made to paperless, especially the OCR part. The following options are recommended
-    for everyone:
-
-    *   Set ``PAPERLESS_OCR_LANGUAGE`` to the language most of your documents are written in.
-    *   Set ``PAPERLESS_TIME_ZONE`` to your local time zone.
-
-6.  Create a system user under which you wish to run paperless.
-
-    .. code:: shell-session
-
-        adduser paperless --system --home /opt/paperless --group
-
-7.  Ensure that these directories exist
-    and that the paperless user has write permissions to the following directories:
-
-    *   ``/opt/paperless/media``
-    *   ``/opt/paperless/data``
-    *   ``/opt/paperless/consume``
-
-    Adjust as necessary if you configured different folders.
-
-8.  Install python requirements from the ``requirements.txt`` file.
-    It is up to you if you wish to use a virtual environment or not. First you should update your pip, so it gets the actual packages.
-
-    .. code:: shell-session
-
-        sudo -Hu paperless pip3 install --upgrade pip
-
-    .. code:: shell-session
-
-        sudo -Hu paperless pip3 install -r requirements.txt
-
-    This will install all python dependencies in the home directory of
-    the new paperless user.
-
-9.  Go to ``/opt/paperless/src``, and execute the following commands:
-
-    .. code:: bash
-
-        # This creates the database schema.
-        sudo -Hu paperless python3 manage.py migrate
-
-        # This creates your first paperless user
-        sudo -Hu paperless python3 manage.py createsuperuser
-
-10. Optional: Test that paperless is working by executing
-
-      .. code:: bash
-
-        # This collects static files from paperless and django.
-        sudo -Hu paperless python3 manage.py runserver
-
-    and pointing your browser to http://localhost:8000/.
-
-    .. warning::
-
-        This is a development server which should not be used in
-        production. It is not audited for security and performance
-        is inferior to production ready web servers.
-
-    .. hint::
-
-        This will not start the consumer. Paperless does this in a
-        separate process.
-
-11. Setup systemd services to run paperless automatically. You may
-    use the service definition files included in the ``scripts`` folder
-    as a starting point.
-
-    Paperless needs the ``webserver`` script to run the webserver, the
-    ``consumer`` script to watch the input folder, and the ``scheduler``
-    script to run tasks such as email checking and document consumption.
-
-		The ``socket`` script enables ``gunicorn`` to run on port 80 without
-		root privileges. For this you need to uncomment the ``Require=paperless-webserver.socket``
-		in the ``webserver`` script and configure ``gunicorn`` to listen on port 80 (see ``paperless/gunicorn.conf.py``).
-
-    You may need to adjust the path to the ``gunicorn`` executable. This
-    will be installed as part of the python dependencies, and is either located
-    in the ``bin`` folder of your virtual environment, or in ``~/.local/bin/`` if
-    no virtual environment is used.
-
-    These services rely on redis and optionally the database server, but
-    don't need to be started in any particular order. The example files
-    depend on redis being started. If you use a database server, you should
-    add additional dependencies.
-
-    .. caution::
-
-        The included scripts run a ``gunicorn`` standalone server,
-        which is fine for running paperless. It does support SSL,
-        however, the documentation of GUnicorn states that you should
-        use a proxy server in front of gunicorn instead.
-
-        For instructions on how to use nginx for that,
-        :ref:`see the instructions below <setup-nginx>`.
-
-12. Optional: Install a samba server and make the consumption folder
-    available as a network share.
-
-13. Configure ImageMagick to allow processing of PDF documents. Most distributions have
-    this disabled by default, since PDF documents can contain malware. If
-    you don't do this, paperless will fall back to ghostscript for certain steps
-    such as thumbnail generation.
-
-    Edit ``/etc/ImageMagick-6/policy.xml`` and adjust
-
-    .. code::
-
-        <policy domain="coder" rights="none" pattern="PDF" />
-
-    to
-
-    .. code::
-
-        <policy domain="coder" rights="read|write" pattern="PDF" />
-
-14. Optional: Install the `jbig2enc <https://ocrmypdf.readthedocs.io/en/latest/jbig2.html>`_
-    encoder. This will reduce the size of generated PDF documents. You'll most likely need
-    to compile this by yourself, because this software has been patented until around 2017 and
-    binary packages are not available for most distributions.
-
-Migrating to Paperless-ngx
-##########################
-
-Migration is possible both from Paperless-ng or directly from the 'original' Paperless.
-
-Migrating from Paperless-ng
-===========================
-
-Paperless-ngx is meant to be a drop-in replacement for Paperless-ng and thus upgrading should be
-trivial for most users, especially when using docker. However, as with any major change, it is
-recommended to take a full backup first. Once you are ready, simply change the docker image to
-point to the new source. E.g. if using Docker Compose, edit ``docker-compose.yml`` and change:
-
-.. code::
-
-  image: jonaswinkler/paperless-ng:latest
-
-to
-
-.. code::
-
-  image: ghcr.io/paperless-ngx/paperless-ngx:latest
-
-and then run ``docker-compose up -d`` which will pull the new image recreate the container.
-That's it!
-
-Users who installed with the bare-metal route should also update their Git clone to point to
-``https://github.com/paperless-ngx/paperless-ngx``, e.g. using the command
-``git remote set-url origin https://github.com/paperless-ngx/paperless-ngx`` and then pull the
-lastest version.
-
-Migrating from Paperless
-========================
-
-At its core, paperless-ngx is still paperless and fully compatible. However, some
-things have changed under the hood, so you need to adapt your setup depending on
-how you installed paperless.
-
-This setup describes how to update an existing paperless Docker installation.
-The important things to keep in mind are as follows:
-
-* Read the :doc:`changelog </changelog>` and take note of breaking changes.
-* You should decide if you want to stick with SQLite or want to migrate your database
-  to PostgreSQL. See :ref:`setup-sqlite_to_psql` for details on how to move your data from
-  SQLite to PostgreSQL. Both work fine with paperless. However, if you already have a
-  database server running for other services, you might as well use it for paperless as well.
-* The task scheduler of paperless, which is used to execute periodic tasks
-  such as email checking and maintenance, requires a `redis`_ message broker
-  instance. The docker-compose route takes care of that.
-* The layout of the folder structure for your documents and data remains the
-  same, so you can just plug your old docker volumes into paperless-ngx and
-  expect it to find everything where it should be.
-
-Migration to paperless-ngx is then performed in a few simple steps:
-
-1.  Stop paperless.
-
-    .. code:: bash
-
-        $ cd /path/to/current/paperless
-        $ docker-compose down
-
-2.  Do a backup for two purposes: If something goes wrong, you still have your
-    data. Second, if you don't like paperless-ngx, you can switch back to
-    paperless.
-
-3.  Download the latest release of paperless-ngx. You can either go with the
-    docker-compose files from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`__
-    or clone the repository to build the image yourself (see :ref:`above <setup-docker_build>`).
-    You can either replace your current paperless folder or put paperless-ngx
-    in a different location.
-
-    .. caution::
-
-        Paperless-ngx includes a ``.env`` file. This will set the
-        project name for docker compose to ``paperless``, which will also define the name
-        of the volumes by paperless-ngx. However, if you experience that paperless-ngx
-        is not using your old paperless volumes, verify the names of your volumes with
-
-        .. code:: shell-session
-
-            $ docker volume ls | grep _data
-
-        and adjust the project name in the ``.env`` file so that it matches the name
-        of the volumes before the ``_data`` part.
-
-
-4.  Download the ``docker-compose.sqlite.yml`` file to ``docker-compose.yml``.
-    If you want to switch to PostgreSQL, do that after you migrated your existing
-    SQLite database.
-
-5.  Adjust ``docker-compose.yml`` and ``docker-compose.env`` to your needs.
-    See :ref:`setup-docker_hub` for details on which edits are advised.
-
-6.  :ref:`Update paperless. <administration-updating>`
-
-7.  In order to find your existing documents with the new search feature, you need
-    to invoke a one-time operation that will create the search index:
-
-    .. code:: shell-session
-
-        $ docker-compose run --rm webserver document_index reindex
-
-    This will migrate your database and create the search index. After that,
-    paperless will take care of maintaining the index by itself.
-
-8.  Start paperless-ngx.
-
-    .. code:: bash
-
-        $ docker-compose up -d
-
-    This will run paperless in the background and automatically start it on system boot.
-
-9.  Paperless installed a permanent redirect to ``admin/`` in your browser. This
-    redirect is still in place and prevents access to the new UI. Clear your
-    browsing cache in order to fix this.
-
-10.  Optionally, follow the instructions below to migrate your existing data to PostgreSQL.
-
-
-.. _setup-sqlite_to_psql:
-
-Moving data from SQLite to PostgreSQL
-=====================================
-
-Moving your data from SQLite to PostgreSQL is done via executing a series of django
-management commands as below.
-
-.. caution::
-
-    Make sure that your SQLite database is migrated to the latest version.
-    Starting paperless will make sure that this is the case. If your try to
-    load data from an old database schema in SQLite into a newer database
-    schema in PostgreSQL, you will run into trouble.
-
-.. warning::
-
-    On some database fields, PostgreSQL enforces predefined limits on maximum
-    length, whereas SQLite does not. The fields in question are the title of documents
-    (128 characters), names of document types, tags and correspondents (128 characters),
-    and filenames (1024 characters). If you have data in these fields that surpasses these
-    limits, migration to PostgreSQL is not possible and will fail with an error.
-
-
-1.  Stop paperless, if it is running.
-2.  Tell paperless to use PostgreSQL:
-
-    a)  With docker, copy the provided ``docker-compose.postgres.yml`` file to
-        ``docker-compose.yml``. Remember to adjust the consumption directory,
-        if necessary.
-    b)  Without docker, configure the database in your ``paperless.conf`` file.
-        See :ref:`configuration` for details.
-
-3.  Open a shell and initialize the database:
-
-    a)  With docker, run the following command to open a shell within the paperless
-        container:
-
-        .. code:: shell-session
-
-            $ cd /path/to/paperless
-            $ docker-compose run --rm webserver /bin/bash
-
-        This will launch the container and initialize the PostgreSQL database.
-
-    b)  Without docker, remember to activate any virtual environment, switch to
-        the ``src`` directory and create the database schema:
-
-        .. code:: shell-session
-
-            $ cd /path/to/paperless/src
-            $ python3 manage.py migrate
-
-        This will not copy any data yet.
-
-4.  Dump your data from SQLite:
-
-    .. code:: shell-session
-
-        $ python3 manage.py dumpdata --database=sqlite --exclude=contenttypes --exclude=auth.Permission > data.json
-
-5.  Load your data into PostgreSQL:
-
-    .. code:: shell-session
-
-        $ python3 manage.py loaddata data.json
-
-6.  If operating inside Docker, you may exit the shell now.
-
-    .. code:: shell-session
-
-        $ exit
-
-7.  Start paperless.
-
-
-Moving back to Paperless
-========================
-
-Lets say you migrated to Paperless-ngx and used it for a while, but decided that
-you don't like it and want to move back (If you do, send me a mail about what
-part you didn't like!), you can totally do that with a few simple steps.
-
-Paperless-ngx modified the database schema slightly, however, these changes can
-be reverted while keeping your current data, so that your current data will
-be compatible with original Paperless.
-
-Execute this:
-
-.. code:: shell-session
-
-    $ cd /path/to/paperless
-    $ docker-compose run --rm webserver migrate documents 0023
-
-Or without docker:
-
-.. code:: shell-session
-
-    $ cd /path/to/paperless/src
-    $ python3 manage.py migrate documents 0023
-
-After that, you need to clear your cookies (Paperless-ngx comes with updated
-dependencies that do cookie-processing differently) and probably your cache
-as well.
-
-.. _setup-less_powerful_devices:
-
-
-Considerations for less powerful devices
-########################################
-
-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.
-*   Consider setting ``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.
-*   ``PAPERLESS_TASK_WORKERS`` and ``PAPERLESS_THREADS_PER_WORKER`` are configured
-    to use all cores. The Raspberry Pi models 3 and up have 4 cores, meaning that
-    paperless will use 2 workers and 2 threads per worker. This may result in
-    sluggish response times during consumption, so you might want to lower these
-    settings (example: 2 workers and 1 thread to always have some computing power
-    left for other tasks).
-*   Keep ``PAPERLESS_OCR_MODE`` at its default value ``skip`` and consider OCR'ing
-    your documents before feeding them into paperless. Some scanners are able to
-    do this! You might want to even specify ``skip_noarchive`` to skip archive
-    file generation for already ocr'ed documents entirely.
-*   If you want to perform OCR on the device, consider using ``PAPERLESS_OCR_CLEAN=none``.
-    This will speed up OCR times and use less memory at the expense of slightly worse
-    OCR results.
-*   If using docker, consider setting ``PAPERLESS_WEBSERVER_WORKERS`` to
-    1. This will save some memory.
-
-For details, refer to :ref:`configuration`.
-
-.. note::
-
-    Updating the :ref:`automatic matching algorithm <advanced-automatic_matching>`
-    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. 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.
-
-.. _redis: https://redis.io/
-
-
-.. _setup-nginx:
-
-Using nginx as a reverse proxy
-##############################
-
-If you want to expose paperless to the internet, you should hide it behind a
-reverse proxy with SSL enabled.
-
-In addition to the usual configuration for SSL,
-the following configuration is required for paperless to operate:
-
-.. code:: nginx
-
-    http {
-
-        # Adjust as required. This is the maximum size for file uploads.
-        # The default value 1M might be a little too small.
-        client_max_body_size 10M;
-
-        server {
-
-            location / {
-
-                # Adjust host and port as required.
-                proxy_pass http://localhost:8000/;
-
-                # These configuration options are required for WebSockets to work.
-                proxy_http_version 1.1;
-                proxy_set_header Upgrade $http_upgrade;
-                proxy_set_header Connection "upgrade";
-
-                proxy_redirect off;
-                proxy_set_header Host $host;
-                proxy_set_header X-Real-IP $remote_addr;
-                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-                proxy_set_header X-Forwarded-Host $server_name;
-            }
-        }
-    }
-
-The ``PAPERLESS_URL`` configuration variable is also required when using a reverse proxy. Please refer to the :ref:`hosting-and-security` docs.
-
-Also read `this <https://channels.readthedocs.io/en/stable/deploying.html#nginx-supervisor-ubuntu>`__, towards the end of the section.
+    You will be redirected shortly...

docs/troubleshooting.rst

@@ -1,319 +1,12 @@
+.. _troubleshooting:
+
 ***************
 Troubleshooting
 ***************
 
-No files are added by the consumer
-##################################
 
-Check for the following issues:
+.. cssclass:: redirect-notice
 
-*   Ensure that the directory you're putting your documents in is the folder
-    paperless is watching. With docker, this setting is performed in the
-    ``docker-compose.yml`` file. Without docker, look at the ``CONSUMPTION_DIR``
-    setting. Don't adjust this setting if you're using docker.
-*   Ensure that redis is up and running. Paperless does its task processing
-    asynchronously, and for documents to arrive at the task processor, it needs
-    redis to run.
-*   Ensure that the task processor is running. Docker does this automatically.
-    Manually invoke the task processor by executing
+    The Paperless-ngx documentation has permanently moved.
 
-    .. code:: shell-session
-
-        $ python3 manage.py qcluster
-
-*   Look at the output of paperless and inspect it for any errors.
-*   Go to the admin interface, and check if there are failed tasks. If so, the
-    tasks will contain an error message.
-
-Consumer warns ``OCR for XX failed``
-####################################
-
-If you find the OCR accuracy to be too low, and/or the document consumer warns
-that ``OCR for XX failed, but we're going to stick with what we've got since
-FORGIVING_OCR is enabled``, then you might need to install the
-`Tesseract language files <http://packages.ubuntu.com/search?keywords=tesseract-ocr>`_
-marching your document's languages.
-
-As an example, if you are running Paperless-ngx from any Ubuntu or Debian
-box, and your documents are written in Spanish you may need to run::
-
-    apt-get install -y tesseract-ocr-spa
-
-Consumer fails to pickup any new files
-######################################
-
-If you notice that the consumer will only pickup files in the consumption
-directory at startup, but won't find any other files added later, you will need to
-enable filesystem polling with the configuration option
-``PAPERLESS_CONSUMER_POLLING``, see :ref:`here <configuration-polling>`.
-
-This will disable listening to filesystem changes with inotify and paperless will
-manually check the consumption directory for changes instead.
-
-
-Paperless always redirects to /admin
-####################################
-
-You probably had the old paperless installed at some point. Paperless installed
-a permanent redirect to /admin in your browser, and you need to clear your
-browsing data / cache to fix that.
-
-
-Operation not permitted
-#######################
-
-You might see errors such as:
-
-.. code:: shell-session
-
-    chown: changing ownership of '../export': Operation not permitted
-
-The container tries to set file ownership on the listed directories. This is
-required so that the user running paperless inside docker has write permissions
-to these folders. This happens when pointing these directories to NFS shares,
-for example.
-
-Ensure that ``chown`` is possible on these directories.
-
-
-Classifier error: No training data available
-############################################
-
-This indicates that the Auto matching algorithm found no documents to learn from.
-This may have two reasons:
-
-*   You don't use the Auto matching algorithm: The error can be safely ignored in this case.
-*   You are using the Auto matching algorithm: The classifier explicitly excludes documents
-    with Inbox tags. Verify that there are documents in your archive without inbox tags.
-    The algorithm will only learn from documents not in your inbox.
-
-
-UserWarning in sklearn on every single document
-###############################################
-
-You may encounter warnings like this:
-
-.. code::
-
-    /usr/local/lib/python3.7/site-packages/sklearn/base.py:315:
-    UserWarning: Trying to unpickle estimator CountVectorizer from version 0.23.2 when using version 0.24.0.
-    This might lead to breaking code or invalid results. Use at your own risk.
-
-This happens when certain dependencies of paperless that are responsible for the auto matching algorithm are
-updated. After updating these, your current training data *might* not be compatible anymore. This can be ignored
-in most cases. This warning will disappear automatically when paperless updates the training data.
-
-If you want to get rid of the warning or actually experience issues with automatic matching, delete
-the file ``classification_model.pickle`` in the data directory and let paperless recreate it.
-
-
-504 Server Error: Gateway Timeout when adding Office documents
-##############################################################
-
-You may experience these errors when using the optional TIKA integration:
-
-.. code::
-
-    requests.exceptions.HTTPError: 504 Server Error: Gateway Timeout for url: http://gotenberg:3000/forms/libreoffice/convert
-
-Gotenberg is a server that converts Office documents into PDF documents and has a default timeout of 30 seconds.
-When conversion takes longer, Gotenberg raises this error.
-
-You can increase the timeout by configuring a command flag for Gotenberg (see also `here <https://gotenberg.dev/docs/modules/api#properties>`__).
-If using docker-compose, this is achieved by the following configuration change in the ``docker-compose.yml`` file:
-
-.. code:: yaml
-
-    gotenberg:
-        image: gotenberg/gotenberg:7.4
-        restart: unless-stopped
-        command:
-            - "gotenberg"
-            - "--chromium-disable-routes=true"
-            - "--api-timeout=60"
-
-Permission denied errors in the consumption directory
-#####################################################
-
-You might encounter errors such as:
-
-.. code:: shell-session
-
-    The following error occured while consuming document.pdf: [Errno 13] Permission denied: '/usr/src/paperless/src/../consume/document.pdf'
-
-This happens when paperless does not have permission to delete files inside the consumption directory.
-Ensure that ``USERMAP_UID`` and ``USERMAP_GID`` are set to the user id and group id you use on the host operating system, if these are
-different from ``1000``. See :ref:`setup-docker_hub`.
-
-Also ensure that you are able to read and write to the consumption directory on the host.
-
-
-OSError: [Errno 19] No such device when consuming files
-#######################################################
-
-If you experience errors such as:
-
-.. code:: shell-session
-
-    File "/usr/local/lib/python3.7/site-packages/whoosh/codec/base.py", line 570, in open_compound_file
-    return CompoundStorage(dbfile, use_mmap=storage.supports_mmap)
-    File "/usr/local/lib/python3.7/site-packages/whoosh/filedb/compound.py", line 75, in __init__
-    self._source = mmap.mmap(fileno, 0, access=mmap.ACCESS_READ)
-    OSError: [Errno 19] No such device
-
-    During handling of the above exception, another exception occurred:
-
-    Traceback (most recent call last):
-    File "/usr/local/lib/python3.7/site-packages/django_q/cluster.py", line 436, in worker
-    res = f(*task["args"], **task["kwargs"])
-    File "/usr/src/paperless/src/documents/tasks.py", line 73, in consume_file
-    override_tag_ids=override_tag_ids)
-    File "/usr/src/paperless/src/documents/consumer.py", line 271, in try_consume_file
-    raise ConsumerError(e)
-
-Paperless uses a search index to provide better and faster full text searching. This search index is stored inside
-the ``data`` folder. The search index uses memory-mapped files (mmap). The above error indicates that paperless
-was unable to create and open these files.
-
-This happens when you're trying to store the data directory on certain file systems (mostly network shares)
-that don't support memory-mapped files.
-
-
-Web-UI stuck at "Loading..."
-############################
-
-This might have multiple reasons.
-
-
-1.  If you built the docker image yourself or deployed using the bare metal route,
-    make sure that there are files in ``<paperless-root>/static/frontend/<lang-code>/``.
-    If there are no files, make sure that you executed ``collectstatic`` successfully, either
-    manually or as part of the docker image build.
-
-    If the front end is still missing, make sure that the front end is compiled (files present in
-    ``src/documents/static/frontend``). If it is not, you need to compile the front end yourself
-    or download the release archive instead of cloning the repository.
-
-2.  Check the output of the web server. You might see errors like this:
-
-
-    .. code::
-
-        [2021-01-25 10:08:04 +0000] [40] [ERROR] Socket error processing request.
-        Traceback (most recent call last):
-        File "/usr/local/lib/python3.7/site-packages/gunicorn/workers/sync.py", line 134, in handle
-            self.handle_request(listener, req, client, addr)
-        File "/usr/local/lib/python3.7/site-packages/gunicorn/workers/sync.py", line 190, in handle_request
-            util.reraise(*sys.exc_info())
-        File "/usr/local/lib/python3.7/site-packages/gunicorn/util.py", line 625, in reraise
-            raise value
-        File "/usr/local/lib/python3.7/site-packages/gunicorn/workers/sync.py", line 178, in handle_request
-            resp.write_file(respiter)
-        File "/usr/local/lib/python3.7/site-packages/gunicorn/http/wsgi.py", line 396, in write_file
-            if not self.sendfile(respiter):
-        File "/usr/local/lib/python3.7/site-packages/gunicorn/http/wsgi.py", line 386, in sendfile
-            sent += os.sendfile(sockno, fileno, offset + sent, count)
-        OSError: [Errno 22] Invalid argument
-
-    To fix this issue, add
-
-    .. code::
-
-        SENDFILE=0
-
-    to your `docker-compose.env` file.
-
-Error while reading metadata
-############################
-
-You might find messages like these in your log files:
-
-.. code::
-
-    [WARNING] [paperless.parsing.tesseract] Error while reading metadata
-
-This indicates that paperless failed to read PDF metadata from one of your documents. This happens when you
-open the affected documents in paperless for editing. Paperless will continue to work, and will simply not
-show the invalid metadata.
-
-Consumer fails with a FileNotFoundError
-#######################################
-
-You might find messages like these in your log files:
-
-.. code::
-
-    [ERROR] [paperless.consumer] Error while consuming document SCN_0001.pdf: FileNotFoundError: [Errno 2] No such file or directory: '/tmp/ocrmypdf.io.yhk3zbv0/origin.pdf'
-    Traceback (most recent call last):
-      File "/app/paperless/src/paperless_tesseract/parsers.py", line 261, in parse
-        ocrmypdf.ocr(**args)
-      File "/usr/local/lib/python3.8/dist-packages/ocrmypdf/api.py", line 337, in ocr
-        return run_pipeline(options=options, plugin_manager=plugin_manager, api=True)
-      File "/usr/local/lib/python3.8/dist-packages/ocrmypdf/_sync.py", line 385, in run_pipeline
-        exec_concurrent(context, executor)
-      File "/usr/local/lib/python3.8/dist-packages/ocrmypdf/_sync.py", line 302, in exec_concurrent
-        pdf = post_process(pdf, context, executor)
-      File "/usr/local/lib/python3.8/dist-packages/ocrmypdf/_sync.py", line 235, in post_process
-        pdf_out = metadata_fixup(pdf_out, context)
-      File "/usr/local/lib/python3.8/dist-packages/ocrmypdf/_pipeline.py", line 798, in metadata_fixup
-        with pikepdf.open(context.origin) as original, pikepdf.open(working_file) as pdf:
-      File "/usr/local/lib/python3.8/dist-packages/pikepdf/_methods.py", line 923, in open
-        pdf = Pdf._open(
-    FileNotFoundError: [Errno 2] No such file or directory: '/tmp/ocrmypdf.io.yhk3zbv0/origin.pdf'
-
-This probably indicates paperless tried to consume the same file twice.  This can happen for a number of reasons,
-depending on how documents are placed into the consume folder.  If paperless is using inotify (the default) to
-check for documents, try adjusting the :ref:`inotify configuration <configuration-inotify>`.  If polling is enabled,
-try adjusting the :ref:`polling configuration <configuration-polling>`.
-
-Consumer fails waiting for file to remain unmodified.
-#####################################################
-
-You might find messages like these in your log files:
-
-.. code::
-
-    [ERROR] [paperless.management.consumer] Timeout while waiting on file /usr/src/paperless/src/../consume/SCN_0001.pdf to remain unmodified.
-
-This indicates paperless timed out while waiting for the file to be completely written to the consume folder.
-Adjusting :ref:`polling configuration <configuration-polling>` values should resolve the issue.
-
-.. note::
-
-    The user will need to manually move the file out of the consume folder and
-    back in, for the initial failing file to be consumed.
-
-Consumer fails reporting "OS reports file as busy still".
-#########################################################
-
-You might find messages like these in your log files:
-
-.. code::
-
-    [WARNING] [paperless.management.consumer] Not consuming file /usr/src/paperless/src/../consume/SCN_0001.pdf: OS reports file as busy still
-
-This indicates paperless was unable to open the file, as the OS reported the file as still being in use.  To prevent a
-crash, paperless did not try to consume the file.  If paperless is using inotify (the default) to
-check for documents, try adjusting the :ref:`inotify configuration <configuration-inotify>`.  If polling is enabled,
-try adjusting the :ref:`polling configuration <configuration-polling>`.
-
-.. note::
-
-    The user will need to manually move the file out of the consume folder and
-    back in, for the initial failing file to be consumed.
-
-Log reports "Creating PaperlessTask failed".
-#########################################################
-
-You might find messages like these in your log files:
-
-.. code::
-
-    [ERROR] [paperless.management.consumer] Creating PaperlessTask failed: db locked
-
-You are likely using an sqlite based installation, with an increased number of workers and are running into sqlite's concurrency limitations.
-Uploading or consuming multiple files at once results in 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`` setting to allow more time for the database to unlock.  This may have
-minor performance implications.
+    You will be redirected shortly...

docs/usage_overview.rst

@@ -1,420 +1,12 @@
+.. _usage_overview:
+
 **************
 Usage Overview
 **************
 
-Paperless is an application that manages your personal documents. With
-the help of a document scanner (see :ref:`scanners`), paperless transforms
-your wieldy physical document binders into a searchable archive and
-provides many utilities for finding and managing your documents.
 
+.. cssclass:: redirect-notice
 
-Terms and definitions
-#####################
+    The Paperless-ngx documentation has permanently moved.
 
-Paperless essentially consists of two different parts for managing your
-documents:
-
-* The *consumer* watches a specified folder and adds all documents in that
-  folder to paperless.
-* The *web server* provides a UI that you use to manage and search for your
-  scanned documents.
-
-Each document has a couple of fields that you can assign to them:
-
-* A *Document* is a piece of paper that sometimes contains valuable
-  information.
-* The *correspondent* of a document is the person, institution or company that
-  a document either originates from, or is sent to.
-* A *tag* is a label that you can assign to documents. Think of labels as more
-  powerful folders: Multiple documents can be grouped together with a single
-  tag, however, a single document can also have multiple tags. This is not
-  possible with folders. The reason folders are not implemented in paperless
-  is simply that tags are much more versatile than folders.
-* A *document type* is used to demarcate the type of a document such as letter,
-  bank statement, invoice, contract, etc. It is used to identify what a document
-  is about.
-* The *date added* of a document is the date the document was scanned into
-  paperless. You cannot and should not change this date.
-* The *date created* of a document is the date the document was initially issued.
-  This can be the date you bought a product, the date you signed a contract, or
-  the date a letter was sent to you.
-* The *archive serial number* (short: ASN) of a document is the identifier of
-  the document in your physical document binders. See
-  :ref:`usage-recommended_workflow` below.
-* The *content* of a document is the text that was OCR'ed from the document.
-  This text is fed into the search engine and is used for matching tags,
-  correspondents and document types.
-
-
-Frontend overview
-#################
-
-.. warning::
-
-    TBD. Add some fancy screenshots!
-
-Adding documents to paperless
-#############################
-
-Once you've got Paperless setup, you need to start feeding documents into it.
-When adding documents to paperless, it will perform the following operations on
-your documents:
-
-1.  OCR the document, if it has no text. Digital documents usually have text,
-    and this step will be skipped for those documents.
-2.  Paperless will create an archivable PDF/A document from your document.
-    If this document is coming from your scanner, it will have embedded selectable text.
-3.  Paperless performs automatic matching of tags, correspondents and types on the
-    document before storing it in the database.
-
-.. hint::
-
-    This process can be configured to fit your needs. If you don't want paperless
-    to create archived versions for digital documents, you can configure that by
-    configuring ``PAPERLESS_OCR_MODE=skip_noarchive``. Please read the
-    :ref:`relevant section in the documentation <configuration-ocr>`.
-
-.. note::
-
-    No matter which options you choose, Paperless will always store the original
-    document that it found in the consumption directory or in the mail and
-    will never overwrite that document. Archived versions are stored alongside the
-    original versions.
-
-
-The consumption directory
-=========================
-
-The primary method of getting documents into your database is by putting them in
-the consumption directory.  The consumer runs in an infinite loop, looking for new
-additions to this directory. When it finds them, the consumer goes about the process
-of parsing them with the OCR, indexing what it finds, and storing it in the media directory.
-
-Getting stuff into this directory is up to you.  If you're running Paperless
-on your local computer, you might just want to drag and drop files there, but if
-you're running this on a server and want your scanner to automatically push
-files to this directory, you'll need to setup some sort of service to accept the
-files from the scanner.  Typically, you're looking at an FTP server like
-`Proftpd`_ or a Windows folder share with `Samba`_.
-
-.. _Proftpd: http://www.proftpd.org/
-.. _Samba: http://www.samba.org/
-
-.. TODO: hyperref to configuration of the location of this magic folder.
-
-Web UI Upload
-=============
-
-The dashboard has a file drop field to upload documents to paperless. Simply drag a file
-onto this field or select a file with the file dialog. Multiple files are supported.
-
-You can also upload documents on any other page of the web UI by dragging-and-dropping
-files into your browser window.
-
-.. _usage-mobile_upload:
-
-Mobile upload
-=============
-
-The mobile app over at `<https://github.com/qcasey/paperless_share>`_ allows Android users
-to share any documents with paperless. This can be combined with any of the mobile
-scanning apps out there, such as Office Lens.
-
-Furthermore, there is the  `Paperless App <https://github.com/bauerj/paperless_app>`_ as well,
-which not only has document upload, but also document browsing and download features.
-
-.. _usage-email:
-
-IMAP (Email)
-============
-
-You can tell paperless-ngx to consume documents from your email accounts.
-This is a very flexible and powerful feature, if you regularly received documents
-via mail that you need to archive. The mail consumer can be configured by using the
-admin interface in the following manner:
-
-1.  Define e-mail accounts.
-2.  Define mail rules for your account.
-
-These rules perform the following:
-
-1.  Connect to the mail server.
-2.  Fetch all matching mails (as defined by folder, maximum age and the filters)
-3.  Check if there are any consumable attachments.
-4.  If so, instruct paperless to consume the attachments and optionally
-    use the metadata provided in the rule for the new document.
-5.  If documents were consumed from a mail, the rule action is performed
-    on that mail.
-
-Paperless will completely ignore mails that do not match your filters. It will also
-only perform the action on mails that it has consumed documents from.
-
-The actions all ensure that the same mail is not consumed twice by different means.
-These are as follows:
-
-*   **Delete:** Immediately deletes mail that paperless has consumed documents from.
-    Use with caution.
-*   **Mark as read:** Mark consumed mail as read. Paperless will not consume documents
-    from already read mails. If you read a mail before paperless sees it, it will be
-    ignored.
-*   **Flag:** Sets the 'important' flag on mails with consumed documents. Paperless
-    will not consume flagged mails.
-*   **Move to folder:** Moves consumed mails out of the way so that paperless wont
-    consume them again.
-*   **Add custom Tag:** Adds a custom tag to mails with consumed documents (the IMAP
-    standard calls these "keywords"). Paperless will not consume mails already tagged.
-    Not all mail servers support this feature!
-
-.. caution::
-
-    The mail consumer will perform these actions on all mails it has consumed
-    documents from. Keep in mind that the actual consumption process may fail
-    for some reason, leaving you with missing documents in paperless.
-
-.. note::
-
-    With the correct set of rules, you can completely automate your email documents.
-    Create rules for every correspondent you receive digital documents from and
-    paperless will read them automatically. The default action "mark as read" is
-    pretty tame and will not cause any damage or data loss whatsoever.
-
-    You can also setup a special folder in your mail account for paperless and use
-    your favorite mail client to move to be consumed mails into that folder
-    automatically or manually and tell paperless to move them to yet another folder
-    after consumption. It's up to you.
-
-.. note::
-
-    When defining a mail rule with a folder, you may need to try different characters to
-    define how the sub-folders are separated.  Common values include ".", "/" or "|", but
-    this varies by the mail server.  Check the documentation for your mail server.  In the
-    event of an error fetching mail from a certain folder, check the Paperless logs.  When
-    a folder is not located, Paperless will attempt to list all folders found in the account
-    to the Paperless logs.
-
-.. note::
-
-    Paperless will process the rules in the order defined in the admin page.
-
-    You can define catch-all rules and have them executed last to consume
-    any documents not matched by previous rules. Such a rule may assign an "Unknown
-    mail document" tag to consumed documents so you can inspect them further.
-
-Paperless is set up to check your mails every 10 minutes. This can be configured on the
-'Scheduled tasks' page in the admin.
-
-
-REST API
-========
-
-You can also submit a document using the REST API, see :ref:`api-file_uploads` for details.
-
-.. _basic-searching:
-
-
-Best practices
-##############
-
-Paperless offers a couple tools that help you organize your document collection. However,
-it is up to you to use them in a way that helps you organize documents and find specific
-documents when you need them. This section offers a couple ideas for managing your collection.
-
-Document types allow you to classify documents according to what they are. You can define
-types such as "Receipt", "Invoice", or "Contract". If you used to collect all your receipts
-in a single binder, you can recreate that system in paperless by defining a document type,
-assigning documents to that type and then filtering by that type to only see all receipts.
-
-Not all documents need document types. Sometimes its hard to determine what the type of a
-document is or it is hard to justify creating a document type that you only need once or twice.
-This is okay. As long as the types you define help you organize your collection in the way
-you want, paperless is doing its job.
-
-Tags can be used in many different ways. Think of tags are more versatile folders or binders.
-If you have a binder for documents related to university / your car or health care, you can
-create these binders in paperless by creating tags and assigning them to relevant documents.
-Just as with documents, you can filter the document list by tags and only see documents of
-a certain topic.
-
-With physical documents, you'll often need to decide which folder the document belongs to.
-The advantage of tags over folders and binders is that a single document can have multiple
-tags. A physical document cannot magically appear in two different folders, but with tags,
-this is entirely possible.
-
-.. hint::
-
-  This can be used in many different ways. One example: Imagine you're working on a particular
-  task, such as signing up for university. Usually you'll need to collect a bunch of different
-  documents that are already sorted into various folders. With the tag system of paperless,
-  you can create a new group of documents that are relevant to this task without destroying
-  the already existing organization. When you're done with the task, you could delete the
-  tag again, which would be equal to sorting documents back into the folder they belong into.
-  Or keep the tag, up to you.
-
-All of the logic above applies to correspondents as well. Attach them to documents if you
-feel that they help you organize your collection.
-
-When you've started organizing your documents, create a couple saved views for document collections
-you regularly access. This is equal to having labeled physical binders on your desk, except
-that these saved views are dynamic and simply update themselves as you add documents to the system.
-
-Here are a couple examples of tags and types that you could use in your collection.
-
-* An ``inbox`` tag for newly added documents that you haven't manually edited yet.
-* A tag ``car`` for everything car related (repairs, registration, insurance, etc)
-* A tag ``todo`` for documents that you still need to do something with, such as reply, or
-  perform some task online.
-* A tag ``bank account x`` for all bank statement related to that account.
-* A tag ``mail`` for anything that you added to paperless via its mail processing capabilities.
-* A tag ``missing_metadata`` when you still need to add some metadata to a document, but can't
-  or don't want to do this right now.
-
-.. _basic-usage_searching:
-
-Searching
-#########
-
-Paperless offers an extensive searching mechanism that is designed to allow you to quickly
-find a document you're looking for (for example, that thing that just broke and you bought
-a couple months ago, that contract you signed 8 years ago).
-
-When you search paperless for a document, it tries to match this query against your documents.
-Paperless will look for matching documents by inspecting their content, title, correspondent,
-type and tags. Paperless returns a scored list of results, so that documents matching your query
-better will appear further up in the search results.
-
-By default, paperless returns only documents which contain all words typed in the search bar.
-However, paperless also offers advanced search syntax if you want to drill down the results
-further.
-
-Matching documents with logical expressions:
-
-.. code::
-
-  shopname AND (product1 OR product2)
-
-Matching specific tags, correspondents or types:
-
-.. code::
-
-  type:invoice tag:unpaid
-  correspondent:university certificate
-
-Matching dates:
-
-.. code::
-
-  created:[2005 to 2009]
-  added:yesterday
-  modified:today
-
-Matching inexact words:
-
-.. code::
-
-  produ*name
-
-.. note::
-
-  Inexact terms are hard for search indexes. These queries might take a while to execute. That's why paperless offers
-  auto complete and query correction.
-
-All of these constructs can be combined as you see fit.
-If you want to learn more about the query language used by paperless, paperless uses Whoosh's default query language.
-Head over to `Whoosh query language <https://whoosh.readthedocs.io/en/latest/querylang.html>`_.
-For details on what date parsing utilities are available, see
-`Date parsing <https://whoosh.readthedocs.io/en/latest/dates.html#parsing-date-queries>`_.
-
-
-.. _usage-recommended_workflow:
-
-The recommended workflow
-########################
-
-Once you have familiarized yourself with paperless and are ready to use it
-for all your documents, the recommended workflow for managing your documents
-is as follows. This workflow also takes into account that some documents
-have to be kept in physical form, but still ensures that you get all the
-advantages for these documents as well.
-
-The following diagram shows how easy it is to manage your documents.
-
-.. image:: _static/recommended_workflow.png
-
-Preparations in paperless
-=========================
-
-* Create an inbox tag that gets assigned to all new documents.
-* Create a TODO tag.
-
-Processing of the physical documents
-====================================
-
-Keep a physical inbox. Whenever you receive a document that you need to
-archive, put it into your inbox. Regularly, do the following for all documents
-in your inbox:
-
-1.  For each document, decide if you need to keep the document in physical
-    form. This applies to certain important documents, such as contracts and
-    certificates.
-2.  If you need to keep the document, write a running number on the document
-    before scanning, starting at one and counting upwards. This is the archive
-    serial number, or ASN in short.
-3.  Scan the document.
-4.  If the document has an ASN assigned, store it in a *single* binder, sorted
-    by ASN. Don't order this binder in any other way.
-5.  If the document has no ASN, throw it away. Yay!
-
-Over time, you will notice that your physical binder will fill up. If it is
-full, label the binder with the range of ASNs in this binder (i.e., "Documents
-1 to 343"), store the binder in your cellar or elsewhere, and start a new
-binder.
-
-The idea behind this process is that you will never have to use the physical
-binders to find a document. If you need a specific physical document, you
-may find this document by:
-
-1.  Searching in paperless for the document.
-2.  Identify the ASN of the document, since it appears on the scan.
-3.  Grab the relevant document binder and get the document. This is easy since
-    they are sorted by ASN.
-
-Processing of documents in paperless
-====================================
-
-Once you have scanned in a document, proceed in paperless as follows.
-
-1.  If the document has an ASN, assign the ASN to the document.
-2.  Assign a correspondent to the document (i.e., your employer, bank, etc)
-    This isn't strictly necessary but helps in finding a document when you need
-    it.
-3.  Assign a document type (i.e., invoice, bank statement, etc) to the document
-    This isn't strictly necessary but helps in finding a document when you need
-    it.
-4.  Assign a proper title to the document (the name of an item you bought, the
-    subject of the letter, etc)
-5.  Check that the date of the document is correct. Paperless tries to read
-    the date from the content of the document, but this fails sometimes if the
-    OCR is bad or multiple dates appear on the document.
-6.  Remove inbox tags from the documents.
-
-.. hint::
-
-    You can setup manual matching rules for your correspondents and tags and
-    paperless will assign them automatically. After consuming a couple documents,
-    you can even ask paperless to *learn* when to assign tags and correspondents
-    by itself. For details on this feature, see :ref:`advanced-matching`.
-
-Task management
-===============
-
-Some documents require attention and require you to act on the document. You
-may take two different approaches to handle these documents based on how
-regularly you intend to scan documents and use paperless.
-
-* If you scan and process your documents in paperless regularly, assign a
-  TODO tag to all scanned documents that you need to process. Create a saved
-  view on the dashboard that shows all documents with this tag.
-* If you do not scan documents regularly and use paperless solely for archiving,
-  create a physical todo box next to your physical inbox and put documents you
-  need to process in the TODO box. When you performed the task associated with
-  the document, move it to the inbox.
+    You will be redirected shortly...

scripts/paperless-scheduler.service

@@ -1,12 +1,12 @@
 [Unit]
-Description=Paperless scheduler
+Description=Paperless Celery Beat
 Requires=redis.service
 
 [Service]
 User=paperless
 Group=paperless
 WorkingDirectory=/opt/paperless/src
-ExecStart=python3 manage.py qcluster
+ExecStart=celery --app paperless beat --loglevel INFO
 
 [Install]
 WantedBy=multi-user.target

scripts/paperless-task-queue.service

@@ -0,0 +1,12 @@
+[Unit]
+Description=Paperless Celery Workers
+Requires=redis.service
+
+[Service]
+User=paperless
+Group=paperless
+WorkingDirectory=/opt/paperless/src
+ExecStart=celery --app paperless worker --loglevel INFO
+
+[Install]
+WantedBy=multi-user.target

scripts/start_services.sh

@@ -2,5 +2,5 @@
 
 docker run -p 5432:5432 -e POSTGRES_PASSWORD=password -v paperless_pgdata:/var/lib/postgresql/data -d postgres:13
 docker run -d -p 6379:6379 redis:latest
-docker run -p 3000:3000 -d gotenberg/gotenberg:7.4
+docker run -p 3000:3000 -d gotenberg/gotenberg:7.6
 docker run -p 9998:9998 -d ghcr.io/paperless-ngx/tika:latest

src-ui/cypress/e2e/settings/settings.cy.ts

@@ -46,7 +46,7 @@ describe('settings', () => {
       })
     })
 
-    cy.viewport(1024, 1024)
+    cy.viewport(1024, 1600)
     cy.visit('/settings')
     cy.wait('@savedViews')
   })

src-ui/package.json

@@ -13,48 +13,49 @@
   },
   "private": true,
   "dependencies": {
-    "@angular/common": "~14.2.0",
-    "@angular/compiler": "~14.2.0",
-    "@angular/core": "~14.2.0",
-    "@angular/forms": "~14.2.0",
-    "@angular/localize": "~14.2.0",
-    "@angular/platform-browser": "~14.2.0",
-    "@angular/platform-browser-dynamic": "~14.2.0",
-    "@angular/router": "~14.2.0",
+    "@angular/common": "~14.2.8",
+    "@angular/compiler": "~14.2.8",
+    "@angular/core": "~14.2.8",
+    "@angular/forms": "~14.2.8",
+    "@angular/localize": "~14.2.8",
+    "@angular/platform-browser": "~14.2.8",
+    "@angular/platform-browser-dynamic": "~14.2.8",
+    "@angular/router": "~14.2.8",
     "@ng-bootstrap/ng-bootstrap": "^13.0.0",
     "@ng-select/ng-select": "^9.0.2",
     "@ngneat/dirty-check-forms": "^3.0.2",
     "@popperjs/core": "^2.11.6",
-    "bootstrap": "^5.2.0",
+    "bootstrap": "^5.2.1",
     "file-saver": "^2.0.5",
-    "ng2-pdf-viewer": "^9.1.0",
-    "ngx-color": "^8.0.2",
+    "ng2-pdf-viewer": "^9.1.2",
+    "ngx-color": "^8.0.3",
     "ngx-cookie-service": "^14.0.1",
     "ngx-file-drop": "^14.0.1",
-    "rxjs": "~7.5.6",
+    "ngx-ui-tour-ng-bootstrap": "^11.1.0",
+    "rxjs": "~7.5.7",
     "tslib": "^2.3.1",
-    "uuid": "^8.3.1",
+    "uuid": "^9.0.0",
     "zone.js": "~0.11.8"
   },
   "devDependencies": {
     "@angular-builders/jest": "14.0.1",
-    "@angular-devkit/build-angular": "~14.2.1",
-    "@angular/cli": "~14.2.1",
-    "@angular/compiler-cli": "~14.2.0",
+    "@angular-devkit/build-angular": "~14.2.7",
+    "@angular/cli": "~14.2.7",
+    "@angular/compiler-cli": "~14.2.8",
     "@types/jest": "28.1.6",
-    "@types/node": "^18.7.14",
+    "@types/node": "^18.7.23",
     "codelyzer": "^6.0.2",
-    "concurrently": "7.3.0",
+    "concurrently": "7.4.0",
     "jest": "28.1.3",
-    "jest-environment-jsdom": "^29.0.1",
+    "jest-environment-jsdom": "^29.2.2",
     "jest-preset-angular": "^12.2.2",
     "ts-node": "~10.9.1",
     "tslint": "~6.1.3",
-    "typescript": "~4.7.4",
+    "typescript": "~4.8.4",
     "wait-on": "~6.0.1"
   },
   "optionalDependencies": {
     "@cypress/schematic": "^2.1.1",
-    "cypress": "~10.7.0"
+    "cypress": "~10.9.0"
   }
 }

src-ui/src/app/app-routing.module.ts

@@ -15,6 +15,7 @@ import { DirtyFormGuard } from './guards/dirty-form.guard'
 import { StoragePathListComponent } from './components/manage/storage-path-list/storage-path-list.component'
 import { TasksComponent } from './components/manage/tasks/tasks.component'
 import { DirtyDocGuard } from './guards/dirty-doc.guard'
+import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
 
 const routes: Routes = [
   { path: '', redirectTo: 'dashboard', pathMatch: 'full' },
@@ -24,8 +25,16 @@ const routes: Routes = [
     canDeactivate: [DirtyDocGuard],
     children: [
       { path: 'dashboard', component: DashboardComponent },
-      { path: 'documents', component: DocumentListComponent },
-      { path: 'view/:id', component: DocumentListComponent },
+      {
+        path: 'documents',
+        component: DocumentListComponent,
+        canDeactivate: [DirtySavedViewGuard],
+      },
+      {
+        path: 'view/:id',
+        component: DocumentListComponent,
+        canDeactivate: [DirtySavedViewGuard],
+      },
       { path: 'documents/:id', component: DocumentDetailComponent },
       { path: 'asn/:id', component: DocumentAsnComponent },
       { path: 'tags', component: TagListComponent },

src-ui/src/app/app.component.html

@@ -11,3 +11,28 @@
         </div>
     </ng-template>
 </ngx-file-drop>
+
+<tour-step-template>
+    <ng-template #tourStep let-step="step">
+        <p class="tour-step-content" [innerHTML]="step?.content"></p>
+        <hr/>
+        <div class="d-flex justify-content-between align-items-center">
+            <span class="badge bg-light text-dark">{{ tourService.steps?.indexOf(step) + 1 }} / {{ tourService.steps?.length }}</span>
+            <div class="tour-step-navigation btn-toolbar" role="toolbar" aria-label="Controls">
+                <div class="btn-group btn-group-sm me-2" role="group" aria-label="Dismiss">
+                    <button class="btn btn-outline-danger" (click)="tourService.end()">
+                        {{ step?.endBtnTitle }}
+                    </button>
+                </div>
+                <div class="btn-group btn-group-sm align-self-end" role="group" aria-label="Previous / Next">
+                    <button *ngIf="tourService.hasPrev(step)" class="btn btn-outline-primary" (click)="tourService.prev()">
+                        « {{ step?.prevBtnTitle }}
+                    </button>
+                    <button *ngIf="tourService.hasNext(step)" class="btn btn-outline-primary" (click)="tourService.next()">
+                        {{ step?.nextBtnTitle }} »
+                    </button>
+                </div>
+            </div>
+        </div>
+    </ng-template>
+</tour-step-template>

src-ui/src/app/app.component.ts

@@ -1,6 +1,6 @@
 import { SettingsService } from './services/settings.service'
 import { SETTINGS_KEYS } from './data/paperless-uisettings'
-import { Component, OnDestroy, OnInit } from '@angular/core'
+import { Component, OnDestroy, OnInit, Renderer2 } from '@angular/core'
 import { Router } from '@angular/router'
 import { Subscription } from 'rxjs'
 import { ConsumerStatusService } from './services/consumer-status.service'
@@ -8,6 +8,7 @@ import { ToastService } from './services/toast.service'
 import { NgxFileDropEntry } from 'ngx-file-drop'
 import { UploadDocumentsService } from './services/upload-documents.service'
 import { TasksService } from './services/tasks.service'
+import { TourService } from 'ngx-ui-tour-ng-bootstrap'
 
 @Component({
   selector: 'app-root',
@@ -29,7 +30,9 @@ export class AppComponent implements OnInit, OnDestroy {
     private toastService: ToastService,
     private router: Router,
     private uploadDocumentsService: UploadDocumentsService,
-    private tasksService: TasksService
+    private tasksService: TasksService,
+    public tourService: TourService,
+    private renderer: Renderer2
   ) {
     let anyWindow = window as any
     anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.js'
@@ -112,6 +115,121 @@ export class AppComponent implements OnInit, OnDestroy {
           })
         }
       })
+
+    const prevBtnTitle = $localize`Prev`
+    const nextBtnTitle = $localize`Next`
+    const endBtnTitle = $localize`End`
+
+    this.tourService.initialize([
+      {
+        anchorId: 'tour.dashboard',
+        content: $localize`The dashboard can be used to show saved views, such as an 'Inbox'. Those settings are found under Settings > Saved Views once you have created some.`,
+        route: '/dashboard',
+        enableBackdrop: true,
+        delayAfterNavigation: 500,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.upload-widget',
+        content: $localize`Drag-and-drop documents here to start uploading or place them in the consume folder. You can also drag-and-drop documents anywhere on all other pages of the web app. Once you do, Paperless-ngx will start training its machine learning algorithms.`,
+        route: '/dashboard',
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.documents',
+        content: $localize`The documents list shows all of your documents and allows for filtering as well as bulk-editing. There are three different view styles: list, small cards and large cards. A list of documents currently opened for editing is shown in the sidebar.`,
+        route: '/documents?sort=created&reverse=1&page=1',
+        delayAfterNavigation: 500,
+        placement: 'bottom',
+        enableBackdrop: true,
+        disableScrollToAnchor: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.documents-filter-editor',
+        content: $localize`The filtering tools allow you to quickly find documents using various searches, dates, tags, etc.`,
+        route: '/documents?sort=created&reverse=1&page=1',
+        placement: 'bottom',
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.documents-views',
+        content: $localize`Any combination of filters can be saved as a 'view' which can then be displayed on the dashboard and / or sidebar.`,
+        route: '/documents?sort=created&reverse=1&page=1',
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.tags',
+        content: $localize`Tags, correspondents, document types and storage paths can all be managed using these pages. They can also be created from the document edit view.`,
+        route: '/tags',
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.file-tasks',
+        content: $localize`File Tasks shows you documents that have been consumed, are waiting to be, or may have failed during the process.`,
+        route: '/tasks',
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.settings',
+        content: $localize`Check out the settings for various tweaks to the web app or to toggle settings for saved views.`,
+        route: '/settings',
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.admin',
+        content: $localize`The Admin area contains more advanced controls as well as the settings for automatic e-mail fetching.`,
+        enableBackdrop: true,
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+      {
+        anchorId: 'tour.outro',
+        title: $localize`Thank you! 🙏`,
+        content:
+          $localize`There are <em>tons</em> more features and info we didn't cover here, but this should get you started. Check out the documentation or visit the project on GitHub to learn more or to report issues.` +
+          '<br/><br/>' +
+          $localize`Lastly, on behalf of every contributor to this community-supported project, thank you for using Paperless-ngx!`,
+        route: '/dashboard',
+        prevBtnTitle,
+        nextBtnTitle,
+        endBtnTitle,
+      },
+    ])
+
+    this.tourService.start$.subscribe(() => {
+      this.renderer.addClass(document.body, 'tour-active')
+    })
+
+    this.tourService.end$.subscribe(() => {
+      // animation time
+      setTimeout(() => {
+        this.renderer.removeClass(document.body, 'tour-active')
+      }, 500)
+    })
   }
 
   public get dragDropEnabled(): boolean {

src-ui/src/app/app.module.ts

@@ -24,6 +24,7 @@ import { CorrespondentEditDialogComponent } from './components/common/edit-dialo
 import { TagEditDialogComponent } from './components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component'
 import { DocumentTypeEditDialogComponent } from './components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component'
 import { TagComponent } from './components/common/tag/tag.component'
+import { ClearableBadge } from './components/common/clearable-badge/clearable-badge.component'
 import { PageHeaderComponent } from './components/common/page-header/page-header.component'
 import { AppFrameComponent } from './components/app-frame/app-frame.component'
 import { ToastsComponent } from './components/common/toasts/toasts.component'
@@ -69,6 +70,12 @@ import { ColorComponent } from './components/common/input/color/color.component'
 import { DocumentAsnComponent } from './components/document-asn/document-asn.component'
 import { DocumentCommentsComponent } from './components/document-comments/document-comments.component'
 import { DirtyDocGuard } from './guards/dirty-doc.guard'
+import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
+import { StoragePathListComponent } from './components/manage/storage-path-list/storage-path-list.component'
+import { StoragePathEditDialogComponent } from './components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component'
+import { SettingsService } from './services/settings.service'
+import { TasksComponent } from './components/manage/tasks/tasks.component'
+import { TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap'
 
 import localeBe from '@angular/common/locales/be'
 import localeCs from '@angular/common/locales/cs'
@@ -89,10 +96,6 @@ import localeSr from '@angular/common/locales/sr'
 import localeSv from '@angular/common/locales/sv'
 import localeTr from '@angular/common/locales/tr'
 import localeZh from '@angular/common/locales/zh'
-import { StoragePathListComponent } from './components/manage/storage-path-list/storage-path-list.component'
-import { StoragePathEditDialogComponent } from './components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component'
-import { SettingsService } from './services/settings.service'
-import { TasksComponent } from './components/manage/tasks/tasks.component'
 
 registerLocaleData(localeBe)
 registerLocaleData(localeCs)
@@ -140,6 +143,7 @@ function initializeApp(settings: SettingsService) {
     DocumentTypeEditDialogComponent,
     StoragePathEditDialogComponent,
     TagComponent,
+    ClearableBadge,
     PageHeaderComponent,
     AppFrameComponent,
     ToastsComponent,
@@ -188,6 +192,7 @@ function initializeApp(settings: SettingsService) {
     PdfViewerModule,
     NgSelectModule,
     ColorSliderModule,
+    TourNgBootstrapModule.forRoot(),
   ],
   providers: [
     {
@@ -213,6 +218,7 @@ function initializeApp(settings: SettingsService) {
     { provide: NgbDateAdapter, useClass: ISODateAdapter },
     { provide: NgbDateParserFormatter, useClass: LocalizedDateParserFormatter },
     DirtyDocGuard,
+    DirtySavedViewGuard,
   ],
   bootstrap: [AppComponent],
 })

src-ui/src/app/components/app-frame/app-frame.component.html

@@ -4,11 +4,11 @@
     (click)="isMenuCollapsed = !isMenuCollapsed">
     <span class="navbar-toggler-icon"></span>
   </button>
-  <a class="navbar-brand col-auto col-md-3 col-lg-2 me-0 px-3 py-3 order-sm-0" routerLink="/dashboard">
+  <a class="navbar-brand col-auto col-md-3 col-lg-2 me-0 px-3 py-3 order-sm-0" [ngClass]="slimSidebarEnabled ? 'slim' : 'col-auto col-md-3 col-lg-2'" routerLink="/dashboard" tourAnchor="tour.intro">
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 198.43 238.91" width="1em" class="me-2" fill="currentColor">
       <path d="M194.7,0C164.22,70.94,17.64,79.74,64.55,194.06c.58,1.47-10.85,17-18.47,29.9-1.76-6.45-3.81-13.48-3.52-14.07,38.11-45.14-27.26-70.65-30.78-107.58C-4.64,131.62-10.5,182.92,39,212.53c.3,0,2.64,11.14,3.81,16.71a58.55,58.55,0,0,0-2.93,6.45c-1.17,2.93,7.62,2.64,7.62,3.22.88-.29,21.7-36.93,22.28-37.23C187.67,174.72,208.48,68.6,194.7,0ZM134.61,74.75C79.5,124,70.12,160.64,71.88,178.53,53.41,134.85,107.64,86.77,134.61,74.75ZM28.2,145.11c10.55,9.67,28.14,39.28,13.19,56.57C44.91,193.77,46.08,175.89,28.2,145.11Z" transform="translate(0 0)"/>
     </svg>
-    <ng-container i18n="app title">Paperless-ngx</ng-container>
+    <span class="ms-2" [class.visually-hidden]="slimSidebarEnabled" i18n="app title">Paperless-ngx</span>
   </a>
   <div class="search-form-container flex-grow-1 py-2 pb-3 pb-sm-2 px-3 ps-md-4 me-sm-auto order-3 order-sm-1">
     <form (ngSubmit)="search()" class="form-inline flex-grow-1">
@@ -16,12 +16,17 @@
         <use xlink:href="assets/bootstrap-icons.svg#search"/>
       </svg>
       <input class="form-control form-control-sm" type="text" placeholder="Search documents" aria-label="Search"
-        [formControl]="searchField" [ngbTypeahead]="searchAutoComplete" (selectItem)="itemSelected($event)" i18n-placeholder>
+        [formControl]="searchField" [ngbTypeahead]="searchAutoComplete" (keyup)="searchFieldKeyup($event)" (selectItem)="itemSelected($event)" i18n-placeholder>
+      <button type="button" *ngIf="!searchFieldEmpty" class="btn btn-link btn-sm px-0 position-absolute top-0 end-0" (click)="resetSearchField()">
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-x me-1" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+          <path fill-rule="evenodd" d="M4.646 4.646a.5.5 0 0 1 .708 0L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 0 1 0-.708z"/>
+        </svg>
+      </button>
     </form>
   </div>
   <ul ngbNav class="order-sm-3">
     <li ngbDropdown class="nav-item dropdown">
-      <button class="btn" id="userDropdown" ngbDropdownToggle>
+      <button class="btn border-0" id="userDropdown" ngbDropdownToggle>
         <span class="small me-2 d-none d-sm-inline">
           {{this.settingsService.displayName}}
         </span>
@@ -51,48 +56,54 @@
 
 <div class="container-fluid">
   <div class="row">
-    <nav id="sidebarMenu" class="col-md-3 col-lg-2 d-md-block bg-light sidebar collapse" [ngbCollapse]="isMenuCollapsed">
+    <nav id="sidebarMenu" class="d-md-block bg-light sidebar collapse" [ngClass]="slimSidebarEnabled ? 'slim' : 'col-md-3 col-lg-2'" [class.animating]="slimSidebarAnimating" [ngbCollapse]="isMenuCollapsed">
+      <button class="btn btn-sm btn-dark sidebar-slim-toggler" (click)="toggleSlimSidebar()">
+        <svg class="sidebaricon-sm" fill="currentColor">
+          <use *ngIf="slimSidebarEnabled" xlink:href="assets/bootstrap-icons.svg#chevron-double-right"/>
+          <use *ngIf="!slimSidebarEnabled" xlink:href="assets/bootstrap-icons.svg#chevron-double-left"/>
+        </svg>
+      </button>
       <div class="sidebar-sticky pt-3 d-flex flex-column justify-space-around">
         <ul class="nav flex-column">
           <li class="nav-item">
-            <a class="nav-link" routerLink="dashboard" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" routerLink="dashboard" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Dashboard" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#house"/>
-              </svg>&nbsp;<ng-container i18n>Dashboard</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Dashboard</ng-container></span>
             </a>
           </li>
           <li class="nav-item">
-            <a class="nav-link" routerLink="documents" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" routerLink="documents" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Documents" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#files"/>
-              </svg>&nbsp;<ng-container i18n>Documents</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Documents</ng-container></span>
             </a>
           </li>
         </ul>
 
         <h6 class="sidebar-heading px-3 mt-4 mb-1 text-muted" *ngIf='savedViewService.loading || savedViewService.sidebarViews.length > 0'>
-          <ng-container i18n>Saved views</ng-container>
+          <span i18n>Saved views</span>
           <div *ngIf="savedViewService.loading" class="spinner-border spinner-border-sm fw-normal ms-2" role="status"></div>
         </h6>
         <ul class="nav flex-column mb-2">
           <li class="nav-item w-100" *ngFor="let view of savedViewService.sidebarViews">
-            <a class="nav-link text-truncate" routerLink="view/{{view.id}}" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" [class.text-truncate]="!slimSidebarEnabled" routerLink="view/{{view.id}}" routerLinkActive="active" (click)="closeMenu()" [ngbPopover]="view.name" [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#funnel"/>
-              </svg>&nbsp;{{view.name}}
+              </svg><span>&nbsp;{{view.name}}</span>
             </a>
           </li>
         </ul>
 
         <h6 class="sidebar-heading px-3 mt-4 mb-1 text-muted" *ngIf='openDocuments.length > 0'>
-          <ng-container i18n>Open documents</ng-container>
+          <span i18n>Open documents</span>
         </h6>
         <ul class="nav flex-column mb-2">
           <li class="nav-item w-100" *ngFor='let d of openDocuments'>
-            <a class="nav-link text-truncate" routerLink="documents/{{d.id}}" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" [class.text-truncate]="!slimSidebarEnabled" routerLink="documents/{{d.id}}" routerLinkActive="active" (click)="closeMenu()" [ngbPopover]="d.title | documentTitle" [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#file-text"/>
-              </svg>&nbsp;{{d.title | documentTitle}}
+              </svg><span>&nbsp;{{d.title | documentTitle}}</span>
               <span class="close" (click)="closeDocument(d); $event.preventDefault()">
                 <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" class="bi bi-x" viewBox="0 0 16 16">
                   <use xlink:href="assets/bootstrap-icons.svg#x"/>
@@ -101,95 +112,96 @@
             </a>
           </li>
           <li class="nav-item w-100" *ngIf="openDocuments.length >= 1">
-            <a class="nav-link text-truncate" [routerLink]="[]" (click)="closeAll()">
+            <a class="nav-link" [class.text-truncate]="!slimSidebarEnabled" [routerLink]="[]" (click)="closeAll()" ngbPopover="Close all" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#x"/>
-              </svg>&nbsp;<ng-container i18n>Close all</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Close all</ng-container></span>
             </a>
           </li>
         </ul>
 
         <h6 class="sidebar-heading px-3 mt-4 mb-1 text-muted">
-          <ng-container i18n>Manage</ng-container>
+          <span i18n>Manage</span>
         </h6>
         <ul class="nav flex-column mb-2">
           <li class="nav-item">
-            <a class="nav-link" routerLink="correspondents" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" routerLink="correspondents" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Correspondents" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#person"/>
-              </svg>&nbsp;<ng-container i18n>Correspondents</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Correspondents</ng-container></span>
             </a>
           </li>
-          <li class="nav-item">
-            <a class="nav-link" routerLink="tags" routerLinkActive="active" (click)="closeMenu()">
+          <li class="nav-item" tourAnchor="tour.tags">
+            <a class="nav-link" routerLink="tags" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Tags" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#tags"/>
-              </svg>&nbsp;<ng-container i18n>Tags</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Tags</ng-container></span>
             </a>
           </li>
           <li class="nav-item">
-            <a class="nav-link" routerLink="documenttypes" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" routerLink="documenttypes" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Document types" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#hash"/>
-              </svg>&nbsp;<ng-container i18n>Document types</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Document types</ng-container></span>
             </a>
           </li>
           <li class="nav-item">
-            <a class="nav-link" routerLink="storagepaths" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" routerLink="storagepaths" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Storage paths" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#folder"/>
-              </svg>&nbsp;<ng-container i18n>Storage paths</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Storage paths</ng-container></span>
             </a>
           </li>
-          <li class="nav-item">
-            <a class="nav-link" routerLink="tasks" routerLinkActive="active" (click)="closeMenu()">
+          <li class="nav-item" tourAnchor="tour.file-tasks">
+            <a class="nav-link" routerLink="tasks" routerLinkActive="active" (click)="closeMenu()" ngbPopover="File Tasks" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
+              <span *ngIf="tasksService.failedFileTasks.length > 0 && slimSidebarEnabled" class="badge bg-danger position-absolute top-0 end-0">{{tasksService.failedFileTasks.length}}</span>
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#list-task"/>
-              </svg>&nbsp;<ng-container i18n>File Tasks<ng-container *ngIf="tasksService.failedFileTasks.length > 0"><span class="badge bg-danger ms-2">{{tasksService.failedFileTasks.length}}</span></ng-container></ng-container>
+              </svg><span>&nbsp;<ng-container i18n>File Tasks<span *ngIf="tasksService.failedFileTasks.length > 0"><span class="badge bg-danger ms-2">{{tasksService.failedFileTasks.length}}</span></span></ng-container></span>
             </a>
           </li>
           <li class="nav-item">
-            <a class="nav-link" routerLink="logs" routerLinkActive="active" (click)="closeMenu()">
+            <a class="nav-link" routerLink="logs" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Logs" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#text-left"/>
-              </svg>&nbsp;<ng-container i18n>Logs</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Logs</ng-container></span>
             </a>
           </li>
-          <li class="nav-item">
-            <a class="nav-link" routerLink="settings" routerLinkActive="active" (click)="closeMenu()">
+          <li class="nav-item" tourAnchor="tour.settings">
+            <a class="nav-link" routerLink="settings" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Settings" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#gear"/>
-              </svg>&nbsp;<ng-container i18n>Settings</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Settings</ng-container></span>
             </a>
           </li>
-          <li class="nav-item">
-            <a class="nav-link" href="admin/">
+          <li class="nav-item" tourAnchor="tour.admin">
+            <a class="nav-link" href="admin/" ngbPopover="Admin" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#toggles"/>
-              </svg>&nbsp;<ng-container i18n>Admin</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Admin</ng-container></span>
             </a>
           </li>
         </ul>
 
         <h6 class="sidebar-heading px-3 mt-auto pt-4 mb-1 text-muted">
-          <ng-container i18n>Info</ng-container>
+          <span i18n>Info</span>
         </h6>
         <ul class="nav flex-column mb-2">
-          <li class="nav-item">
-            <a class="nav-link" target="_blank" rel="noopener noreferrer" href="https://paperless-ngx.readthedocs.io/en/latest/">
+          <li class="nav-item" tourAnchor="tour.outro">
+            <a class="nav-link" target="_blank" rel="noopener noreferrer" href="https://paperless-ngx.readthedocs.io/en/latest/" ngbPopover="Documentation" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#question-circle"/>
-              </svg>&nbsp;<ng-container i18n>Documentation</ng-container>
+              </svg><span>&nbsp;<ng-container i18n>Documentation</ng-container></span>
             </a>
           </li>
           <li class="nav-item">
             <div class="d-flex w-100 flex-wrap">
-              <a class="nav-link pe-2 pb-1" target="_blank" rel="noopener noreferrer" href="https://github.com/paperless-ngx/paperless-ngx">
+              <a class="nav-link pe-2 pb-1" target="_blank" rel="noopener noreferrer" href="https://github.com/paperless-ngx/paperless-ngx" ngbPopover="GitHub" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
                 <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" class="sidebaricon" viewBox="0 0 16 16">
                   <use xlink:href="assets/bootstrap-icons.svg#github" />
-                </svg>&nbsp;<ng-container i18n>GitHub</ng-container>
+                </svg><span>&nbsp;<ng-container i18n>GitHub</ng-container></span>
               </a>
-              <a class="nav-link-additional small text-muted ms-3" target="_blank" rel="noopener noreferrer" href="https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests" title="Suggest an idea" i18n-title>
+              <a class="nav-link-additional small text-muted ms-3" [class.visually-hidden]="slimSidebarEnabled" target="_blank" rel="noopener noreferrer" href="https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests" title="Suggest an idea" i18n-title>
                 <svg xmlns="http://www.w3.org/2000/svg" width="1.1em" height="1.1em" fill="currentColor" class="me-1" viewBox="0 0 16 16">
                   <use xlink:href="assets/bootstrap-icons.svg#lightbulb" />
                 </svg>
@@ -197,17 +209,28 @@
               </a>
             </div>
           </li>
-          <li class="nav-item mt-2">
+          <li class="nav-item mt-2" [class.visually-hidden]="slimSidebarEnabled">
             <div class="px-3 py-2 text-muted small d-flex align-items-center flex-wrap">
               <div class="me-3">{{ versionString }}</div>
-              <div *ngIf="appRemoteVersion" class="version-check">
+              <div *ngIf="!settingsService.updateCheckingIsSet || appRemoteVersion" class="version-check">
                 <ng-template #updateAvailablePopContent>
                   <span class="small">Paperless-ngx {{ appRemoteVersion.version }} <ng-container i18n>is available.</ng-container><br/><ng-container i18n>Click to view.</ng-container></span>
                 </ng-template>
                 <ng-template #updateCheckingNotEnabledPopContent>
-                  <span class="small"><ng-container i18n>Checking for updates is disabled.</ng-container><br/><ng-container i18n>Click for more information.</ng-container></span>
+                  <p class="small mb-2">
+                    <ng-container i18n>Paperless-ngx can automatically check for updates</ng-container>
+                  </p>
+                  <div class="btn-group btn-group-xs flex-fill w-100">
+                    <button class="btn btn-outline-primary" (click)="setUpdateChecking(true)">Enable</button>
+                    <button class="btn btn-outline-secondary" (click)="setUpdateChecking(false)">Disable</button>
+                  </div>
+                  <p class="small mb-0 mt-2">
+                    <a class="small text-decoration-none fst-italic" routerLink="/settings" fragment="update-checking" i18n>
+                      How does this work?
+                    </a>
+                  </p>
                 </ng-template>
-                <ng-container *ngIf="appRemoteVersion.feature_is_set; else updateCheckNotSet">
+                <ng-container *ngIf="settingsService.updateCheckingIsSet; else updateCheckNotSet">
                   <a *ngIf="appRemoteVersion.update_available" class="small text-decoration-none" target="_blank" rel="noopener noreferrer" href="https://github.com/paperless-ngx/paperless-ngx/releases"
                   [ngbPopover]="updateAvailablePopContent" popoverClass="shadow" triggers="mouseenter:mouseleave" container="body">
                     <svg fill="currentColor" class="me-1" width="1.2em" height="1.2em" style="vertical-align: text-top;" viewBox="0 0 16 16">
@@ -217,8 +240,8 @@
                   </a>
                 </ng-container>
                 <ng-template #updateCheckNotSet>
-                  <a class="small text-decoration-none" target="_blank" rel="noopener noreferrer" href="https://paperless-ngx.readthedocs.io/en/latest/configuration.html#update-checking"
-                  [ngbPopover]="updateCheckingNotEnabledPopContent" popoverClass="shadow" triggers="mouseenter:mouseleave" container="body">
+                  <a class="small text-decoration-none" routerLink="/settings" fragment="update-checking"
+                  [ngbPopover]="updateCheckingNotEnabledPopContent" popoverClass="shadow" triggers="mouseenter" container="body">
                     <svg fill="currentColor" class="me-1" width="1.2em" height="1.2em" style="vertical-align: text-top;" viewBox="0 0 16 16">
                       <use xlink:href="assets/bootstrap-icons.svg#info-circle" />
                     </svg>
@@ -231,7 +254,7 @@
       </div>
     </nav>
 
-    <main role="main" class="col-md-9 ms-sm-auto col-lg-10 px-md-4">
+    <main role="main" class="ms-sm-auto px-md-4" [ngClass]="slimSidebarEnabled ? 'col-slim' : 'col-md-9 col-lg-10'">
       <router-outlet></router-outlet>
     </main>
   </div>

src-ui/src/app/components/app-frame/app-frame.component.scss

@@ -1,3 +1,6 @@
+@import "node_modules/bootstrap/scss/functions";
+@import "node_modules/bootstrap/scss/variables";
+
 /*
  * Sidebar
  */
@@ -14,6 +17,17 @@
     width: 0.8em;
     height: 0.8em;
   }
+
+  // These come from the col-md-3 col-lg-2 classes for regular sidebar, needed for animation
+  @media (min-width: 768px) {
+    max-width: 25%;
+  }
+
+  @media (min-width: 992px) {
+    max-width: 16.66666667%;
+  }
+
+  transition: all .2s ease;
 }
 @media (max-width: 767.98px) {
   .sidebar {
@@ -21,6 +35,90 @@
   }
 }
 
+main {
+  transition: all .2s ease;
+}
+
+.sidebar-slim-toggler {
+  display: none; // hide on mobile
+}
+
+.sidebar li.nav-item span,
+.sidebar .sidebar-heading span {
+  transition: all .1s ease;
+}
+
+@media(min-width: 768px) {
+  .sidebar.slim {
+    max-width: 50px;
+
+    li.nav-item span.badge {
+      display: inline-block;
+      margin-right: 2px;
+    }
+  }
+
+  .sidebar.slim:not(.animating) {
+    li.nav-item span,
+    .sidebar-heading span {
+      display: none;
+    }
+  }
+
+  .sidebar.animating {
+    li.nav-item span,
+    .sidebar-heading span {
+      display: unset;
+      position: absolute;
+      opacity: 0;
+      overflow: hidden;
+    }
+  }
+
+  .sidebar:not(.slim):not(.animating) {
+    li.nav-item span,
+    .sidebar-heading span {
+      position: unset;
+      opacity: 1;
+      overflow: auto;
+    }
+  }
+
+  .sidebar.slim,
+  .sidebar.animating {
+    .text-truncate {
+      text-overflow: unset !important;
+      word-wrap: break-word !important;
+    }
+  }
+
+  .sidebar.slim {
+    li.nav-item span.badge {
+      display: inline-block;
+      margin-right: 2px;
+    }
+  }
+
+  .col-slim {
+    padding-left: calc(50px + $grid-gutter-width) !important;
+  }
+
+  .sidebar-slim-toggler {
+    display: block;
+    position: absolute;
+    right: -12px;
+    top: 60px;
+    z-index: 996;
+    --bs-btn-padding-x: 0.35rem;
+    --bs-btn-padding-y: 0.125rem;
+  }
+}
+
+::ng-deep .popover-slim .popover-body {
+  --bs-popover-body-padding-x: .5rem;
+  --bs-popover-body-padding-y: .5rem;
+}
+
 .sidebar-sticky {
   position: relative;
   top: 0;
@@ -77,7 +175,7 @@
 
   .close {
     display: none;
-    position: absolute;
+    position: absolute !important;
     cursor: pointer;
     opacity: 1;
     top: 0;
@@ -145,17 +243,18 @@
 
   form {
     position: relative;
+
+    > svg {
+      position: absolute;
+      left: 0.6rem;
+      top: 0.5rem;
+      color: rgba(255, 255, 255, 0.6);
+    }
   }
 
-  svg {
-    position: absolute;
-    left: 0.6rem;
-    top: 0.5rem;
-    color: rgba(255, 255, 255, 0.6);
-  }
 
   &:focus-within {
-    svg {
+    form > svg {
       display: none;
     }
 

src-ui/src/app/components/app-frame/app-frame.component.ts

@@ -1,4 +1,4 @@
-import { Component, HostListener } from '@angular/core'
+import { Component, HostListener, OnInit } from '@angular/core'
 import { FormControl } from '@angular/forms'
 import { ActivatedRoute, Router } from '@angular/router'
 import { from, Observable } from 'rxjs'
@@ -24,13 +24,15 @@ import {
 import { SettingsService } from 'src/app/services/settings.service'
 import { TasksService } from 'src/app/services/tasks.service'
 import { ComponentCanDeactivate } from 'src/app/guards/dirty-doc.guard'
+import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings'
+import { ToastService } from 'src/app/services/toast.service'
 
 @Component({
   selector: 'app-app-frame',
   templateUrl: './app-frame.component.html',
   styleUrls: ['./app-frame.component.scss'],
 })
-export class AppFrameComponent implements ComponentCanDeactivate {
+export class AppFrameComponent implements OnInit, ComponentCanDeactivate {
   constructor(
     public router: Router,
     private activatedRoute: ActivatedRoute,
@@ -40,14 +42,15 @@ export class AppFrameComponent implements ComponentCanDeactivate {
     private remoteVersionService: RemoteVersionService,
     private list: DocumentListViewService,
     public settingsService: SettingsService,
-    public tasksService: TasksService
-  ) {
-    this.remoteVersionService
-      .checkForUpdates()
-      .subscribe((appRemoteVersion: AppRemoteVersion) => {
-        this.appRemoteVersion = appRemoteVersion
-      })
-    tasksService.reload()
+    public tasksService: TasksService,
+    private readonly toastService: ToastService
+  ) {}
+
+  ngOnInit(): void {
+    if (this.settingsService.get(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED)) {
+      this.checkForUpdates()
+    }
+    this.tasksService.reload()
   }
 
   versionString = `${environment.appTitle} ${environment.version}`
@@ -55,12 +58,39 @@ export class AppFrameComponent implements ComponentCanDeactivate {
 
   isMenuCollapsed: boolean = true
 
+  slimSidebarAnimating: boolean = false
+
+  toggleSlimSidebar(): void {
+    this.slimSidebarAnimating = true
+    this.slimSidebarEnabled = !this.slimSidebarEnabled
+    setTimeout(() => {
+      this.slimSidebarAnimating = false
+    }, 200) // slightly longer than css animation for slim sidebar
+  }
+
+  get slimSidebarEnabled(): boolean {
+    return this.settingsService.get(SETTINGS_KEYS.SLIM_SIDEBAR)
+  }
+
+  set slimSidebarEnabled(enabled: boolean) {
+    this.settingsService.set(SETTINGS_KEYS.SLIM_SIDEBAR, enabled)
+    this.settingsService
+      .storeSettings()
+      .pipe(first())
+      .subscribe({
+        error: (error) => {
+          this.toastService.showError(
+            $localize`An error occurred while saving settings.`
+          )
+          console.log(error)
+        },
+      })
+  }
+
   closeMenu() {
     this.isMenuCollapsed = true
   }
 
-  searchField = new FormControl('')
-
   get openDocuments(): PaperlessDocument[] {
     return this.openDocumentsService.getOpenDocuments()
   }
@@ -70,6 +100,22 @@ export class AppFrameComponent implements ComponentCanDeactivate {
     return !this.openDocumentsService.hasDirty()
   }
 
+  searchField = new FormControl('')
+
+  get searchFieldEmpty(): boolean {
+    return this.searchField.value.trim().length == 0
+  }
+
+  resetSearchField() {
+    this.searchField.reset('')
+  }
+
+  searchFieldKeyup(event: KeyboardEvent) {
+    if (event.key == 'Escape') {
+      this.resetSearchField()
+    }
+  }
+
   searchAutoComplete = (text$: Observable<string>) =>
     text$.pipe(
       debounceTime(200),
@@ -150,4 +196,30 @@ export class AppFrameComponent implements ComponentCanDeactivate {
         }
       })
   }
+
+  private checkForUpdates() {
+    this.remoteVersionService
+      .checkForUpdates()
+      .subscribe((appRemoteVersion: AppRemoteVersion) => {
+        this.appRemoteVersion = appRemoteVersion
+      })
+  }
+
+  setUpdateChecking(enable: boolean) {
+    this.settingsService.set(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, enable)
+    this.settingsService
+      .storeSettings()
+      .pipe(first())
+      .subscribe({
+        error: (error) => {
+          this.toastService.showError(
+            $localize`An error occurred while saving update checking settings.`
+          )
+          console.log(error)
+        },
+      })
+    if (enable) {
+      this.checkForUpdates()
+    }
+  }
 }

src-ui/src/app/components/common/clearable-badge/clearable-badge.component.html

@@ -0,0 +1,9 @@
+<button *ngIf="active" class="position-absolute top-0 start-100 translate-middle badge bg-secondary border border-light rounded-pill p-1" title="Clear" i18n-title (click)="onClick($event)">
+    <svg *ngIf="!isNumbered && selected" width="1em" height="1em" class="check m-0 p-0 opacity-75" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+        <use xlink:href="assets/bootstrap-icons.svg#check-lg"/>
+    </svg>
+    <div *ngIf="isNumbered" class="number">{{number}}<span class="visually-hidden">selected</span></div>
+    <svg width=".9em" height="1em" class="x m-0 p-0 opacity-75" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+        <use xlink:href="assets/bootstrap-icons.svg#x-lg"/>
+    </svg>
+</button>

src-ui/src/app/components/common/clearable-badge/clearable-badge.component.scss

@@ -0,0 +1,28 @@
+.badge {
+    min-width: 20px;
+    min-height: 20px;
+}
+
+.x {
+    display: none;
+}
+
+.number {
+    min-width: 1em;
+    min-height: 1em;
+    display: inline-block;
+}
+
+button:hover {
+    .check,
+    .number {
+        opacity: 0 !important;
+    }
+
+    .x {
+        display: inline-block;
+        position: absolute;
+        top: 5px;
+        left: calc(50% - 4px);
+    }
+}

src-ui/src/app/components/common/clearable-badge/clearable-badge.component.ts

@@ -0,0 +1,33 @@
+import { Component, Input, Output, EventEmitter } from '@angular/core'
+
+@Component({
+  selector: 'app-clearable-badge',
+  templateUrl: './clearable-badge.component.html',
+  styleUrls: ['./clearable-badge.component.scss'],
+})
+export class ClearableBadge {
+  constructor() {}
+
+  @Input()
+  number: number
+
+  @Input()
+  selected: boolean
+
+  @Output()
+  cleared: EventEmitter<boolean> = new EventEmitter()
+
+  get active(): boolean {
+    return this.selected || this.number > -1
+  }
+
+  get isNumbered(): boolean {
+    return this.number > -1
+  }
+
+  onClick(event: PointerEvent) {
+    this.cleared.emit(true)
+    event.stopImmediatePropagation()
+    event.preventDefault()
+  }
+}

src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.html

@@ -16,4 +16,7 @@
         <ngb-progressbar *ngIf="!confirmButtonEnabled" style="height: 1px;" type="dark" [max]="secondsTotal" [value]="seconds"></ngb-progressbar>
         <span class="visually-hidden">{{ seconds | number: '1.0-0' }} seconds</span>
       </button>
+      <button *ngIf="alternativeBtnCaption" type="button" class="btn" [class]="alternativeBtnClass" (click)="alternative()" [disabled]="!alternativeButtonEnabled || !buttonsEnabled">
+        {{alternativeBtnCaption}}
+      </button>
     </div>

src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.ts

@@ -13,6 +13,9 @@ export class ConfirmDialogComponent {
   @Output()
   public confirmClicked = new EventEmitter()
 
+  @Output()
+  public alternativeClicked = new EventEmitter()
+
   @Input()
   title = $localize`Confirmation`
 
@@ -28,14 +31,22 @@ export class ConfirmDialogComponent {
   @Input()
   btnCaption = $localize`Confirm`
 
+  @Input()
+  alternativeBtnClass = 'btn-secondary'
+
+  @Input()
+  alternativeBtnCaption
+
   @Input()
   buttonsEnabled = true
 
   confirmButtonEnabled = true
+  alternativeButtonEnabled = true
   seconds = 0
   secondsTotal = 0
 
   confirmSubject: Subject<boolean>
+  alternativeSubject: Subject<boolean>
 
   delayConfirm(seconds: number) {
     const refreshInterval = 0.15 // s
@@ -68,4 +79,10 @@ export class ConfirmDialogComponent {
     this.confirmSubject?.next(true)
     this.confirmSubject?.complete()
   }
+
+  alternative() {
+    this.alternativeClicked.emit()
+    this.alternativeSubject?.next(true)
+    this.alternativeSubject?.complete()
+  }
 }

src-ui/src/app/components/common/date-dropdown/date-dropdown.component.html

@@ -1,11 +1,17 @@
   <div class="btn-group w-100" ngbDropdown role="group">
   <button class="btn btn-sm" id="dropdown{{title}}" ngbDropdownToggle [ngClass]="dateBefore || dateAfter ? 'btn-primary' : 'btn-outline-primary'">
     {{title}}
+    <app-clearable-badge [selected]="isActive" (cleared)="reset()"></app-clearable-badge><span class="visually-hidden">selected</span>
   </button>
   <div class="dropdown-menu date-dropdown shadow pt-0" ngbDropdownMenu attr.aria-labelledby="dropdown{{title}}">
     <div class="list-group list-group-flush">
-        <button *ngFor="let qf of quickFilters" class="list-group-item small list-goup list-group-item-action d-flex p-2 ps-3" role="menuitem" (click)="setDateQuickFilter(qf.id)">
-          {{qf.name}}
+        <button *ngFor="let rd of relativeDates" class="list-group-item small list-goup list-group-item-action d-flex p-2" role="menuitem" (click)="setRelativeDate(rd.date)">
+          <div _ngcontent-hga-c166="" class="selected-icon me-1">
+            <svg *ngIf="relativeDate === rd.date" xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" fill="currentColor" class="bi bi-check" viewBox="0 0 16 16">
+              <path d="M10.97 4.97a.75.75 0 0 1 1.07 1.05l-3.99 4.99a.75.75 0 0 1-1.08.02L4.324 8.384a.75.75 0 1 1 1.06-1.06l2.094 2.093 3.473-4.425a.267.267 0 0 1 .02-.022z"/>
+            </svg>
+          </div>
+          {{rd.name}}
         </button>
         <div class="list-group-item d-flex flex-column align-items-start" role="menuitem">
 

src-ui/src/app/components/common/date-dropdown/date-dropdown.component.scss

@@ -5,3 +5,8 @@
     line-height: 1;
   }
 }
+
+.selected-icon {
+  min-width: 1em;
+  min-height: 1em;
+}

src-ui/src/app/components/common/date-dropdown/date-dropdown.component.ts

@@ -16,12 +16,15 @@ import { ISODateAdapter } from 'src/app/utils/ngb-iso-date-adapter'
 export interface DateSelection {
   before?: string
   after?: string
+  relativeDateID?: number
 }
 
-const LAST_7_DAYS = 0
-const LAST_MONTH = 1
-const LAST_3_MONTHS = 2
-const LAST_YEAR = 3
+export enum RelativeDate {
+  LAST_7_DAYS = 0,
+  LAST_MONTH = 1,
+  LAST_3_MONTHS = 2,
+  LAST_YEAR = 3,
+}
 
 @Component({
   selector: 'app-date-dropdown',
@@ -34,11 +37,23 @@ export class DateDropdownComponent implements OnInit, OnDestroy {
     this.datePlaceHolder = settings.getLocalizedDateInputFormat()
   }
 
-  quickFilters = [
-    { id: LAST_7_DAYS, name: $localize`Last 7 days` },
-    { id: LAST_MONTH, name: $localize`Last month` },
-    { id: LAST_3_MONTHS, name: $localize`Last 3 months` },
-    { id: LAST_YEAR, name: $localize`Last year` },
+  relativeDates = [
+    {
+      date: RelativeDate.LAST_7_DAYS,
+      name: $localize`Last 7 days`,
+    },
+    {
+      date: RelativeDate.LAST_MONTH,
+      name: $localize`Last month`,
+    },
+    {
+      date: RelativeDate.LAST_3_MONTHS,
+      name: $localize`Last 3 months`,
+    },
+    {
+      date: RelativeDate.LAST_YEAR,
+      name: $localize`Last year`,
+    },
   ]
 
   datePlaceHolder: string
@@ -55,12 +70,26 @@ export class DateDropdownComponent implements OnInit, OnDestroy {
   @Output()
   dateAfterChange = new EventEmitter<string>()
 
+  @Input()
+  relativeDate: RelativeDate
+
+  @Output()
+  relativeDateChange = new EventEmitter<number>()
+
   @Input()
   title: string
 
   @Output()
   datesSet = new EventEmitter<DateSelection>()
 
+  get isActive(): boolean {
+    return (
+      this.relativeDate !== null ||
+      this.dateAfter?.length > 0 ||
+      this.dateBefore?.length > 0
+    )
+  }
+
   private datesSetDebounce$ = new Subject()
 
   private sub: Subscription
@@ -77,37 +106,33 @@ export class DateDropdownComponent implements OnInit, OnDestroy {
     }
   }
 
-  setDateQuickFilter(qf: number) {
+  reset() {
     this.dateBefore = null
-    let date = new Date()
-    switch (qf) {
-      case LAST_7_DAYS:
-        date.setDate(date.getDate() - 7)
-        break
+    this.dateAfter = null
+    this.relativeDate = null
+    this.onChange()
+  }
 
-      case LAST_MONTH:
-        date.setMonth(date.getMonth() - 1)
-        break
-
-      case LAST_3_MONTHS:
-        date.setMonth(date.getMonth() - 3)
-        break
-
-      case LAST_YEAR:
-        date.setFullYear(date.getFullYear() - 1)
-        break
-    }
-    this.dateAfter = formatDate(date, 'yyyy-MM-dd', 'en-us', 'UTC')
+  setRelativeDate(rd: RelativeDate) {
+    this.dateBefore = null
+    this.dateAfter = null
+    this.relativeDate = this.relativeDate == rd ? null : rd
     this.onChange()
   }
 
   onChange() {
-    this.dateAfterChange.emit(this.dateAfter)
     this.dateBeforeChange.emit(this.dateBefore)
-    this.datesSet.emit({ after: this.dateAfter, before: this.dateBefore })
+    this.dateAfterChange.emit(this.dateAfter)
+    this.relativeDateChange.emit(this.relativeDate)
+    this.datesSet.emit({
+      after: this.dateAfter,
+      before: this.dateBefore,
+      relativeDateID: this.relativeDate,
+    })
   }
 
   onChangeDebounce() {
+    this.relativeDate = null
     this.datesSetDebounce$.next({
       after: this.dateAfter,
       before: this.dateBefore,

src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts

@@ -2,6 +2,7 @@ import { Component } from '@angular/core'
 import { FormControl, FormGroup } from '@angular/forms'
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component'
+import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model'
 import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent'
 import { CorrespondentService } from 'src/app/services/rest/correspondent.service'
 import { ToastService } from 'src/app/services/toast.service'
@@ -31,7 +32,7 @@ export class CorrespondentEditDialogComponent extends EditDialogComponent<Paperl
   getForm(): FormGroup {
     return new FormGroup({
       name: new FormControl(''),
-      matching_algorithm: new FormControl(1),
+      matching_algorithm: new FormControl(DEFAULT_MATCHING_ALGORITHM),
       match: new FormControl(''),
       is_insensitive: new FormControl(true),
     })

src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts

@@ -2,6 +2,7 @@ import { Component } from '@angular/core'
 import { FormControl, FormGroup } from '@angular/forms'
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component'
+import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model'
 import { PaperlessDocumentType } from 'src/app/data/paperless-document-type'
 import { DocumentTypeService } from 'src/app/services/rest/document-type.service'
 import { ToastService } from 'src/app/services/toast.service'
@@ -31,7 +32,7 @@ export class DocumentTypeEditDialogComponent extends EditDialogComponent<Paperle
   getForm(): FormGroup {
     return new FormGroup({
       name: new FormControl(''),
-      matching_algorithm: new FormControl(1),
+      matching_algorithm: new FormControl(DEFAULT_MATCHING_ALGORITHM),
       match: new FormControl(''),
       is_insensitive: new FormControl(true),
     })

src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts

@@ -2,6 +2,7 @@ import { Component } from '@angular/core'
 import { FormControl, FormGroup } from '@angular/forms'
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component'
+import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model'
 import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path'
 import { StoragePathService } from 'src/app/services/rest/storage-path.service'
 import { ToastService } from 'src/app/services/toast.service'
@@ -42,7 +43,7 @@ export class StoragePathEditDialogComponent extends EditDialogComponent<Paperles
     return new FormGroup({
       name: new FormControl(''),
       path: new FormControl(''),
-      matching_algorithm: new FormControl(1),
+      matching_algorithm: new FormControl(DEFAULT_MATCHING_ALGORITHM),
       match: new FormControl(''),
       is_insensitive: new FormControl(true),
     })

src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts

@@ -6,6 +6,7 @@ import { PaperlessTag } from 'src/app/data/paperless-tag'
 import { TagService } from 'src/app/services/rest/tag.service'
 import { ToastService } from 'src/app/services/toast.service'
 import { randomColor } from 'src/app/utils/color'
+import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model'
 
 @Component({
   selector: 'app-tag-edit-dialog',
@@ -34,7 +35,7 @@ export class TagEditDialogComponent extends EditDialogComponent<PaperlessTag> {
       name: new FormControl(''),
       color: new FormControl(randomColor()),
       is_inbox_tag: new FormControl(false),
-      matching_algorithm: new FormControl(1),
+      matching_algorithm: new FormControl(DEFAULT_MATCHING_ALGORITHM),
       match: new FormControl(''),
       is_insensitive: new FormControl(true),
     })

src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.html

@@ -5,12 +5,7 @@
     </svg>
     <div class="d-none d-sm-inline">&nbsp;{{title}}</div>
     <ng-container *ngIf="!editing && selectionModel.selectionSize() > 0">
-      <div *ngIf="multiple" class="position-absolute top-0 start-100 translate-middle badge bg-secondary border border-light text-light rounded-pill">
-        {{selectionModel.totalCount}}<span class="visually-hidden">selected</span>
-      </div>
-      <div *ngIf="!multiple" class="position-absolute top-0 start-100 p-2 translate-middle badge bg-secondary border border-light rounded-circle">
-        <span class="visually-hidden">selected</span>
-      </div>
+      <app-clearable-badge [number]="multiple ? selectionModel.totalCount : undefined" [selected]="!multiple && selectionModel.selectionSize() > 0" (cleared)="reset()"></app-clearable-badge>
     </ng-container>
   </button>
   <div class="dropdown-menu py-0 shadow" ngbDropdownMenu attr.aria-labelledby="dropdown{{title}}">

src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.scss

@@ -17,25 +17,6 @@
   }
 }
 
-.btn-group-xs {
-  > .btn {
-    padding: 0.2rem 0.25rem;
-    font-size: 0.675rem;
-    line-height: 1.2;
-    border-radius: 0.15rem;
-  }
-
-  > .btn:not(:first-child) {
-    border-top-left-radius: 0;
-    border-bottom-left-radius: 0;
-  }
-
-  > .btn:not(:last-child) {
-    border-top-right-radius: 0;
-    border-bottom-right-radius: 0;
-  }
-}
-
 .btn-group > label.disabled {
   filter: brightness(0.5);
 

src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.ts

@@ -384,4 +384,9 @@ export class FilterableDropdownComponent {
       this.selectionModel.exclude(itemID)
     }
   }
+
+  reset() {
+    this.selectionModel.reset()
+    this.selectionModelChange.emit(this.selectionModel)
+  }
 }

src-ui/src/app/components/dashboard/dashboard.component.html

@@ -19,17 +19,20 @@
   </svg>
 </app-page-header>
 
-<div class='row'>
+<div class="row">
   <div class="col-lg-8">
     <ng-container *ngIf="savedViewService.loading">
       <div class="spinner-border spinner-border-sm me-2" role="status"></div>
       <ng-container i18n>Loading...</ng-container>
     </ng-container>
 
-    <app-welcome-widget *ngIf="!savedViewService.loading && savedViewService.dashboardViews.length == 0"></app-welcome-widget>
+    <app-welcome-widget *ngIf="settingsService.offerTour()" tourAnchor="tour.dashboard"></app-welcome-widget>
 
-    <ng-container *ngFor="let v of savedViewService.dashboardViews">
-      <app-saved-view-widget [savedView]="v"></app-saved-view-widget>
+    <ng-container *ngFor="let v of savedViewService.dashboardViews; first as isFirst">
+      <app-saved-view-widget *ngIf="isFirst; else noTour" [savedView]="v" tourAnchor="tour.dashboard"></app-saved-view-widget>
+      <ng-template #noTour>
+        <app-saved-view-widget [savedView]="v"></app-saved-view-widget>
+      </ng-template>
     </ng-container>
 
   </div>

src-ui/src/app/components/dashboard/dashboard.component.ts

@@ -1,5 +1,4 @@
-import { Component, OnInit } from '@angular/core'
-import { Meta } from '@angular/platform-browser'
+import { Component } from '@angular/core'
 import { SavedViewService } from 'src/app/services/rest/saved-view.service'
 import { SettingsService } from 'src/app/services/settings.service'
 
@@ -16,9 +15,9 @@ export class DashboardComponent {
 
   get subtitle() {
     if (this.settingsService.displayName) {
-      return $localize`Hello ${this.settingsService.displayName}, welcome to Paperless-ngx!`
+      return $localize`Hello ${this.settingsService.displayName}, welcome to Paperless-ngx`
     } else {
-      return $localize`Welcome to Paperless-ngx!`
+      return $localize`Welcome to Paperless-ngx`
     }
   }
 }

src-ui/src/app/components/dashboard/widgets/upload-file-widget/upload-file-widget.component.html

@@ -8,7 +8,7 @@
       </svg>
     </a>
   </div>
-  <div content>
+  <div content tourAnchor="tour.upload-widget">
     <form>
       <ngx-file-drop dropZoneLabel="Drop documents here or" browseBtnLabel="Browse files" (onFileDrop)="dropped($event)"
         (onFileOver)="fileOver($event)" (onFileLeave)="fileLeave($event)" dropZoneClassName="bg-light card"

src-ui/src/app/components/dashboard/widgets/welcome-widget/welcome-widget.component.html

@@ -1,16 +1,11 @@
-<app-widget-frame title="First steps" i18n-title>
-
-  <ng-container content>
-    <img src="assets/save-filter.png" class="float-right">
-    <p i18n>Paperless is running! :)</p>
-    <p i18n>You can start uploading documents by dropping them in the file upload box to the right or by dropping them in the configured consumption folder and they'll start showing up in the documents list.
-      After you've added some metadata to your documents, use the filtering mechanisms of paperless to create custom views (such as 'Recently added', 'Tagged TODO') and they will appear on the dashboard instead of this message.</p>
-    <p i18n>Paperless offers some more features that try to make your life easier:</p>
-    <ul>
-      <li i18n>Once you've got a couple documents in paperless and added metadata to them, paperless can assign that metadata to new documents automatically.</li>
-      <li i18n>You can configure paperless to read your mails and add documents from attached files.</li>
-    </ul>
-    <p i18n>Consult the documentation on how to use these features. The section on basic usage also has some information on how to use paperless in general.</p>
-  </ng-container>
-
-</app-widget-frame>
+<ngb-alert type="primary" [dismissible]="false">
+  <!-- [dismissible]="isFinished(status)" (closed)="dismiss(status)" -->
+  <h4 class="alert-heading"><ng-container i18n>Paperless-ngx is running!</ng-container> 🎉</h4>
+  <p i18n>You're ready to start uploading documents! Explore the various features of this web app on your own, or start a quick tour using the button below.</p>
+  <p i18n>More detail on how to use and configure Paperless-ngx is always available in the <a href="https://paperless-ngx.readthedocs.io" target="_blank">documentation</a>.</p>
+  <hr>
+  <div class="d-flex align-items-end">
+    <p class="lead fs-6 m-0"><em i18n>Thanks for being a part of the Paperless-ngx community!</em></p>
+    <button class="btn btn-primary ms-auto flex-shrink-0" (click)="tourService.start()"><ng-container i18n>Start the tour</ng-container> &rarr;</button>
+  </div>
+</ngb-alert>

src-ui/src/app/components/dashboard/widgets/welcome-widget/welcome-widget.component.ts

@@ -1,4 +1,5 @@
 import { Component, OnInit } from '@angular/core'
+import { TourService } from 'ngx-ui-tour-ng-bootstrap'
 
 @Component({
   selector: 'app-welcome-widget',
@@ -6,7 +7,7 @@ import { Component, OnInit } from '@angular/core'
   styleUrls: ['./welcome-widget.component.scss'],
 })
 export class WelcomeWidgetComponent implements OnInit {
-  constructor() {}
+  constructor(public readonly tourService: TourService) {}
 
   ngOnInit(): void {}
 }

src-ui/src/app/components/document-comments/document-comments.component.html

@@ -6,7 +6,8 @@
                 Please enter a comment.
             </div>
         </div>
-        <div class="form-group mt-2 d-flex justify-content-end">
+        <div class="form-group mt-2 d-flex justify-content-end align-items-center">
+            <div *ngIf="networkActive" class="spinner-border spinner-border-sm fw-normal me-auto" role="status"></div>
             <button type="button" class="btn btn-primary btn-sm" [disabled]="networkActive" (click)="addComment()" i18n>Add comment</button>
         </div>
     </form>

src-ui/src/app/components/document-comments/document-comments.component.ts

@@ -1,4 +1,4 @@
-import { Component, Input, OnInit } from '@angular/core'
+import { Component, Input } from '@angular/core'
 import { DocumentCommentsService } from 'src/app/services/rest/document-comments.service'
 import { PaperlessDocumentComment } from 'src/app/data/paperless-document-comment'
 import { FormControl, FormGroup } from '@angular/forms'
@@ -10,7 +10,7 @@ import { ToastService } from 'src/app/services/toast.service'
   templateUrl: './document-comments.component.html',
   styleUrls: ['./document-comments.component.scss'],
 })
-export class DocumentCommentsComponent implements OnInit {
+export class DocumentCommentsComponent {
   commentForm: FormGroup = new FormGroup({
     newComment: new FormControl(''),
   })
@@ -19,19 +19,30 @@ export class DocumentCommentsComponent implements OnInit {
   comments: PaperlessDocumentComment[] = []
   newCommentError: boolean = false
 
+  private _documentId: number
+
   @Input()
-  documentId: number
+  set documentId(id: number) {
+    if (id != this._documentId) {
+      this._documentId = id
+      this.update()
+    }
+  }
 
   constructor(
     private commentsService: DocumentCommentsService,
     private toastService: ToastService
   ) {}
 
-  ngOnInit(): void {
+  update(): void {
+    this.networkActive = true
     this.commentsService
-      .getComments(this.documentId)
+      .getComments(this._documentId)
       .pipe(first())
-      .subscribe((comments) => (this.comments = comments))
+      .subscribe((comments) => {
+        this.comments = comments
+        this.networkActive = false
+      })
   }
 
   addComment() {
@@ -45,7 +56,7 @@ export class DocumentCommentsComponent implements OnInit {
     }
     this.newCommentError = false
     this.networkActive = true
-    this.commentsService.addComment(this.documentId, comment).subscribe({
+    this.commentsService.addComment(this._documentId, comment).subscribe({
       next: (result) => {
         this.comments = result
         this.commentForm.get('newComment').reset()
@@ -61,7 +72,7 @@ export class DocumentCommentsComponent implements OnInit {
   }
 
   deleteComment(commentId: number) {
-    this.commentsService.deleteComment(this.documentId, commentId).subscribe({
+    this.commentsService.deleteComment(this._documentId, commentId).subscribe({
       next: (result) => {
         this.comments = result
         this.networkActive = false

src-ui/src/app/components/document-detail/document-detail.component.ts

@@ -337,7 +337,7 @@ export class DocumentDetailComponent
         })
       )
       .pipe(takeUntil(this.unsubscribeNotifier))
-      .subscribe(({ newStoragePath, documentTypes: storagePaths }) => {
+      .subscribe(({ newStoragePath, storagePaths }) => {
         this.storagePaths = storagePaths.results
         this.documentForm.get('storage_path').setValue(newStoragePath.id)
       })
@@ -491,7 +491,7 @@ export class DocumentDetailComponent
         .subscribe({
           next: () => {
             this.toastService.showInfo(
-              $localize`Redo OCR operation will begin in the background.`
+              $localize`Redo OCR operation will begin in the background. Close and re-open or reload this document after the operation has completed to see new content.`
             )
             if (modal) {
               modal.close()

src-ui/src/app/components/document-list/document-card-small/document-card-small.component.scss

@@ -80,7 +80,7 @@ a {
 }
 
 .tags {
-  top: 0;
+  top: .2rem;
   right: 0;
   max-width: 80%;
   row-gap: .2rem;

src-ui/src/app/components/document-list/document-list.component.html

@@ -60,14 +60,19 @@
   </div>
 
   <div class="btn-group ms-2 flex-fill" ngbDropdown role="group">
-    <button class="btn btn-sm btn-outline-primary dropdown-toggle flex-fill" ngbDropdownToggle i18n>Views</button>
+    <button class="btn btn-sm btn-outline-primary dropdown-toggle flex-fill" tourAnchor="tour.documents-views" ngbDropdownToggle>
+      <ng-container i18n>Views</ng-container>
+      <div *ngIf="savedViewIsModified" class="position-absolute top-0 start-100 p-2 translate-middle badge bg-secondary border border-light rounded-circle">
+        <span class="visually-hidden">selected</span>
+      </div>
+    </button>
     <div class="dropdown-menu shadow dropdown-menu-right" ngbDropdownMenu>
       <ng-container *ngIf="!list.activeSavedViewId">
         <button ngbDropdownItem *ngFor="let view of savedViewService.allViews" (click)="loadViewConfig(view.id)">{{view.name}}</button>
         <div class="dropdown-divider" *ngIf="savedViewService.allViews.length > 0"></div>
       </ng-container>
 
-      <button ngbDropdownItem (click)="saveViewConfig()" *ngIf="list.activeSavedViewId" i18n>Save "{{list.activeSavedViewTitle}}"</button>
+      <button ngbDropdownItem (click)="saveViewConfig()" *ngIf="list.activeSavedViewId" [disabled]="!savedViewIsModified" i18n>Save "{{list.activeSavedViewTitle}}"</button>
       <button ngbDropdownItem (click)="saveViewConfigAs()" i18n>Save as...</button>
     </div>
   </div>
@@ -79,6 +84,7 @@
   <app-bulk-editor [hidden]="!isBulkEditing"></app-bulk-editor>
 </div>
 
+
 <ng-template #pagination>
   <div class="d-flex justify-content-between align-items-center">
     <p>
@@ -96,14 +102,15 @@
   </div>
 </ng-template>
 
-<ng-container *ngTemplateOutlet="pagination"></ng-container>
+<div tourAnchor="tour.documents">
+  <ng-container *ngTemplateOutlet="pagination"></ng-container>
+</div>
 
 <ng-container *ngIf="list.error ; else documentListNoError">
   <div class="alert alert-danger" role="alert"><ng-container i18n>Error while loading documents</ng-container>: {{list.error}}</div>
 </ng-container>
 
 <ng-template #documentListNoError>
-
   <div *ngIf="displayMode == 'largeCards'">
     <app-document-card-large [selected]="list.isSelected(d)" (toggleSelected)="toggleSelected(d, $event)" *ngFor="let d of list.documents; trackBy: trackByDocumentId" [document]="d" (clickTag)="clickTag($event)" (clickCorrespondent)="clickCorrespondent($event)" (clickDocumentType)="clickDocumentType($event)" (clickStoragePath)="clickStoragePath($event)" (clickMoreLike)="clickMoreLike(d.id)">
     </app-document-card-large>

src-ui/src/app/components/document-list/document-list.component.scss

@@ -11,7 +11,7 @@ tr {
 }
 
 $paperless-card-breakpoints: (
-  0: 2, // xs
+  // 0: 2, // xs is manual for slim-sidebar
   768px: 3, //md
   992px: 4, //lg
   1200px: 5, //xl
@@ -22,6 +22,12 @@ $paperless-card-breakpoints: (
 );
 
 .row-cols-paperless-cards {
+  // xs, we dont want in .col-slim block
+  > * {
+    flex: 0 0 auto;
+    width: calc(100% / 2);
+  }
+
   @each $width, $n_cols in $paperless-card-breakpoints {
     @media(min-width: $width) {
       > * {
@@ -32,6 +38,17 @@ $paperless-card-breakpoints: (
   }
 }
 
+::ng-deep .col-slim .row-cols-paperless-cards {
+  @each $width, $n_cols in $paperless-card-breakpoints {
+    @media(min-width: $width) {
+      > * {
+        flex: 0 0 auto;
+        width: calc(100% / ($n-cols + 1)) !important;
+      }
+    }
+  }
+}
+
 .dropdown-menu-right {
   right: 0 !important;
   left: auto !important;

src-ui/src/app/components/document-list/document-list.component.ts

@@ -9,7 +9,11 @@ import {
 import { ActivatedRoute, convertToParamMap, Router } from '@angular/router'
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
 import { filter, first, map, Subject, switchMap, takeUntil } from 'rxjs'
-import { FilterRule, isFullTextFilterRule } from 'src/app/data/filter-rule'
+import {
+  FilterRule,
+  filterRulesDiffer,
+  isFullTextFilterRule,
+} from 'src/app/data/filter-rule'
 import { FILTER_FULLTEXT_MORELIKE } from 'src/app/data/filter-rule-type'
 import { PaperlessDocument } from 'src/app/data/paperless-document'
 import { PaperlessSavedView } from 'src/app/data/paperless-saved-view'
@@ -54,15 +58,36 @@ export class DocumentListComponent implements OnInit, OnDestroy {
   displayMode = 'smallCards' // largeCards, smallCards, details
 
   unmodifiedFilterRules: FilterRule[] = []
+  private unmodifiedSavedView: PaperlessSavedView
 
   private unsubscribeNotifier: Subject<any> = new Subject()
 
+  get savedViewIsModified(): boolean {
+    if (!this.list.activeSavedViewId || !this.unmodifiedSavedView) return false
+    else {
+      return (
+        this.unmodifiedSavedView.sort_field !== this.list.sortField ||
+        this.unmodifiedSavedView.sort_reverse !== this.list.sortReverse ||
+        filterRulesDiffer(
+          this.unmodifiedSavedView.filter_rules,
+          this.list.filterRules
+        )
+      )
+    }
+  }
+
   get isFiltered() {
     return this.list.filterRules?.length > 0
   }
 
   getTitle() {
-    return this.list.activeSavedViewTitle || $localize`Documents`
+    let title = this.list.activeSavedViewTitle
+    if (title && this.savedViewIsModified) {
+      title += '*'
+    } else if (!title) {
+      title = $localize`Documents`
+    }
+    return title
   }
 
   getSortFields() {
@@ -122,7 +147,7 @@ export class DocumentListComponent implements OnInit, OnDestroy {
           this.router.navigate(['404'])
           return
         }
-
+        this.unmodifiedSavedView = view
         this.list.activateSavedViewWithQueryParams(
           view,
           convertToParamMap(this.route.snapshot.queryParams)
@@ -139,13 +164,7 @@ export class DocumentListComponent implements OnInit, OnDestroy {
       .subscribe((queryParams) => {
         if (queryParams.has('view')) {
           // loading a saved view on /documents
-          this.savedViewService
-            .getCached(parseInt(queryParams.get('view')))
-            .pipe(first())
-            .subscribe((view) => {
-              this.list.activateSavedView(view)
-              this.list.reload()
-            })
+          this.loadViewConfig(parseInt(queryParams.get('view')))
         } else {
           this.list.activateSavedView(null)
           this.list.loadFromQueryParams(queryParams)
@@ -171,7 +190,8 @@ export class DocumentListComponent implements OnInit, OnDestroy {
       this.savedViewService
         .patch(savedView)
         .pipe(first())
-        .subscribe((result) => {
+        .subscribe((view) => {
+          this.unmodifiedSavedView = view
           this.toastService.showInfo(
             $localize`View "${this.list.activeSavedViewTitle}" saved successfully.`
           )
@@ -180,6 +200,17 @@ export class DocumentListComponent implements OnInit, OnDestroy {
     }
   }
 
+  loadViewConfig(viewID: number) {
+    this.savedViewService
+      .getCached(viewID)
+      .pipe(first())
+      .subscribe((view) => {
+        this.unmodifiedSavedView = view
+        this.list.activateSavedView(view)
+        this.list.reload()
+      })
+  }
+
   saveViewConfigAs() {
     let modal = this.modalService.open(SaveViewConfigDialogComponent, {
       backdrop: 'static',

src-ui/src/app/components/document-list/filter-editor/filter-editor.component.html

@@ -1,4 +1,4 @@
-<div class="row flex-wrap">
+<div class="row flex-wrap" tourAnchor="tour.documents-filter-editor">
    <div class="col mb-2 mb-xxl-0">
      <div class="form-inline d-flex align-items-center">
          <div class="input-group input-group-sm flex-fill w-auto flex-nowrap">
@@ -11,7 +11,12 @@
           <select *ngIf="textFilterTarget == 'asn'" class="form-select flex-grow-0 w-auto" [(ngModel)]="textFilterModifier" (change)="textFilterModifierChange()">
             <option *ngFor="let m of textFilterModifiers" ngbDropdownItem [value]="m.id">{{m.label}}</option>
           </select>
-          <input #textFilterInput class="form-control form-control-sm" type="text" [disabled]="textFilterModifierIsNull" [(ngModel)]="textFilter" (keyup.enter)="textFilterEnter()" [readonly]="textFilterTarget == 'fulltext-morelike'">
+          <button *ngIf="_textFilter" class="btn btn-link btn-sm px-0 position-absolute top-0 end-0 z-10" (click)="resetTextField()">
+            <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-x me-1" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+              <path fill-rule="evenodd" d="M4.646 4.646a.5.5 0 0 1 .708 0L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 0 1 0-.708z"/>
+            </svg>
+          </button>
+          <input #textFilterInput class="form-control form-control-sm" type="text" [disabled]="textFilterModifierIsNull" [(ngModel)]="textFilter" (keyup)="textFilterKeyup($event)" [readonly]="textFilterTarget == 'fulltext-morelike'">
          </div>
      </div>
   </div>
@@ -54,19 +59,21 @@
             title="Created" i18n-title
             (datesSet)="updateRules()"
             [(dateBefore)]="dateCreatedBefore"
-            [(dateAfter)]="dateCreatedAfter"></app-date-dropdown>
+            [(dateAfter)]="dateCreatedAfter"
+            [(relativeDate)]="dateCreatedRelativeDate"></app-date-dropdown>
           <app-date-dropdown class="mb-2 mb-xl-0"
+            title="Added" i18n-title
+            (datesSet)="updateRules()"
             [(dateBefore)]="dateAddedBefore"
             [(dateAfter)]="dateAddedAfter"
-            title="Added" i18n-title
-            (datesSet)="updateRules()"></app-date-dropdown>
+            [(relativeDate)]="dateAddedRelativeDate"></app-date-dropdown>
         </div>
      </div>
    </div>
    <div class="w-100 d-xxl-none"></div>
-   <div class="col col-xl-auto ps-0">
+   <div class="col col-xl-auto ps-xxl-0">
      <button class="btn btn-link btn-sm px-0" [disabled]="!rulesModified" (click)="resetSelected()">
-       <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-x me-1" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+       <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-x me-1 ms-n1" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
          <path fill-rule="evenodd" d="M4.646 4.646a.5.5 0 0 1 .708 0L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 0 1 0-.708z"/>
        </svg><ng-container i18n>Reset filters</ng-container>
      </button>

src-ui/src/app/components/document-list/filter-editor/filter-editor.component.scss

@@ -21,3 +21,7 @@
 input[type="text"] {
   min-width: 120px;
 }
+
+.z-10 {
+  z-index: 10;
+}

src-ui/src/app/components/document-list/filter-editor/filter-editor.component.ts

@@ -44,6 +44,7 @@ import { DocumentService } from 'src/app/services/rest/document.service'
 import { PaperlessDocument } from 'src/app/data/paperless-document'
 import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path'
 import { StoragePathService } from 'src/app/services/rest/storage-path.service'
+import { RelativeDate } from '../../common/date-dropdown/date-dropdown.component'
 
 const TEXT_FILTER_TARGET_TITLE = 'title'
 const TEXT_FILTER_TARGET_TITLE_CONTENT = 'title-content'
@@ -57,6 +58,27 @@ const TEXT_FILTER_MODIFIER_NOTNULL = 'not null'
 const TEXT_FILTER_MODIFIER_GT = 'greater'
 const TEXT_FILTER_MODIFIER_LT = 'less'
 
+const RELATIVE_DATE_QUERY_REGEXP_CREATED = /created:\[([^\]]+)\]/g
+const RELATIVE_DATE_QUERY_REGEXP_ADDED = /added:\[([^\]]+)\]/g
+const RELATIVE_DATE_QUERYSTRINGS = [
+  {
+    relativeDate: RelativeDate.LAST_7_DAYS,
+    dateQuery: '-1 week to now',
+  },
+  {
+    relativeDate: RelativeDate.LAST_MONTH,
+    dateQuery: '-1 month to now',
+  },
+  {
+    relativeDate: RelativeDate.LAST_3_MONTHS,
+    dateQuery: '-3 month to now',
+  },
+  {
+    relativeDate: RelativeDate.LAST_YEAR,
+    dateQuery: '-1 year to now',
+  },
+]
+
 @Component({
   selector: 'app-filter-editor',
   templateUrl: './filter-editor.component.html',
@@ -197,6 +219,8 @@ export class FilterEditorComponent implements OnInit, OnDestroy {
   dateCreatedAfter: string
   dateAddedBefore: string
   dateAddedAfter: string
+  dateCreatedRelativeDate: RelativeDate
+  dateAddedRelativeDate: RelativeDate
 
   _unmodifiedFilterRules: FilterRule[] = []
   _filterRules: FilterRule[] = []
@@ -228,6 +252,8 @@ export class FilterEditorComponent implements OnInit, OnDestroy {
     this.dateAddedAfter = null
     this.dateCreatedBefore = null
     this.dateCreatedAfter = null
+    this.dateCreatedRelativeDate = null
+    this.dateAddedRelativeDate = null
     this.textFilterModifier = TEXT_FILTER_MODIFIER_EQUALS
 
     value.forEach((rule) => {
@@ -245,8 +271,39 @@ export class FilterEditorComponent implements OnInit, OnDestroy {
           this.textFilterTarget = TEXT_FILTER_TARGET_ASN
           break
         case FILTER_FULLTEXT_QUERY:
-          this._textFilter = rule.value
-          this.textFilterTarget = TEXT_FILTER_TARGET_FULLTEXT_QUERY
+          let allQueryArgs = rule.value.split(',')
+          let textQueryArgs = []
+          allQueryArgs.forEach((arg) => {
+            if (arg.match(RELATIVE_DATE_QUERY_REGEXP_CREATED)) {
+              ;[...arg.matchAll(RELATIVE_DATE_QUERY_REGEXP_CREATED)].forEach(
+                (match) => {
+                  if (match[1]?.length) {
+                    this.dateCreatedRelativeDate =
+                      RELATIVE_DATE_QUERYSTRINGS.find(
+                        (qS) => qS.dateQuery == match[1]
+                      )?.relativeDate
+                  }
+                }
+              )
+            } else if (arg.match(RELATIVE_DATE_QUERY_REGEXP_ADDED)) {
+              ;[...arg.matchAll(RELATIVE_DATE_QUERY_REGEXP_ADDED)].forEach(
+                (match) => {
+                  if (match[1]?.length) {
+                    this.dateAddedRelativeDate =
+                      RELATIVE_DATE_QUERYSTRINGS.find(
+                        (qS) => qS.dateQuery == match[1]
+                      )?.relativeDate
+                  }
+                }
+              )
+            } else {
+              textQueryArgs.push(arg)
+            }
+          })
+          if (textQueryArgs.length) {
+            this._textFilter = textQueryArgs.join(',')
+            this.textFilterTarget = TEXT_FILTER_TARGET_FULLTEXT_QUERY
+          }
           break
         case FILTER_FULLTEXT_MORELIKE:
           this._moreLikeId = +rule.value
@@ -471,6 +528,89 @@ export class FilterEditorComponent implements OnInit, OnDestroy {
         value: this.dateAddedAfter,
       })
     }
+    if (
+      this.dateAddedRelativeDate !== null ||
+      this.dateCreatedRelativeDate !== null
+    ) {
+      let queryArgs: Array<string> = []
+      let existingRule = filterRules.find(
+        (fr) => fr.rule_type == FILTER_FULLTEXT_QUERY
+      )
+
+      // if had a title / content search and added a relative date we need to carry it over...
+      if (
+        !existingRule &&
+        this._textFilter?.length > 0 &&
+        (this.textFilterTarget == TEXT_FILTER_TARGET_TITLE_CONTENT ||
+          this.textFilterTarget == TEXT_FILTER_TARGET_TITLE)
+      ) {
+        existingRule = filterRules.find(
+          (fr) =>
+            fr.rule_type == FILTER_TITLE_CONTENT || fr.rule_type == FILTER_TITLE
+        )
+        existingRule.rule_type = FILTER_FULLTEXT_QUERY
+      }
+
+      let existingRuleArgs = existingRule?.value.split(',')
+      if (this.dateCreatedRelativeDate !== null) {
+        queryArgs.push(
+          `created:[${
+            RELATIVE_DATE_QUERYSTRINGS.find(
+              (qS) => qS.relativeDate == this.dateCreatedRelativeDate
+            ).dateQuery
+          }]`
+        )
+        if (existingRule) {
+          queryArgs = existingRuleArgs
+            .filter((arg) => !arg.match(RELATIVE_DATE_QUERY_REGEXP_CREATED))
+            .concat(queryArgs)
+        }
+      }
+      if (this.dateAddedRelativeDate !== null) {
+        queryArgs.push(
+          `added:[${
+            RELATIVE_DATE_QUERYSTRINGS.find(
+              (qS) => qS.relativeDate == this.dateAddedRelativeDate
+            ).dateQuery
+          }]`
+        )
+        if (existingRule) {
+          queryArgs = existingRuleArgs
+            .filter((arg) => !arg.match(RELATIVE_DATE_QUERY_REGEXP_ADDED))
+            .concat(queryArgs)
+        }
+      }
+
+      if (existingRule) {
+        existingRule.value = queryArgs.join(',')
+      } else {
+        filterRules.push({
+          rule_type: FILTER_FULLTEXT_QUERY,
+          value: queryArgs.join(','),
+        })
+      }
+    }
+    if (
+      this.dateCreatedRelativeDate == null &&
+      this.dateAddedRelativeDate == null
+    ) {
+      const existingRule = filterRules.find(
+        (fr) => fr.rule_type == FILTER_FULLTEXT_QUERY
+      )
+      if (
+        existingRule?.value.match(RELATIVE_DATE_QUERY_REGEXP_CREATED) ||
+        existingRule?.value.match(RELATIVE_DATE_QUERY_REGEXP_ADDED)
+      ) {
+        // remove any existing date query
+        existingRule.value = existingRule.value
+          .replace(RELATIVE_DATE_QUERY_REGEXP_CREATED, '')
+          .replace(RELATIVE_DATE_QUERY_REGEXP_ADDED, '')
+        if (existingRule.value.replace(',', '').trim() === '') {
+          // if its empty now, remove it entirely
+          filterRules.splice(filterRules.indexOf(existingRule), 1)
+        }
+      }
+    }
     return filterRules
   }
 
@@ -569,15 +709,23 @@ export class FilterEditorComponent implements OnInit, OnDestroy {
     this.updateRules()
   }
 
-  textFilterEnter() {
-    const filterString = (
-      this.textFilterInput.nativeElement as HTMLInputElement
-    ).value
-    if (filterString.length) {
-      this.updateTextFilter(filterString)
+  textFilterKeyup(event: KeyboardEvent) {
+    if (event.key == 'Enter') {
+      const filterString = (
+        this.textFilterInput.nativeElement as HTMLInputElement
+      ).value
+      if (filterString.length) {
+        this.updateTextFilter(filterString)
+      }
+    } else if (event.key == 'Escape') {
+      this.resetTextField()
     }
   }
 
+  resetTextField() {
+    this.updateTextFilter('')
+  }
+
   changeTextFilterTarget(target) {
     if (
       this.textFilterTarget == TEXT_FILTER_TARGET_FULLTEXT_MORELIKE &&

src-ui/src/app/components/document-list/popover-preview/popover-preview.scss

@@ -1,4 +1,4 @@
-::ng-deep .popover {
+::ng-deep app-document-list .popover {
   max-width: 40rem;
 
   .preview {

src-ui/src/app/components/manage/settings/settings.component.html

@@ -1,5 +1,5 @@
 <app-page-header title="Settings" i18n-title>
-
+  <button class="btn btn-sm btn-outline-primary" (click)="tourService.start()"><ng-container i18n>Start tour</ng-container></button>
 </app-page-header>
 
 <!-- <p>items per page, documents per view type</p> -->
@@ -89,6 +89,17 @@
           </div>
         </div>
 
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label">
+            <span i18n>Sidebar</span>
+          </div>
+          <div class="col">
+
+            <app-input-check i18n-title title="Use 'slim' sidebar (icons only)" formControlName="slimSidebarEnabled"></app-input-check>
+
+          </div>
+        </div>
+
         <div class="row mb-3">
           <div class="col-md-3 col-form-label">
             <span i18n>Dark mode</span>
@@ -116,6 +127,21 @@
           </div>
         </div>
 
+        <h4 class="mt-4" id="update-checking" i18n>Update checking</h4>
+
+        <div class="row mb-3">
+          <div class="offset-md-3 col">
+            <p i18n>
+              Update checking works by pinging the the public <a href="https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest" target="_blank" rel="noopener noreferrer">Github API</a> for the latest release to determine whether a new version is available.<br/>
+              Actual updating of the app must still be performed manually.
+            </p>
+            <p i18n>
+              <em>No tracking data is collected by the app in any way.</em>
+            </p>
+            <app-input-check i18n-title title="Enable update checking" formControlName="updateCheckingEnabled" i18n-hint hint="Note that for users of thirdy-party containers e.g. linuxserver.io this notification may be 'ahead' of the current third-party release."></app-input-check>
+          </div>
+        </div>
+
         <h4 class="mt-4" i18n>Bulk editing</h4>
 
         <div class="row mb-3">
@@ -194,5 +220,5 @@
 
   <div [ngbNavOutlet]="nav" class="border-start border-end border-bottom p-3 mb-3 shadow-sm"></div>
 
-  <button type="submit" class="btn btn-primary" [disabled]="!(isDirty$ | async)" i18n>Save</button>
+  <button type="submit" class="btn btn-primary mb-2" [disabled]="!(isDirty$ | async)" i18n>Save</button>
 </form>

src-ui/src/app/components/manage/settings/settings.component.ts

@@ -4,7 +4,7 @@ import {
   LOCALE_ID,
   OnInit,
   OnDestroy,
-  Renderer2,
+  AfterViewInit,
 } from '@angular/core'
 import { FormControl, FormGroup } from '@angular/forms'
 import { PaperlessSavedView } from 'src/app/data/paperless-saved-view'
@@ -16,21 +16,35 @@ import {
 } from 'src/app/services/settings.service'
 import { Toast, ToastService } from 'src/app/services/toast.service'
 import { dirtyCheck, DirtyComponent } from '@ngneat/dirty-check-forms'
-import { Observable, Subscription, BehaviorSubject, first } from 'rxjs'
+import {
+  Observable,
+  Subscription,
+  BehaviorSubject,
+  first,
+  tap,
+  takeUntil,
+  Subject,
+} from 'rxjs'
 import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings'
+import { ActivatedRoute } from '@angular/router'
+import { ViewportScroller } from '@angular/common'
+import { TourService } from 'ngx-ui-tour-ng-bootstrap'
 
 @Component({
   selector: 'app-settings',
   templateUrl: './settings.component.html',
   styleUrls: ['./settings.component.scss'],
 })
-export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
+export class SettingsComponent
+  implements OnInit, AfterViewInit, OnDestroy, DirtyComponent
+{
   savedViewGroup = new FormGroup({})
 
   settingsForm = new FormGroup({
     bulkEditConfirmationDialogs: new FormControl(null),
     bulkEditApplyOnClose: new FormControl(null),
     documentListItemPerPage: new FormControl(null),
+    slimSidebarEnabled: new FormControl(null),
     darkModeUseSystem: new FormControl(null),
     darkModeEnabled: new FormControl(null),
     darkModeInvertThumbs: new FormControl(null),
@@ -45,6 +59,7 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
     notificationsConsumerFailed: new FormControl(null),
     notificationsConsumerSuppressOnDashboard: new FormControl(null),
     commentsEnabled: new FormControl(null),
+    updateCheckingEnabled: new FormControl(null),
   })
 
   savedViews: PaperlessSavedView[]
@@ -52,7 +67,9 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
   store: BehaviorSubject<any>
   storeSub: Subscription
   isDirty$: Observable<boolean>
-  isDirty: Boolean = false
+  isDirty: boolean = false
+  unsubscribeNotifier: Subject<any> = new Subject()
+  savePending: boolean = false
 
   get computedDateLocale(): string {
     return (
@@ -62,105 +79,129 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
     )
   }
 
-  get displayLanguageIsDirty(): boolean {
-    return (
-      this.settingsForm.get('displayLanguage').value !=
-      this.store?.getValue()['displayLanguage']
-    )
-  }
-
   constructor(
     public savedViewService: SavedViewService,
     private documentListViewService: DocumentListViewService,
     private toastService: ToastService,
     private settings: SettingsService,
-    @Inject(LOCALE_ID) public currentLocale: string
-  ) {}
+    @Inject(LOCALE_ID) public currentLocale: string,
+    private viewportScroller: ViewportScroller,
+    private activatedRoute: ActivatedRoute,
+    public readonly tourService: TourService
+  ) {
+    this.settings.settingsSaved.subscribe(() => {
+      if (!this.savePending) this.initialize()
+    })
+  }
+
+  ngAfterViewInit(): void {
+    if (this.activatedRoute.snapshot.fragment) {
+      this.viewportScroller.scrollToAnchor(
+        this.activatedRoute.snapshot.fragment
+      )
+    }
+  }
+
+  private getCurrentSettings() {
+    return {
+      bulkEditConfirmationDialogs: this.settings.get(
+        SETTINGS_KEYS.BULK_EDIT_CONFIRMATION_DIALOGS
+      ),
+      bulkEditApplyOnClose: this.settings.get(
+        SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE
+      ),
+      documentListItemPerPage: this.settings.get(
+        SETTINGS_KEYS.DOCUMENT_LIST_SIZE
+      ),
+      slimSidebarEnabled: this.settings.get(SETTINGS_KEYS.SLIM_SIDEBAR),
+      darkModeUseSystem: this.settings.get(SETTINGS_KEYS.DARK_MODE_USE_SYSTEM),
+      darkModeEnabled: this.settings.get(SETTINGS_KEYS.DARK_MODE_ENABLED),
+      darkModeInvertThumbs: this.settings.get(
+        SETTINGS_KEYS.DARK_MODE_THUMB_INVERTED
+      ),
+      themeColor: this.settings.get(SETTINGS_KEYS.THEME_COLOR),
+      useNativePdfViewer: this.settings.get(
+        SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER
+      ),
+      savedViews: {},
+      displayLanguage: this.settings.getLanguage(),
+      dateLocale: this.settings.get(SETTINGS_KEYS.DATE_LOCALE),
+      dateFormat: this.settings.get(SETTINGS_KEYS.DATE_FORMAT),
+      notificationsConsumerNewDocument: this.settings.get(
+        SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT
+      ),
+      notificationsConsumerSuccess: this.settings.get(
+        SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS
+      ),
+      notificationsConsumerFailed: this.settings.get(
+        SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED
+      ),
+      notificationsConsumerSuppressOnDashboard: this.settings.get(
+        SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD
+      ),
+      commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED),
+      updateCheckingEnabled: this.settings.get(
+        SETTINGS_KEYS.UPDATE_CHECKING_ENABLED
+      ),
+    }
+  }
 
   ngOnInit() {
     this.savedViewService.listAll().subscribe((r) => {
       this.savedViews = r.results
-      let storeData = {
-        bulkEditConfirmationDialogs: this.settings.get(
-          SETTINGS_KEYS.BULK_EDIT_CONFIRMATION_DIALOGS
-        ),
-        bulkEditApplyOnClose: this.settings.get(
-          SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE
-        ),
-        documentListItemPerPage: this.settings.get(
-          SETTINGS_KEYS.DOCUMENT_LIST_SIZE
-        ),
-        darkModeUseSystem: this.settings.get(
-          SETTINGS_KEYS.DARK_MODE_USE_SYSTEM
-        ),
-        darkModeEnabled: this.settings.get(SETTINGS_KEYS.DARK_MODE_ENABLED),
-        darkModeInvertThumbs: this.settings.get(
-          SETTINGS_KEYS.DARK_MODE_THUMB_INVERTED
-        ),
-        themeColor: this.settings.get(SETTINGS_KEYS.THEME_COLOR),
-        useNativePdfViewer: this.settings.get(
-          SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER
-        ),
-        savedViews: {},
-        displayLanguage: this.settings.getLanguage(),
-        dateLocale: this.settings.get(SETTINGS_KEYS.DATE_LOCALE),
-        dateFormat: this.settings.get(SETTINGS_KEYS.DATE_FORMAT),
-        notificationsConsumerNewDocument: this.settings.get(
-          SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT
-        ),
-        notificationsConsumerSuccess: this.settings.get(
-          SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS
-        ),
-        notificationsConsumerFailed: this.settings.get(
-          SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED
-        ),
-        notificationsConsumerSuppressOnDashboard: this.settings.get(
-          SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD
-        ),
-        commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED),
+      this.initialize()
+    })
+  }
+
+  initialize() {
+    this.unsubscribeNotifier.next(true)
+
+    let storeData = this.getCurrentSettings()
+
+    for (let view of this.savedViews) {
+      storeData.savedViews[view.id.toString()] = {
+        id: view.id,
+        name: view.name,
+        show_on_dashboard: view.show_on_dashboard,
+        show_in_sidebar: view.show_in_sidebar,
       }
+      this.savedViewGroup.addControl(
+        view.id.toString(),
+        new FormGroup({
+          id: new FormControl(null),
+          name: new FormControl(null),
+          show_on_dashboard: new FormControl(null),
+          show_in_sidebar: new FormControl(null),
+        })
+      )
+    }
 
-      for (let view of this.savedViews) {
-        storeData.savedViews[view.id.toString()] = {
-          id: view.id,
-          name: view.name,
-          show_on_dashboard: view.show_on_dashboard,
-          show_in_sidebar: view.show_in_sidebar,
-        }
-        this.savedViewGroup.addControl(
-          view.id.toString(),
-          new FormGroup({
-            id: new FormControl(null),
-            name: new FormControl(null),
-            show_on_dashboard: new FormControl(null),
-            show_in_sidebar: new FormControl(null),
-          })
-        )
-      }
+    this.store = new BehaviorSubject(storeData)
 
-      this.store = new BehaviorSubject(storeData)
+    this.storeSub = this.store.asObservable().subscribe((state) => {
+      this.settingsForm.patchValue(state, { emitEvent: false })
+    })
 
-      this.storeSub = this.store.asObservable().subscribe((state) => {
-        this.settingsForm.patchValue(state, { emitEvent: false })
-      })
+    // Initialize dirtyCheck
+    this.isDirty$ = dirtyCheck(this.settingsForm, this.store.asObservable())
 
-      // Initialize dirtyCheck
-      this.isDirty$ = dirtyCheck(this.settingsForm, this.store.asObservable())
-
-      // Record dirty in case we need to 'undo' appearance settings if not saved on close
-      this.isDirty$.subscribe((dirty) => {
+    // Record dirty in case we need to 'undo' appearance settings if not saved on close
+    this.isDirty$
+      .pipe(takeUntil(this.unsubscribeNotifier))
+      .subscribe((dirty) => {
         this.isDirty = dirty
       })
 
-      // "Live" visual changes prior to save
-      this.settingsForm.valueChanges.subscribe(() => {
+    // "Live" visual changes prior to save
+    this.settingsForm.valueChanges
+      .pipe(takeUntil(this.unsubscribeNotifier))
+      .subscribe(() => {
         this.settings.updateAppearanceSettings(
           this.settingsForm.get('darkModeUseSystem').value,
           this.settingsForm.get('darkModeEnabled').value,
           this.settingsForm.get('themeColor').value
         )
       })
-    })
   }
 
   ngOnDestroy() {
@@ -179,7 +220,14 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
   }
 
   private saveLocalSettings() {
-    const reloadRequired = this.displayLanguageIsDirty // just this one, for now
+    this.savePending = true
+    const reloadRequired =
+      this.settingsForm.value.displayLanguage !=
+        this.store?.getValue()['displayLanguage'] || // displayLanguage is dirty
+      (this.settingsForm.value.updateCheckingEnabled !=
+        this.store?.getValue()['updateCheckingEnabled'] &&
+        this.settingsForm.value.updateCheckingEnabled) // update checking was turned on
+
     this.settings.set(
       SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE,
       this.settingsForm.value.bulkEditApplyOnClose
@@ -192,6 +240,10 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
       SETTINGS_KEYS.DOCUMENT_LIST_SIZE,
       this.settingsForm.value.documentListItemPerPage
     )
+    this.settings.set(
+      SETTINGS_KEYS.SLIM_SIDEBAR,
+      this.settingsForm.value.slimSidebarEnabled
+    )
     this.settings.set(
       SETTINGS_KEYS.DARK_MODE_USE_SYSTEM,
       this.settingsForm.value.darkModeUseSystem
@@ -240,10 +292,15 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent {
       SETTINGS_KEYS.COMMENTS_ENABLED,
       this.settingsForm.value.commentsEnabled
     )
+    this.settings.set(
+      SETTINGS_KEYS.UPDATE_CHECKING_ENABLED,
+      this.settingsForm.value.updateCheckingEnabled
+    )
     this.settings.setLanguage(this.settingsForm.value.displayLanguage)
     this.settings
       .storeSettings()
       .pipe(first())
+      .pipe(tap(() => (this.savePending = false)))
       .subscribe({
         next: () => {
           this.store.next(this.settingsForm.value)

src-ui/src/app/components/manage/tasks/tasks.component.html

@@ -53,8 +53,8 @@
             <label class="form-check-label" for="task{{task.id}}"></label>
           </div>
         </th>
-        <td class="overflow-auto">{{ task.name }}</td>
-        <td class="d-none d-lg-table-cell">{{ task.created | customDate:'short' }}</td>
+        <td class="overflow-auto">{{ task.task_file_name }}</td>
+        <td class="d-none d-lg-table-cell">{{ task.date_created | customDate:'short' }}</td>
         <td class="d-none d-lg-table-cell" *ngIf="activeTab != 'started' && activeTab != 'queued'">
           <div *ngIf="task.result.length > 50" class="result" (click)="expandTask(task); $event.stopPropagation();"
             [ngbPopover]="resultPopover" popoverClass="shadow small mobile" triggers="mouseenter:mouseleave" container="body">
@@ -74,11 +74,18 @@
           </button>
         </td>
         <td scope="row">
-          <button class="btn btn-sm btn-outline-secondary" (click)="dismissTask(task); $event.stopPropagation();">
-            <svg class="sidebaricon" fill="currentColor">
-              <use xlink:href="assets/bootstrap-icons.svg#check"/>
-            </svg>&nbsp;<ng-container i18n>Dismiss</ng-container>
-          </button>
+          <div class="btn-group" role="group">
+            <button class="btn btn-sm btn-outline-secondary" (click)="dismissTask(task); $event.stopPropagation();">
+              <svg class="sidebaricon" fill="currentColor">
+                <use xlink:href="assets/bootstrap-icons.svg#check"/>
+              </svg>&nbsp;<ng-container i18n>Dismiss</ng-container>
+            </button>
+            <button *ngIf="task.related_document" class="btn btn-sm btn-outline-primary" (click)="dismissAndGo(task); $event.stopPropagation();">
+              <svg class="sidebaricon" fill="currentColor">
+                <use xlink:href="assets/bootstrap-icons.svg#file-text"/>
+              </svg>&nbsp;<ng-container i18n>Open Document</ng-container>
+            </button>
+          </div>
         </td>
       </tr>
       <tr>

src-ui/src/app/components/manage/tasks/tasks.component.ts

@@ -1,6 +1,7 @@
 import { Component, OnInit, OnDestroy } from '@angular/core'
+import { Router } from '@angular/router'
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
-import { takeUntil, Subject, first } from 'rxjs'
+import { Subject, first } from 'rxjs'
 import { PaperlessTask } from 'src/app/data/paperless-task'
 import { TasksService } from 'src/app/services/tasks.service'
 import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
@@ -24,7 +25,8 @@ export class TasksComponent implements OnInit, OnDestroy {
 
   constructor(
     public tasksService: TasksService,
-    private modalService: NgbModal
+    private modalService: NgbModal,
+    private readonly router: Router
   ) {}
 
   ngOnInit() {
@@ -64,6 +66,11 @@ export class TasksComponent implements OnInit, OnDestroy {
     }
   }
 
+  dismissAndGo(task: PaperlessTask) {
+    this.dismissTask(task)
+    this.router.navigate(['documents', task.related_document])
+  }
+
   expandTask(task: PaperlessTask) {
     this.expandedTask = this.expandedTask == task.id ? undefined : task.id
   }

src-ui/src/app/data/matching-model.ts

@@ -6,6 +6,7 @@ export const MATCH_LITERAL = 3
 export const MATCH_REGEX = 4
 export const MATCH_FUZZY = 5
 export const MATCH_AUTO = 6
+export const DEFAULT_MATCHING_ALGORITHM = MATCH_AUTO
 
 export const MATCHING_ALGORITHMS = [
   {

src-ui/src/app/data/paperless-document.ts

@@ -29,8 +29,6 @@ export interface PaperlessDocument extends ObjectWithId {
 
   content?: string
 
-  file_type?: string
-
   tags$?: Observable<PaperlessTag[]>
 
   tags?: number[]
@@ -47,7 +45,7 @@ export interface PaperlessDocument extends ObjectWithId {
 
   added?: Date
 
-  file_name?: string
+  original_file_name?: string
 
   download_url?: string
 

src-ui/src/app/data/paperless-task.ts

@@ -6,11 +6,10 @@ export enum PaperlessTaskType {
 }
 
 export enum PaperlessTaskStatus {
-  Queued = 'queued',
-  Started = 'started',
-  Complete = 'complete',
-  Failed = 'failed',
-  Unknown = 'unknown',
+  Pending = 'PENDING',
+  Started = 'STARTED',
+  Complete = 'SUCCESS',
+  Failed = 'FAILURE',
 }
 
 export interface PaperlessTask extends ObjectWithId {
@@ -22,11 +21,13 @@ export interface PaperlessTask extends ObjectWithId {
 
   task_id: string
 
-  name: string
+  task_file_name: string
 
-  created: Date
+  date_created: Date
 
-  started?: Date
+  done?: Date
 
   result: string
+
+  related_document?: number
 }

src-ui/src/app/data/paperless-uisettings.ts

@@ -37,6 +37,10 @@ export const SETTINGS_KEYS = {
   NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD:
     'general-settings:notifications:consumer-suppress-on-dashboard',
   COMMENTS_ENABLED: 'general-settings:comments-enabled',
+  SLIM_SIDEBAR: 'general-settings:slim-sidebar',
+  UPDATE_CHECKING_ENABLED: 'general-settings:update-checking:enabled',
+  UPDATE_CHECKING_BACKEND_SETTING:
+    'general-settings:update-checking:backend-setting',
 }
 
 export const SETTINGS: PaperlessUiSetting[] = [
@@ -55,6 +59,11 @@ export const SETTINGS: PaperlessUiSetting[] = [
     type: 'boolean',
     default: false,
   },
+  {
+    key: SETTINGS_KEYS.SLIM_SIDEBAR,
+    type: 'boolean',
+    default: false,
+  },
   {
     key: SETTINGS_KEYS.DOCUMENT_LIST_SIZE,
     type: 'number',
@@ -120,4 +129,14 @@ export const SETTINGS: PaperlessUiSetting[] = [
     type: 'boolean',
     default: true,
   },
+  {
+    key: SETTINGS_KEYS.UPDATE_CHECKING_ENABLED,
+    type: 'boolean',
+    default: false,
+  },
+  {
+    key: SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING,
+    type: 'string',
+    default: '',
+  },
 ]