fix wording

Ensure that no source files have trailing whitespace at end of lines and ensure that all files end with a single trailing newline.

This also adds Github Actions to enforce whitespace conventions.

.env

@@ -1 +1 @@
-COMPOSE_PROJECT_NAME=paperless
+COMPOSE_PROJECT_NAME=paperless

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+name: Bug report
+about: Something is not working
+title: "[BUG] Concise description of the issue"
+labels: ''
+assignees: ''
+
+---
+
+<!---
+=> Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ng.readthedocs.io/en/latest/troubleshooting.html
+=> Please also make sure that you followed the installation instructions.
+=> Please search the issues and look for similar issues before opening a bug report.
+
+=> If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests
+
+=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably an issue with your system, and not an issue of paperless.
+
+=> Don't remove the [BUG] prefix from the title.
+-->
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Webserver logs**
+```
+If available, post any logs from the web server related to your issue.
+```
+
+**Relevant information**
+ - Host OS of the machine running paperless: [e.g. Archlinux / Ubuntu 20.04]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 1.0.0]
+ - Installation method: [docker / bare metal]
+ - Any configuration changes you made in `docker-compose.yml`, `docker-compose.env` or `paperless.conf`.

.github/ISSUE_TEMPLATE/other.md

@@ -0,0 +1,20 @@
+---
+name: Other
+about: Anything that is not a feature request or bug.
+title: "[Other] Title of your issue"
+labels: ''
+assignees: ''
+
+---
+
+<!--
+
+=> Discussions, Feedback and other suggestions belong in the "Discussion" section and not on the issue tracker.
+
+=> If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests
+
+=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably is an issue with your system, and not an issue of paperless.
+
+=> Don't remove the [Other] prefix from the title.
+
+-->

.github/workflow-scripts/check-trailing-newline

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# Verify that all text files end in a trailing newline.
+
+# Exit on first failing command.
+set -e
+
+# Exit on unset variable.
+set -u
+
+success=0
+
+function is_plaintext_file() {
+  local file="$1"
+  if [[ $file == *.svg ]]; then
+    echo ""
+    return
+  fi
+  file --brief "${file}" | grep text
+}
+
+# Split strings on newlines.
+IFS='
+'
+for file in $(git ls-files)
+do
+  if [[ -z $(is_plaintext_file "${file}") ]]; then
+    continue
+  fi
+
+  if ! [[ -z "$(tail -c 1 "${file}")" ]]; then
+    printf "File must end in a trailing newline: %s\n" "${file}" >&2
+    success=255
+  fi
+done
+
+exit "${success}"

.github/workflow-scripts/check-trailing-whitespace

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Check for trailing whitespace at end of lines.
+
+# Exit on first failing command.
+set -e
+# Exit on unset variable.
+set -u
+
+FOUND_TRAILING_WHITESPACE=0
+
+while read -r line; do
+  if grep \
+    "\s$" \
+    --line-number \
+    --with-filename \
+    --binary-files=without-match \
+    --exclude="*.svg" \
+    --exclude="*.eps" \
+    "${line}"; then
+    echo "ERROR: Found trailing whitespace" >&2;
+    FOUND_TRAILING_WHITESPACE=1
+  fi
+done < <(git ls-files)
+
+exit "${FOUND_TRAILING_WHITESPACE}"

.github/workflows/ansible.yml

@@ -1,19 +1,32 @@
 ---
 name: Ansible Role
 
-on: [push, pull_request]
+on:
+  push:
+    branches-ignore:
+      - 'translations**'
+  pull_request:
+    branches-ignore:
+      - 'translations**'
 
 jobs:
   # https://molecule.readthedocs.io/en/latest/ci.html#github-actions
   test:
     runs-on: ubuntu-latest
-    # https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#github-context
-    if: github.event_name == 'pull_request' || (github.event_name == 'push' && contains(github.ref, 'refs/heads/'))
     steps:
       - name: Check out the codebase
         uses: actions/checkout@v2
+        if: github.event_name != 'pull_request'
         with:
           path: "${{ github.repository }}"
+      - name: Check out the codebase
+        uses: actions/checkout@v2
+        if: github.event_name == 'pull_request'
+        with:
+          # merge commit is not available from tree at this point in time
+          # https://github.com/actions/checkout#checkout-pull-request-head-commit-instead-of-merge-commit
+          ref: "${{ github.event.pull_request.head.sha }}"
+          path: "${{ github.repository }}"
       - name: Set up Python
         uses: actions/setup-python@v2
       - name: Set up Docker
@@ -21,16 +34,22 @@ jobs:
       - name: Install dependencies
         run: |
           python3 -m pip install --upgrade pip
-          python3 -m pip install molecule[ansible,docker]
+          python3 -m pip install molecule[ansible,docker] jmespath
           ansible --version
           docker --version
           molecule --version
           python --version
-      - name: Test with molecule
+      - name: Test installation/build/upgrade with molecule
         run: |
           cd ansible
-          molecule test
+          molecule create
+          molecule verify
+          molecule converge
+          molecule idempotence
+          molecule verify
         working-directory: "${{ github.repository }}"
+        env:
+          TARGET_GITHUB_SHA: "${{ github.event.pull_request.head.sha }}"
   # # https://galaxy.ansible.com/docs/contributing/importing.html
   # release:
   #   runs-on: ubuntu-latest

.github/workflows/ci.yml

@@ -1,6 +1,13 @@
 name: ci
 
-on: [push, pull_request]
+on:
+  push:
+    tags: ng-*
+    branches-ignore:
+      - 'translations**'
+  pull_request:
+    branches-ignore:
+      - 'translations**'
 
 jobs:
   documentation:
@@ -13,7 +20,7 @@ jobs:
         name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.7
       -
         name: Get pip cache dir
         id: pip-cache
@@ -28,8 +35,6 @@ jobs:
       -
         name: Install dependencies
         run: |
-          sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends libpoppler-cpp-dev
           pip install --upgrade pipenv
           pipenv install --system --dev --ignore-pipfile
       -
@@ -44,11 +49,58 @@ jobs:
           name: documentation
           path: docs/_build/html/
 
+  codestyle:
+    runs-on: ubuntu-20.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      -
+        name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+      -
+        name: Persistent Github pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip${{ matrix.python-version }}
+      -
+        name: Install dependencies
+        run: |
+          pip install --upgrade pipenv
+          pipenv install --system --dev --ignore-pipfile
+      -
+        name: Codestyle
+        run: |
+          cd src/
+          pycodestyle
+  whitespace:
+    runs-on: ubuntu-20.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Ensure there are no trailing spaces
+        run: |
+          .github/workflow-scripts/check-trailing-whitespace
+      -
+        name: Ensure all text files end with a trailing newline
+        run: |
+          .github/workflow-scripts/check-trailing-whitespace
+
   tests:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8']
+        python-version: ['3.6', '3.7', '3.8', '3.9']
       fail-fast: false
     steps:
       -
@@ -71,10 +123,10 @@ jobs:
           path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-pip${{ matrix.python-version }}
       -
-        name: Prepare tests
+        name: Install dependencies
         run: |
           sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends libpoppler-cpp-dev unpaper tesseract-ocr imagemagick ghostscript optipng
+          sudo apt-get install -qq --no-install-recommends unpaper tesseract-ocr imagemagick ghostscript optipng
           pip install --upgrade pipenv
           pipenv install --system --dev --ignore-pipfile
       -
@@ -82,11 +134,6 @@ jobs:
         run: |
           cd src/
           pytest
-      -
-        name: Codestyle
-        run: |
-          cd src/
-          pycodestyle
       -
         name: Publish coverage results
         if: matrix.python-version == '3.8'
@@ -107,6 +154,13 @@ jobs:
       uses: actions/setup-node@v2
       with:
         node-version: '15'
+    -
+      name: Configure version on dev branches
+      if: startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev'
+      run: |
+        git_hash=$(git rev-parse --short "$GITHUB_SHA")
+        git_branch=${GITHUB_REF#refs/heads/}
+        sed -i -E "s/version: \"(.*)\"/version: \"${git_branch} ${git_hash}\"/g" src-ui/src/environments/environment.prod.ts
     -
       name: Build frontend
       run: ./compile-frontend.sh
@@ -118,7 +172,7 @@ jobs:
         path: src/documents/static/frontend/
 
   build-release:
-    needs: [frontend, documentation, tests]
+    needs: [frontend, documentation, tests, whitespace, codestyle]
     runs-on: ubuntu-20.04
     steps:
       -
@@ -133,7 +187,7 @@ jobs:
         name: Install dependencies
         run: |
           sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends libpoppler-cpp-dev gettext liblept5
+          sudo apt-get install -qq --no-install-recommends gettext liblept5
           pip3 install -r requirements.txt
       -
         name: Download frontend artifact
@@ -155,6 +209,7 @@ jobs:
           mkdir dist/paperless-ng/scripts
           cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ng/
           cp paperless.conf.example dist/paperless-ng/paperless.conf
+          cp gunicorn.conf.py dist/paperless-ng/gunicorn.conf.py
           cp docker/ dist/paperless-ng/docker -r
           cp scripts/*.service scripts/*.sh dist/paperless-ng/scripts/
           cp src/ dist/paperless-ng/src -r
@@ -208,7 +263,7 @@ jobs:
           tag_name: ng-${{ steps.get_version.outputs.version }}
           release_name: Paperless-ng ${{ steps.get_version.outputs.version }}
           draft: false
-          prerelease: true
+          prerelease: false
           body: |
             For a complete list of changes, see the changelog at https://paperless-ng.readthedocs.io/en/latest/changelog.html.
       -
@@ -225,23 +280,26 @@ jobs:
 
   # build and push image to docker hub.
   build-docker-image:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/ng-'))
+    if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/ng-'))
     runs-on: ubuntu-latest
-    needs: [frontend, tests]
+    needs: [frontend, tests, whitespace, codestyle]
     steps:
       -
         name: Prepare
         id: prepare
         run: |
-          VERSION=edge
+          IMAGE_NAME=jonaswinkler/paperless-ng
           if [[ $GITHUB_REF == refs/tags/ng-* ]]; then
-            VERSION=${GITHUB_REF#refs/tags/ng-}
-          elif [[ $GITHUB_REF == refs/heads/master ]]; then
-            VERSION=latest
+            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/tags/ng-},${IMAGE_NAME}:latest
+            INSPECT_TAG=${IMAGE_NAME}:latest
           elif [[ $GITHUB_REF == refs/heads/* ]]; then
-            VERSION=${GITHUB_REF#refs/heads/}
+            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/heads/}
+            INSPECT_TAG=${TAGS}
+          else
+            exit 1
           fi
-          echo ::set-output name=version::${VERSION}
+          echo ::set-output name=tags::${TAGS}
+          echo ::set-output name=inspect_tag::${INSPECT_TAG}
       -
         name: Checkout
         uses: actions/checkout@v2
@@ -279,10 +337,10 @@ jobs:
           file: ./Dockerfile
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: true
-          tags: jonaswinkler/paperless-ng:${{ steps.prepare.outputs.version }}
+          tags: ${{ steps.prepare.outputs.tags }}
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
       -
         name: Inspect image
         run: |
-          docker buildx imagetools inspect jonaswinkler/paperless-ng:${{ steps.prepare.outputs.version }}
+          docker buildx imagetools inspect ${{ steps.prepare.outputs.inspect_tag }}

CONTRIBUTING.md

@@ -9,11 +9,11 @@ If you want to implement something big: Please start a discussion about that in
 
 ## Python
 
-Use python 3.6 for development. Paperless supports python 3.6, 3.7 and 3.8.
+Paperless supports python 3.6, 3.7, 3.8 and 3.9.
 
 ## Branches
 
-master always reflects the latest release.
+master always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases.
 
 dev contains all changes that will be part of the next release. Use this branch to start making your changes.
 

Dockerfile

@@ -10,36 +10,40 @@ RUN ./configure && make
 
 FROM python:3.7-slim
 
-WORKDIR /usr/src/paperless/
-
-COPY requirements.txt ./
-
 # Binary dependencies
 RUN apt-get update \
-  && apt-get -y --no-install-recommends install \
+	&& apt-get -y --no-install-recommends install \
   	# Basic dependencies
 		curl \
-		file \
-		# fonts for text file thumbnail generation
-		fonts-liberation \
-		# for making translations further down
-		gettext \
 		gnupg \
 		imagemagick \
+		gettext \
+		tzdata \
+		gosu \
+		# fonts for text file thumbnail generation
+		fonts-liberation \
 		# for Numpy
 		libatlas-base-dev \
 		libxslt1-dev \
-		mime-support \
 		# thumbnail size reduction
 		optipng \
-		sudo \
-		tzdata \
-  	# OCRmyPDF dependencies
-		ghostscript \
-		icc-profiles-free \
-		liblept5 \
 		libxml2 \
 		pngquant \
+		unpaper \
+		zlib1g \
+		ghostscript \
+		icc-profiles-free \
+  && echo "deb http://deb.debian.org/debian bullseye main" > /etc/apt/sources.list.d/bullseye.list \
+  && apt-get update \
+  && apt-get -y --no-install-recommends install \
+		# fixes sudo / gosu issues
+		libseccomp2 \
+		# Mime type detection
+		file \
+		libmagic-dev \
+		media-types \
+  		# OCRmyPDF dependencies
+		liblept5 \
 		qpdf \
 		tesseract-ocr \
 		tesseract-ocr-eng \
@@ -47,60 +51,55 @@ RUN apt-get update \
 		tesseract-ocr-fra \
 		tesseract-ocr-ita \
 		tesseract-ocr-spa \
-		unpaper \
-		zlib1g \
-		&& rm -rf /var/lib/apt/lists/*
-
-# This pulls in updated dependencies from bullseye to fix some issues with file type detection.
-# TODO: Remove this once bullseye releases.
-RUN echo "deb http://deb.debian.org/debian bullseye main" > /etc/apt/sources.list.d/bullseye.list \
-  && apt-get update \
-  && apt-get install --no-install-recommends -y file libmagic-dev \
-  && rm -rf /var/lib/apt/lists/* \
-  && rm /etc/apt/sources.list.d/bullseye.list
-
-# Python dependencies
-RUN apt-get update \
-  && apt-get -y --no-install-recommends install \
-		build-essential \
-		libpoppler-cpp-dev \
-		libpq-dev \
-		libqpdf-dev \
-	&& python3 -m pip install --upgrade --no-cache-dir supervisor \
-  && python3 -m pip install --no-cache-dir -r requirements.txt \
-	&& apt-get -y purge build-essential libqpdf-dev \
-	&& apt-get -y autoremove --purge \
-	&& rm -rf /var/lib/apt/lists/* \
-	&& mkdir /var/log/supervisord /var/run/supervisord
-
-
-# copy scripts
-# this fixes issues with imagemagick and PDF
-COPY docker/imagemagick-policy.xml /etc/ImageMagick-6/policy.xml
-COPY docker/gunicorn.conf.py ./
-COPY docker/supervisord.conf /etc/supervisord.conf
-COPY docker/docker-entrypoint.sh /sbin/docker-entrypoint.sh
+  && rm -rf /var/lib/apt/lists/*
 
 # copy jbig2enc
 COPY --from=jbig2enc /usr/src/jbig2enc/src/.libs/libjbig2enc* /usr/local/lib/
 COPY --from=jbig2enc /usr/src/jbig2enc/src/jbig2 /usr/local/bin/
 COPY --from=jbig2enc /usr/src/jbig2enc/src/*.h /usr/local/include/
 
+WORKDIR /usr/src/paperless/src/
+
+COPY requirements.txt ../
+
+# Python dependencies
+RUN apt-get update \
+  && apt-get -y --no-install-recommends install \
+		build-essential \
+		libpq-dev \
+		libqpdf-dev \
+	&& python3 -m pip install --upgrade --no-cache-dir supervisor \
+  && python3 -m pip install --no-cache-dir -r ../requirements.txt \
+	&& apt-get -y purge build-essential libqpdf-dev \
+	&& apt-get -y autoremove --purge \
+	&& rm -rf /var/lib/apt/lists/*
+
+# setup docker-specific things
+COPY docker/ ./docker/
+
+RUN cd docker \
+  && cp imagemagick-policy.xml /etc/ImageMagick-6/policy.xml \
+	&& mkdir /var/log/supervisord /var/run/supervisord \
+	&& cp supervisord.conf /etc/supervisord.conf \
+	&& cp docker-entrypoint.sh /sbin/docker-entrypoint.sh \
+	&& cp docker-prepare.sh /sbin/docker-prepare.sh \
+	&& chmod 755 /sbin/docker-entrypoint.sh \
+	&& chmod +x install_management_commands.sh \
+	&& ./install_management_commands.sh \
+	&& cd .. \
+	&& rm docker -rf
+
+COPY gunicorn.conf.py ../
 
 # copy app
-COPY src/ ./src/
+COPY src/ ./
 
 # add users, setup scripts
 RUN addgroup --gid 1000 paperless \
 	&& useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
-	&& chown -R paperless:paperless . \
-	&& chmod 755 /sbin/docker-entrypoint.sh
-
-WORKDIR /usr/src/paperless/src/
-
-RUN sudo -HEu paperless python3 manage.py collectstatic --clear --no-input
-
-RUN sudo -HEu paperless python3 manage.py compilemessages
+	&& chown -R paperless:paperless ../ \
+	&& gosu paperless python3 manage.py collectstatic --clear --no-input \
+	&& gosu paperless python3 manage.py compilemessages
 
 VOLUME ["/usr/src/paperless/data", "/usr/src/paperless/media", "/usr/src/paperless/consume", "/usr/src/paperless/export"]
 ENTRYPOINT ["/sbin/docker-entrypoint.sh"]

Pipfile

@@ -9,38 +9,50 @@ verify_ssl = true
 name = "piwheels"
 
 [packages]
-dateparser = "~=0.7.6"
-django = "~=3.1.3"
+dateparser = "~=1.0.0"
+django = "~=3.2"
 django-cors-headers = "*"
 django-extensions = "*"
 django-filter = "~=2.4.0"
 django-q = "~=1.3.4"
 djangorestframework = "~=3.12.2"
 filelock = "*"
-fuzzywuzzy = "*"
+fuzzywuzzy = {extras = ["speedup"], version = "*"}
 gunicorn = "*"
 imap-tools = "*"
 langdetect = "*"
-pdftotext = "*"
+# numpy 1.20.0 drops python 3.6 support
+numpy = "~=1.19.5"
 pathvalidate = "*"
-# pinned to 8.1.0, since aarch64 wheels might not be available beyond that https://github.com/python-pillow/Pillow/issues/5202
-pillow = "==8.1.0"
-pikepdf = "~=2.2.5"
+pillow = "~=8.1"
+pikepdf = "~=2.5"
 python-gnupg = "*"
 python-dotenv = "*"
 python-dateutil = "*"
-python-Levenshtein = "*"
 python-magic = "*"
 psycopg2-binary = "*"
 redis = "*"
-scikit-learn="~=0.24.0"
+# Pinned because aarch64 wheels and updates cause warnings when loading the classifier model.
+scikit-learn="==0.24.0"
+# Prevent scipy updates because 1.6 is incompatible with python 3.6
+scipy="~=1.5.4"
 whitenoise = "~=5.2.0"
-watchdog = "*"
+watchdog = "~=1.0.0"
 whoosh="~=2.7.4"
 inotifyrecursive = "~=0.3.4"
-ocrmypdf = "~=11.4.5"
+ocrmypdf = "~=12.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 = "*"
+uvicorn = {extras = ["standard"], version = "*"}
+concurrent-log-handler = "*"
+# uvloop 0.15+ incompatible with python 3.6
+uvloop = "~=0.14.0"
+cryptography = "~=3.4"
+"pdfminer.six" = "*"
 
 [dev-packages]
 coveralls = "*"

README.md

@@ -1,4 +1,6 @@
-![ci](https://github.com/jonaswinkler/paperless-ng/workflows/ci/badge.svg)
+[![ci](https://github.com/jonaswinkler/paperless-ng/workflows/ci/badge.svg)](https://github.com/jonaswinkler/paperless-ng/actions)
+![Ansible Role](https://github.com/jonaswinkler/paperless-ng/workflows/Ansible%20Role/badge.svg)
+[![Crowdin](https://badges.crowdin.net/paperless-ng/localized.svg)](https://crowdin.com/project/paperless-ng)
 [![Documentation Status](https://readthedocs.org/projects/paperless-ng/badge/?version=latest)](https://paperless-ng.readthedocs.io/en/latest/?badge=latest)
 [![Gitter](https://badges.gitter.im/paperless-ng/community.svg)](https://gitter.im/paperless-ng/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Docker Hub Pulls](https://img.shields.io/docker/pulls/jonaswinkler/paperless-ng.svg)](https://hub.docker.com/r/jonaswinkler/paperless-ng)
@@ -6,11 +8,16 @@
 
 # Paperless-ng
 
-[Paperless](https://github.com/the-paperless-project/paperless) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.
+[Paperless (click me)](https://github.com/the-paperless-project/paperless) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.
 
-Paperless-ng is a fork of the original project, adding a new interface and many other changes under the hood. For a detailed list of changes, have a look at the changelog in the documentation.
+Paperless-ng is a fork of the original project, adding a new interface and many other changes under the hood. These key points should help you decide whether Paperless-ng is something you would prefer over Paperless:
 
-This project is still in development and some things may not work as expected.
+* Interface: The new front end is the main interface for Paperless-ng, the old interface still exists but most customizations (such as thumbnails for the document list) have been removed.0
+* Encryption: Paperless-ng does not support GnuPG anymore, since storing your data on encrypted file systems (that you optionally mount on demand) achieves about the same result.
+* Resource usage: Paperless-ng does use a bit more resources than Paperless. Running the web server requires about 300MB of RAM or more, depending on the configuration. While adding documents, it requires about 300MB additional RAM, depending on the document. It still runs on Raspberry Pi (many users do that), but it has been generally geared to better use the resources of more powerful systems.
+* API changes: If you rely on the REST API of paperless, some of its functionality has been changed.
+
+For a detailed list of changes, have a look at the [change log](https://paperless-ng.readthedocs.io/en/latest/changelog.html) in the documentation, especially the section about the [0.9.0 release](https://paperless-ng.readthedocs.io/en/latest/changelog.html#paperless-ng-0-9-0).
 
 # How it Works
 
@@ -18,7 +25,7 @@ Paperless does not control your scanner, it only helps you deal with what your s
 
 1. Buy a document scanner that can write to a place on your network.  If you need some inspiration, have a look at the [scanner recommendations](https://paperless-ng.readthedocs.io/en/latest/scanners.html) page. Set it up to "scan to FTP" or something similar. It should be able to push scanned images to a server without you having to do anything.  Of course if your scanner doesn't know how to automatically upload the file somewhere, you can always do that manually. Paperless doesn't care how the documents get into its local consumption directory.
 
-	- Alternatively, you can use any of the mobile scanning apps out there. We have an app that allows you to share documents with paperless, if you're on Android. See the section on affiliated projects.
+	- Alternatively, you can use any of the mobile scanning apps out there. We have an app that allows you to share documents with paperless, if you're on Android. See the section on affiliated projects below.
 
 2. Wait for paperless to process your files. OCR is expensive, and depending on the power of your machine, this might take a bit of time.
 3. Use the web frontend to sift through the database and find what you want.
@@ -28,11 +35,15 @@ Here's what you get:
 
 ![Dashboard](https://github.com/jonaswinkler/paperless-ng/raw/master/docs/_static/screenshots/dashboard.png)
 
+If you want to see paperless-ng in action, [more screenshots are available in the documentation](https://paperless-ng.readthedocs.io/en/latest/screenshots.html).
+
 # Features
 
 * Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
-* Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and can be configured freely.
-* Single page application front end. Should be pretty snappy. Will be mobile friendly in the future.
+* Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
+	* Office document support is optional and provided by Apache Tika (see [configuration](https://paperless-ng.readthedocs.io/en/latest/configuration.html#tika-settings))
+* Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
+* Single page application front end.
 	* Includes a dashboard that shows basic statistics and has document upload.
 	* Filtering by tags, correspondents, types, and more.
 	* Customizable views can be saved and displayed on the dashboard.
@@ -43,47 +54,11 @@ Here's what you get:
 	* Searching for similar documents ("More like this")
 * Email processing: Paperless adds documents from your email accounts.
 	* Configure multiple accounts and filters for each account.
-	* When adding documents from mails, paperless can move these mails to a new folder, mark them as read, flag them or delete them.
+	* When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
 * Machine learning powered document matching.
 	* Paperless learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
-* A task processor that processes documents in parallel and also tells you when something goes wrong. On modern multi core systems, consumption is blazing fast.
-
-If you want to see some screenshots of paperless-ng in action, [some are available in the documentation](https://paperless-ng.readthedocs.io/en/latest/screenshots.html).
-
-For a complete list of changes from paperless, check out the [changelog](https://paperless-ng.readthedocs.io/en/latest/changelog.html)
-
-# Roadmap for 1.0
-
-- Make the front end nice (except mobile).
-- Fix whatever bugs I and you find.
-- Make the documentation nice.
-
-## Roadmap for versions beyond 1.0
-
-These are things that I want to add to paperless eventually. They are sorted by priority.
-
-- **More search.** The search backend is incredibly versatile and customizable. Searching is the most important feature of this project and thus, I want to implement things like:
-  - Group and limit search results by correspondent, show “more from this” links in the results.
-- **Nested tags**. Organize tags in a hierarchical structure. This will combine the benefits of folders and tags in one coherent system.
-- **An interactive consumer** that shows its progress for documents it processes on the web page.
-	- With live updates and websockets. This already works on a dev branch, but requires a lot of new dependencies, which I'm not particularly happy about.
-	- Notifications when a document was added with buttons to open the new document right away.
-- **Arbitrary tag colors**. Allow the selection of any color with a color picker.
-
-Apart from that, paperless is pretty much feature complete.
-
-## On the chopping block.
-
-- **GnuPG encrypion.** [Here's a note about encryption in paperless](https://paperless-ng.readthedocs.io/en/latest/administration.html#managing-encryption). The gist of it is that I don't see which attacks this implementation protects against. It gives a false sense of security to users who don't care about how it works.
-
-## Wont-do list.
-
-These features will probably never make it into paperless, since paperless is meant to be an easy to use set-and-forget solution.
-
-- **Document versions.** I might consider adding the ability to update a document with a newer version, but that's about it. The kind of documents that get added to paperless usually don't change at all.
-- **Workflows.** I don't see a use case for these, yet.
-- **Folders.** Tags are superior in just about every way.
-- **Apps / extension support.** Again, paperless is meant to be simple.
+* Optimized for multi core systems: Paperless-ng consumes multiple documents in parallel.
+* The integrated sanity checker makes sure that your document archive is in good health.
 
 # Getting started
 
@@ -91,11 +66,11 @@ The recommended way to deploy paperless is docker-compose. The files in the /doc
 
 Read the [documentation](https://paperless-ng.readthedocs.io/en/latest/setup.html#installation) on how to get started.
 
-Alternatively, you can install the dependencies and setup apache and a database server yourself. The documenation has a step by step guide on how to do it.
+Alternatively, you can install the dependencies and setup apache and a database server yourself. The documenation has a step by step guide on how to do it. Consider giving the Ansible role a shot, this essentially automates the entire bare metal installation process.
 
-# Migrating to paperless-ng
+# Migrating from Paperless to Paperless-ng
 
-Read the section about [migration](https://paperless-ng.readthedocs.io/en/latest/setup.html#migration-to-paperless-ng) in the documentation. Its also entirely possible to go back to paperless by reverting the database migrations.
+Read the section about [migration](https://paperless-ng.readthedocs.io/en/latest/setup.html#migration-to-paperless-ng) in the documentation. Its also entirely possible to go back to Paperless by reverting the database migrations.
 
 # Documentation
 
@@ -103,19 +78,21 @@ The documentation for Paperless-ng is available on [ReadTheDocs](https://paperle
 
 # Translation
 
-Paperless is currently available in English, German, Dutch and French. Translation is coordinated at transifex: https://www.transifex.com/paperless/paperless-ng
+Paperless is available in many different languages. Translation is coordinated at crowdin. If you want to help out by translating paperless into your language, please head over to https://github.com/jonaswinkler/paperless-ng/issues/212 for details!
 
-If you want to see paperless in your own language, request that language at transifex and you can start translating after I approve the language.
+# Feature Requests
 
-# Suggestions? Questions? Something not working?
+Feature requests can be submitted via [GitHub Discussions](https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests), you can search for existing ideas, add your own and vote for the ones you care about! Note that some older feature requests can also be found under [issues](https://github.com/jonaswinkler/paperless-ng/issues).
 
-Please open an issue and start a discussion about it!
+# Questions? Something not working?
+
+For bugs please [open an issue](https://github.com/jonaswinkler/paperless-ng/issues) or [start a discussion](https://github.com/jonaswinkler/paperless-ng/discussions) if you have questions.
 
 ## Feel like helping out?
 
-There's still lots of things to be done, just have a look at that issue log. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. The documentation has some basic information on how to get started.
+There's still lots of things to be done, just have a look at open issues & discussions. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. The documentation has some basic information on how to get started.
 
-If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested. See the roadmap above.
+If you want to implement something big: Please start a discussion about that! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested.
 
 # Affiliated Projects
 
@@ -123,12 +100,17 @@ 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. Updated to work with 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.
 
 These projects also exist, but their status and compatibility with paperless-ng is unknown.
 
-* [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation.  Runs on Mac, Linux, and Windows.
 * [paperless-cli](https://github.com/stgarf/paperless-cli): A golang command line binary to interact with a Paperless instance.
 
+This project also exists, but needs updates to be compatile with paperless-ng.
+
+* [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation.  Runs on Mac, Linux, and Windows.
+	Known issues on Mac: (Could not load reminders and documents)
+
 # Important Note
 
-Document scanners are typically used to scan sensitive documents.  Things like your social insurance number, tax records, invoices, etc.  Everything is stored in the clear without encryption by default (it needs to be searchable, so if someone has ideas on how to do that on encrypted data, I'm all ears).  This means that Paperless should never be run on an untrusted host.  Instead, I recommend that if you do want to use it, run it locally on a server in your own home.
+Document scanners are typically used to scan sensitive documents.  Things like your social insurance number, tax records, invoices, etc.  Everything is stored in the clear without encryption. This means that Paperless should never be run on an untrusted host.  Instead, I recommend that if you do want to use it, run it locally on a server in your own home.

ansible/README.md

@@ -1,38 +1,116 @@
-Role Name
-=========
+Ansible Role: paperless-ng
+==========================
 
-A brief description of the role goes here.
+Installs and configures paperless-ng EDMS on Debian/Ubuntu systems.
 
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+No special system requirements. Ansible 2.7 or newer is required.
+
+Note that this role requires root access, so either run it in a playbook with a global `become: yes`, or invoke the role in your playbook like:
+
+    - hosts: all
+      roles:
+        - role: paperless-ng
+          become: yes
 
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+Most configuration variables from paperless-ng itself are available and accept their respective arguments.
+Every `PAPERLESS_*` configuration variable is lowercased and instead prefixed with `paperlessng_*` in `defaults/main.yml`.
+
+For a full listing including explanations and allowed values, see the current [documentation](https://paperless-ng.readthedocs.io/en/latest/configuration.html).
+
+Additional variables available in this role are listed below, along with default values:
+
+    paperlessng_version: latest
+
+The [release](https://github.com/jonaswinkler/paperless-ng/releases) archive version of paperless-ng to install.
+`latest` stands for the latest release of paperless-ng.
+To install a specific version of paperless-ng, use the tag name of the release, e. g. `ng-1.4.4`, or specify a branch or commit id.
+
+    paperlessng_redis_host: localhost
+    paperlessng_redis_port: 6379
+
+Separate configuration values that combine into `PAPERLESS_REDIS`.
+
+    paperlessng_db_type: sqlite
+
+Database to use. Default is file-based SQLite.
+
+    paperlessng_db_host: localhost
+    paperlessng_db_port: 5432
+    paperlessng_db_name: paperlessng
+    paperlessng_db_user: paperlessng
+    paperlessng_db_pass: paperlessng
+    paperlessng_db_sslmode: prefer
+
+Database configuration (only applicable if `paperlessng_db_type == 'postgresql'`).
+
+    paperlessng_directory: /opt/paperless-ng
+
+Root directory paperless-ng is installed into.
+
+    paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv"
+
+Directory used for the virtual environment for paperless-ng.
+
+    paperlessng_ocr_languages:
+      - eng
+
+List of OCR languages to install and configure (`apt search tesseract-ocr-*`).
+
+    paperlessng_use_jbig2enc: True
+
+Whether to install and use [jbig2enc](https://github.com/agl/jbig2enc) for OCRmyPDF.
+
+    paperlessng_big2enc_lossy: False
+
+Whether to use jbig2enc's lossy compression mode.
+
+    paperlessng_superuser_name: paperlessng
+    paperlessng_superuser_email: paperlessng@example.com
+    paperlessng_superuser_password: paperlessng
+
+Credentials of the initial superuser in paperless-ng.
+
+    paperlessng_system_user: paperlessng
+    paperlessng_system_group: paperlessng
+
+System user and group to run the paperless-ng services as (will be created if required).
+
+    paperlessng_listen_address: 127.0.0.1
+    paperlessng_listen_port: 8000
+
+Address and port for the paperless-ng service to listen on.
 
 Dependencies
 ------------
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+No ansible dependencies.
 
 Example Playbook
 ----------------
+`playbook.yml`:
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
+    - hosts: all
+      become: yes
+      vars_files:
+        - vars/paperless-ng.yml
       roles:
-         - { role: username.rolename, x: 42 }
+        - paperless-ng
 
-License
--------
+`vars/paperless-ng.yml`:
 
-BSD
+    paperlessng_media_root: /mnt/media/smbshare
 
-Author Information
-------------------
+    paperlessng_db_type: postgresql
+    paperlessng_db_pass: PLEASEPROVIDEASTRONGPASSWORDHERE
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+    paperlessng_secret_key: AGAINPLEASECHANGETHISNOW
+
+    paperlessng_ocr_languages:
+      - eng
+      - deu

ansible/defaults/main.yml

@@ -1,39 +1,9 @@
 ---
-paperlessng_version: 0.9.13
-paperlessng_directory: /opt/paperless-ng
-paperlessng_consumption_dir: "{{ paperlessng_directory }}/consumption"
-paperlessng_data_dir: "{{ paperlessng_directory }}/data"
-paperlessng_media_root: "{{ paperlessng_directory }}/media"
-paperlessng_static_dir: "{{ paperlessng_directory }}/static"
-paperlessng_filename_format:
-paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv"
-
-paperlessng_ocr_languages:
-  - eng
-paperlessng_time_zone: Europe/Berlin
-# see https://ocrmypdf.readthedocs.io/en/latest/api.html#ocrmypdf.ocr
-paperlessng_ocrmypdf_args:
-  #- "deskew": true  # https://github.com/jonaswinkler/paperless-ng/issues/231
-  - "optimize": 1
-paperlessng_use_jbig2enc: true
-paperlessng_big2enc_lossy: false
-paperlessng_tika_enabled: false
-paperlessng_tika_endpoint: http://localhost:9998
-paperlessng_tika_gotenberg_endpoint: http://localhost:3000
-
-paperlessng_superuser_name: paperlessng
-paperlessng_superuser_email: paperlessng@example.com
-paperlessng_superuser_password: paperlessng
-
-paperlessng_system_user: paperlessng
-paperlessng_system_group: paperlessng
-
-paperlessng_listen_address: 127.0.0.1
-paperlessng_listen_port: 8000
+paperlessng_version: latest  # 'latest', release number, or github branch/tag/commit/ref
 
+# Required services
 paperlessng_redis_host: localhost
 paperlessng_redis_port: 6379
-
 paperlessng_db_type: sqlite # or postgresql
 # Below entries only apply for paperlessng_db_type=='postgresql'
 paperlessng_db_host: localhost
@@ -41,3 +11,73 @@ paperlessng_db_port: 5432
 paperlessng_db_name: paperlessng
 paperlessng_db_user: paperlessng
 paperlessng_db_pass: paperlessng
+paperlessng_db_sslmode: prefer
+
+# Paths and folders
+paperlessng_directory: /opt/paperless-ng
+paperlessng_consumption_dir: "{{ paperlessng_directory }}/consumption"
+paperlessng_data_dir: "{{ paperlessng_directory }}/data"
+paperlessng_media_root: "{{ paperlessng_directory }}/media"
+paperlessng_staticdir: "{{ paperlessng_directory }}/static"
+paperlessng_filename_format:
+paperlessng_logging_dir: "{{ paperlessng_data_dir }}/log"
+paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv"
+
+# Hosting & Security
+paperlessng_secret_key: PLEASECHANGETHISFORTHELOVEOFGOD
+paperlessng_allowed_hosts: "*"
+paperlessng_cors_allowed_hosts: http://localhost:8000
+paperlessng_force_script_name:
+paperlessng_static_url: /static/
+paperlessng_auto_login_username:
+paperlessng_cookie_prefix: ""
+paperlessng_enable_http_remote_user: False
+
+# OCR settings
+paperlessng_ocr_languages:
+  - eng
+paperlessng_ocr_mode: skip
+paperlessng_ocr_clean: clean
+paperlessng_ocr_deskew: True
+paperlessng_ocr_rotate_pages: True
+paperlessng_ocr_rotate_pages_threshold: 12
+paperlessng_ocr_output_type: pdfa
+paperlessng_ocr_pages: 0
+paperlessng_ocr_image_dpi:
+# see https://ocrmypdf.readthedocs.io/en/latest/api.html#ocrmypdf.ocr
+paperlessng_ocr_user_args:
+  - "optimize": 1
+paperlessng_use_jbig2enc: True
+paperlessng_big2enc_lossy: False
+
+# Tika settings
+paperlessng_tika_enabled: False
+paperlessng_tika_endpoint: http://localhost:9998
+paperlessng_tika_gotenberg_endpoint: http://localhost:3000
+
+# Software tweaks
+paperlessng_time_zone: Europe/Berlin
+paperlessng_consumer_polling: 0
+paperlessng_consumer_delete_duplicates: False
+paperlessng_consumer_recursive: False
+paperlessng_consumer_subdirs_as_tags: False
+paperlessng_convert_memory_limit: 0
+paperlessng_convert_tmpdir:
+paperlessng_optimize_thumbnails: True
+paperlessng_post_consume_script:
+paperlessng_filename_date_order:
+paperlessng_thumbnail_font_name: /usr/share/fonts/liberation/LiberationSerif-Regular.ttf
+paperlessng_ignore_dates: ""
+
+# Superuser settings
+paperlessng_superuser_name: paperlessng
+paperlessng_superuser_email: paperlessng@example.com
+paperlessng_superuser_password: paperlessng
+
+# System user settings
+paperlessng_system_user: paperlessng
+paperlessng_system_group: paperlessng
+
+# Webserver settings
+paperlessng_listen_address: 127.0.0.1
+paperlessng_listen_port: 8000

ansible/molecule/default/converge.yml

@@ -1,7 +1,10 @@
 ---
-- name: Converge
+- name: update previous release to newest release
   hosts: all
   tasks:
-    - name: "Include ansible"
+    - name: set current github commit as version when available
+      set_fact:
+        paperlessng_version: "{{ lookup('env', 'TARGET_GITHUB_SHA') | default('master', True) }}"
+    - name: update to newest paperless-ng release
       include_role:
-        name: "ansible"
+        name: ansible

ansible/molecule/default/prepare.yml

@@ -0,0 +1,10 @@
+- name: install previous release
+  hosts: all
+  tasks:
+    - name: set previous version as installation target
+      set_fact:
+        paperlessng_version: latest
+
+    - name: install previous paperless-ng release
+      include_role:
+        name: ansible

ansible/molecule/default/verify.yml

@@ -1,14 +1,94 @@
 ---
-# This is an example playbook to execute Ansible tests.
-
 - name: Verify
   hosts: all
   gather_facts: false
+
+  vars_files:
+    - ../../defaults/main.yml
+
   tasks:
-  - name: check if webserver is up
-    uri:
-      url: http://localhost:8000
-      status_code: [200, 302]
-      return_content: yes
-    register: landingpage
-    failed_when: "'Sign in</button>' not in landingpage.content"
+    - name: check if webserver is up
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}"
+        status_code: [200, 302]
+        return_content: yes
+      register: landingpage
+      failed_when: "'Sign in</button>' not in landingpage.content"
+
+    - name: generate random name and content
+      set_fact:
+        content: "{{ lookup('password', '/dev/null length=65536 chars=ascii_letters') }}"
+        filename: "{{ lookup('password', '/dev/null length=8 chars=ascii_letters') }}"
+
+    - name: check if document posting works
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/post_document/"
+        method: POST
+        body_format: form-multipart
+        body:
+          document:
+            content: "{{ content }}"
+            filename: "{{ filename }}.txt"
+        headers:
+          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
+          Content-Type: text/plain
+        return_content: yes
+      register: post_document
+      failed_when: "'OK' not in post_document.content"
+
+    - name: verify uploaded document has been accepted
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/logs/paperless/"
+        headers:
+          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
+        return_content: yes
+      register: logs
+      failed_when: "('Consuming ' + filename + '.txt') not in logs.content"
+
+    - name: sleep till consumption finished
+      pause:
+        seconds: 10
+
+    - name: verify uploaded document has been consumed
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/logs/paperless/"
+        headers:
+          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
+        return_content: yes
+      register: logs
+      failed_when: "filename + ' consumption finished' not in logs.content"
+
+    - name: get documents
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/"
+        headers:
+          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
+        return_content: yes
+      register: documents
+
+    - name: set document index
+      set_fact:
+        index: "{{ documents.json['results'][0]['id'] }}"
+
+    - name: verify uploaded document is avaiable
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/{{ index }}/"
+        headers:
+          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
+        return_content: yes
+      register: document
+      failed_when: "'Not found.' in document.content or content not in document.json['content']"
+
+    - name: check if deleting uploaded document works
+      uri:
+        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/bulk_edit/"
+        method: POST
+        body_format: json
+        body:
+          documents: ["{{ index }}"]
+          method: delete
+          parameters: {}
+        headers:
+          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
+      register: delete_document
+      failed_when: "'OK' not in delete_document.json['result']"

ansible/tasks/install-release.yml

@@ -0,0 +1,6 @@
+---
+- name: extract paperless-ng
+  unarchive:
+    src: "https://github.com/jonaswinkler/paperless-ng/releases/download/ng-{{ paperlessng_version }}/paperless-ng-{{ paperlessng_version }}.tar.xz"
+    remote_src: yes
+    dest: "{{ tempdir.path }}"

ansible/tasks/install-source.yml

@@ -0,0 +1,112 @@
+---
+- name: install dev dependencies
+  apt:
+    pkg:
+      - git
+      - npm
+      - gettext
+
+- name: create output directories
+  file:
+    path: "{{ item }}"
+    state: directory
+    owner: "{{ paperlessng_system_user }}"
+    group: "{{ paperlessng_system_group }}"
+    mode: "750"
+  with_items:
+    - "{{ tempdir.path }}/paperless-ng"
+    - "{{ tempdir.path }}/paperless-ng/scripts"
+
+- block:
+    - name: create temporary git directory
+      tempfile:
+        state: directory
+        path: "{{ paperlessng_directory }}"
+      register: gitdir
+
+    - name: pull paperless-ng
+      git:
+        repo: https://github.com/jonaswinkler/paperless-ng.git
+        dest: "{{ gitdir.path }}"
+        version: "{{ paperlessng_version }}"
+        refspec: "+refs/pull/*:refs/pull/*"
+
+    - name: compile frontend
+      command:
+        cmd: "{{ item }}"
+      args:
+        chdir: "{{ gitdir.path }}/src-ui"
+      failed_when: false
+      with_items:
+        - npm install -g @angular/cli
+        - npm install
+        - ./node_modules/.bin/ng build --prod
+
+    - name: copy application into place
+      copy:
+        src: "{{ gitdir.path }}/{{ item.src }}"
+        remote_src: yes
+        dest: "{{ tempdir.path }}/paperless-ng/{{ item.dest | default('') }}"
+      with_items:
+        - src: CONTRIBUTING.md
+        - src: LICENSE
+        - src: Pipfile
+        - src: Pipfile.lock
+        - src: README.md
+        - src: requirements.txt
+        - src: gunicorn.conf.py
+        - src: paperless.conf.example
+          dest: "paperless.conf"
+
+    - name: glob all scripts
+      find:
+        paths: ["{{ gitdir.path }}/scripts/"]
+        patterns:
+          - "*.service"
+          - "*.sh"
+      register: glob
+
+    - name: copy scripts
+      copy:
+        src: "{{ item.path }}"
+        remote_src: yes
+        dest: "{{ tempdir.path }}/paperless-ng/scripts/"
+      with_items:
+        - "{{ glob.files }}"
+
+    - name: copy sources
+      command:
+        cmd: "cp -r src/ {{ tempdir.path }}/paperless-ng/src"
+      args:
+        chdir: "{{ gitdir.path }}"
+
+    - name: create paperlessng venv
+      command:
+        cmd: "python3 -m virtualenv {{ gitdir.path }}/.venv/ -p /usr/bin/python3"
+
+    - name: install paperlessng requirements
+      command:
+        cmd: "{{ gitdir.path }}/.venv/bin/python3 -m pip install -r {{ gitdir.path }}/requirements.txt"
+
+    - name: compile messages
+      command: "{{ gitdir.path }}/.venv/bin/python3 manage.py compilemessages"
+      args:
+        chdir: "{{ tempdir.path }}/paperless-ng/src/"
+
+    - name: collect static files
+      command: "{{ gitdir.path }}/.venv/bin/python3 manage.py collectstatic --no-input"
+      args:
+        chdir: "{{ tempdir.path }}/paperless-ng/src/"
+
+    - name: remove pycache directories
+      shell: find . -name __pycache__ | xargs rm -r
+      args:
+        chdir: "{{ tempdir.path }}"
+
+    - name: remove temporary git directory
+      file:
+        path: "{{ gitdir.path }}"
+        state: absent
+
+  become: yes
+  become_user: "{{ paperlessng_system_user }}"

ansible/tasks/main.yml

@@ -9,36 +9,41 @@
     update_cache: yes
     pkg:
       # paperless-ng
-      - python3-dev
       - python3-pip
-      - gettext
+      - python3-dev
       - fonts-liberation
       - imagemagick
+      - optipng
+      - gnupg
+      - libpq-dev
+      - libmagic-dev
+      - mime-support
+      # OCRmyPDF
       - unpaper
       - ghostscript
-      - optipng
-      - tesseract-ocr
-      - gnupg
-      - libpoppler-cpp-dev
-      - libmagic-dev
-      - libpq-dev
-      # OCRmyPDF
       - icc-profiles-free
       - qpdf
       - liblept5
       - libxml2
       - pngquant
       - zlib1g
+      - tesseract-ocr
       # dev
       - sudo
       - build-essential
       - python3-setuptools
       - python3-wheel
-      - python3-virtualenv
+
+# upstream virtualenv in Ubuntu 20.04 is broken
+# https://github.com/pypa/virtualenv/issues/1873
+- name: install python virtualenv
+  pip:
+    name: virtualenv
+    extra_args: --upgrade
 
 - name: install ocr languages
   apt:
-    pkg: "{{ paperlessng_ocr_languages | map('regex_replace', '^(.*)$', 'tesseract-ocr-\\1') | list }}"
+    pkg: "{{ paperlessng_ocr_languages | map('regex_replace', '^(.*)$', 'tesseract-ocr-\\1') | map('replace', '_', '-') | list }}"
 
 - name: set up notesalexp repository key (for jbig2enc)
   apt_key:
@@ -97,54 +102,148 @@
     # GNUPG_HOME required due to paperless db.py
     create_home: yes
 
+- block:
+    - name: get latest release version
+      uri:
+        url: https://api.github.com/repos/jonaswinkler/paperless-ng/releases/latest
+        method: GET
+      register: latest_release
+    - name: parse latest release version
+      set_fact:
+        paperlessng_version: "{{ latest_release.json['tag_name'] }}"
+  when: paperlessng_version == "latest"
+
+- name: check if version is ref
+  fail:
+    msg: "Specifying `paperlessng_version` as git ref may not work as expected!"
+  ignore_errors: True  # Output failure (as warning), but don't consider play failed
+  when: paperlessng_version.startswith('refs/')
+
+- block:
+    - name: sanitize version string
+      set_fact:
+        paperlessng_version: "{{ paperlessng_version | regex_replace('^ng-(\\d+\\.\\d+\\.\\d+)$', '\\1') }}"
+    - name: get tag data
+      uri:
+        url: https://api.github.com/repos/jonaswinkler/paperless-ng/tags
+        method: GET
+      register: tags
+    - name: get commit for target tag
+      set_fact:
+        paperlessng_commit: "{{ tags.json | json_query('[?name==`ng-' + paperlessng_version +'`] | [0].commit.sha') }}"
+  when: paperlessng_version | regex_search("^(ng-)?(\d+\.\d+\.\d+)$")
+
+- block:
+    - name: check if version is branch
+      uri:
+        url: "https://api.github.com/repos/jonaswinkler/paperless-ng/branches/{{ paperlessng_version }}"
+        method: GET
+        status_code: [200, 404]
+      register: branch
+    - name: get commit for target branch
+      set_fact:
+        paperlessng_commit: "{{ branch.json | json_query('commit.sha') }}"
+      when: branch.status == 200
+    - block:
+        - name: check if version is commit-or-ref
+          uri:
+            url: "https://api.github.com/repos/jonaswinkler/paperless-ng/commits/{{ paperlessng_version }}"
+            method: GET
+            status_code: [200, 404, 422]
+          register: commit
+        - name: get commit for target commit-or-ref
+          set_fact:
+            paperlessng_commit: "{{ commit.json | json_query('sha') }}"
+          when: commit.status == 200
+        - name: fail
+          fail:
+            msg: "Can not determine commit from `paperlessng_version=={{ paperlessng_version }}`!"
+          when: commit.status != 200
+      when: branch.status == 404
+  when: not(paperlessng_version | regex_search("^(ng-)?(\d+\.\d+\.\d+)$"))
+
 - name: check for paperless-ng installation
   command:
-    cmd: 'grep -Po "(?<=Paperless-ng )\d+\.\d+\.\d+" {{ paperlessng_directory }}/docs/changelog.html'
-  changed_when: '"No such file or directory" in paperlessng_current_version.stderr or paperlessng_current_version.stdout != paperlessng_version | string'
+    cmd: "cat {{ paperlessng_directory }}/.installed_version"
+  changed_when: '"No such file or directory" in paperlessng_current_commit.stderr or paperlessng_current_commit.stdout != paperlessng_commit | string'
   failed_when: false
   ignore_errors: yes
-  register: paperlessng_current_version
+  register: paperlessng_current_commit
 
-- name: backup current paperless-ng installation
-  copy:
-    src: "{{ paperlessng_directory }}"
-    remote_src: yes
-    dest: "{{ paperlessng_directory }}-{{ ansible_date_time.iso8601 }}/"
-  when: '"No such file or directory" not in paperlessng_current_version.stderr and paperlessng_current_version.stdout != paperlessng_version | string'
+- name: register current state
+  set_fact:
+    fresh_installation: '{{ "No such file or directory" in paperlessng_current_commit.stderr }}'
+    update_installation: '{{ "No such file or directory" not in paperlessng_current_commit.stderr and paperlessng_current_commit.stdout != paperlessng_commit | string }}'
+    reconfigure_only: "{{ paperlessng_current_commit.stdout == paperlessng_commit | string }}"
 
-- name: create temporary directory
-  tempfile:
-    state: directory
-  register: tempdir
-  when: '"No such file or directory" in paperlessng_current_version.stderr or paperlessng_current_version.stdout != paperlessng_version | string'
+- block:
+    - name: backup current paperless-ng installation
+      copy:
+        src: "{{ paperlessng_directory }}"
+        remote_src: yes
+        dest: "{{ paperlessng_directory }}-{{ ansible_date_time.iso8601 }}/"
+    - name: remove current paperless sources
+      file:
+        path: "{{ paperlessng_directory }}/{{ item }}"
+        state: absent
+      with_items:
+        - docker
+        - docs
+        - scripts
+        - src
+        - static
+  when: update_installation
 
-- name: extract paperless-ng
-  unarchive:
-    src: "https://github.com/jonaswinkler/paperless-ng/releases/download/ng-{{ paperlessng_version }}/paperless-ng-{{ paperlessng_version }}.tar.xz"
-    remote_src: yes
-    dest: "{{ tempdir.path }}"
-  when: '"No such file or directory" in paperlessng_current_version.stderr or paperlessng_current_version.stdout != paperlessng_version | string'
-
-- name: change owner and permissions of paperless-ng
-  command:
-    cmd: "{{ item }}"
-    warn: false
-  with_items:
-  - "chown -R {{ paperlessng_system_user }}:{{ paperlessng_system_group }} {{ tempdir.path }}"
-  - "find {{ tempdir.path }} -type d -exec chmod 0750 {} ;"
-  - "find {{ tempdir.path }} -type f -exec chmod 0640 {} ;"
-  when: '"No such file or directory" in paperlessng_current_version.stderr or paperlessng_current_version.stdout != paperlessng_version | string'
-
-- name: move paperless-ng
-  command:
-    cmd: "cp -a {{ tempdir.path }}/paperless-ng/ {{ paperlessng_directory }}"
-  when: '"No such file or directory" in paperlessng_current_version.stderr or paperlessng_current_version.stdout != paperlessng_version | string'
-
-- name: remove temporary directory
-  file:
-    path: "{{ tempdir.path }}"
-    state: absent
-  when: '"No such file or directory" in paperlessng_current_version.stderr or paperlessng_current_version.stdout != paperlessng_version | string'
+- block:
+    - name: create paperless-ng directory and set permissions
+      file:
+        path: "{{ paperlessng_directory }}"
+        state: directory
+        owner: "{{ paperlessng_system_user }}"
+        group: "{{ paperlessng_system_group }}"
+        mode: "750"
+    - name: create temporary directory
+      become: yes
+      become_user: "{{ paperlessng_system_user }}"
+      tempfile:
+        state: directory
+        path: "{{ paperlessng_directory }}"
+      register: tempdir
+    - name: check if version is available as release archive
+      uri:
+        url: "https://github.com/jonaswinkler/paperless-ng/releases/download/ng-{{ paperlessng_version }}/paperless-ng-{{ paperlessng_version }}.tar.xz"
+        method: GET
+        status_code: [200, 404]
+      register: release_archive
+    - name: install paperless-ng from source
+      include_tasks: install-source.yml
+      when: release_archive.status == 404
+    - name: install paperless-ng from release archive
+      include_tasks: install-release.yml
+      when: release_archive.status == 200
+    - name: change owner and permissions of paperless-ng
+      command:
+        cmd: "{{ item }}"
+        warn: false
+      with_items:
+        - "chown -R {{ paperlessng_system_user }}:{{ paperlessng_system_group }} {{ tempdir.path }}"
+        - "find {{ tempdir.path }} -type d -exec chmod 0750 {} ;"
+        - "find {{ tempdir.path }} -type f -exec chmod 0640 {} ;"
+    - name: move paperless-ng
+      command:
+        cmd: "cp -a {{ tempdir.path }}/paperless-ng/. {{ paperlessng_directory }}"
+    - name: store commit hash of installed version
+      copy:
+        content: "{{ paperlessng_commit }}"
+        dest: "{{ paperlessng_directory }}/.installed_version"
+        owner: "{{ paperlessng_system_user }}"
+        group: "{{ paperlessng_system_group }}"
+        mode: "0440"
+    - name: remove temporary directory
+      file:
+        path: "{{ tempdir.path }}"
+        state: absent
+  when: not reconfigure_only
 
 - name: create paperless-ng directories and set permissions
   file:
@@ -154,15 +253,14 @@
     group: "{{ paperlessng_system_group }}"
     mode: "750"
   with_items:
-    - "{{ paperlessng_directory }}"  # ansible `copy:` does not set correct permissions on `dest:` for recursive copies
     - "{{ paperlessng_consumption_dir }}"
     - "{{ paperlessng_data_dir }}"
     - "{{ paperlessng_media_root }}"
-    - "{{ paperlessng_static_dir }}"
+    - "{{ paperlessng_staticdir }}"
 
 - name: rename initial config
   command:
-    cmd: "mv {{ paperlessng_directory }}/paperless.conf {{ paperlessng_directory }}/paperless.conf.template"
+    cmd: "mv -f {{ paperlessng_directory }}/paperless.conf {{ paperlessng_directory }}/paperless.conf.template"
     removes: "{{ paperlessng_directory }}/paperless.conf"
 
 - name: configure paperless-ng
@@ -171,8 +269,10 @@
     regexp: "^#?{{ item.regexp }}="
     line: "{{ item.line }}"
   with_items:
+    # Required services
     - regexp: PAPERLESS_REDIS
       line: "PAPERLESS_REDIS=redis://{{ paperlessng_redis_host }}:{{ paperlessng_redis_port }}"
+    # Paths and folders
     - regexp: PAPERLESS_CONSUMPTION_DIR
       line: "PAPERLESS_CONSUMPTION_DIR={{ paperlessng_consumption_dir }}"
     - regexp: PAPERLESS_DATA_DIR
@@ -180,29 +280,82 @@
     - regexp: PAPERLESS_MEDIA_ROOT
       line: "PAPERLESS_MEDIA_ROOT={{ paperlessng_media_root }}"
     - regexp: PAPERLESS_STATICDIR
-      line: "PAPERLESS_STATICDIR={{ paperlessng_static_dir }}"
+      line: "PAPERLESS_STATICDIR={{ paperlessng_staticdir }}"
     - regexp: PAPERLESS_FILENAME_FORMAT
       line: "PAPERLESS_FILENAME_FORMAT={{ paperlessng_filename_format }}"
+    - regexp: PAPERLESS_LOGGING_DIR
+      line: "PAPERLESS_LOGGING_DIR={{ paperlessng_logging_dir }}"
+    # Hosting & Security
+    - regexp: PAPERLESS_SECRET_KEY
+      line: "PAPERLESS_SECRET_KEY={{ paperlessng_secret_key }}"
+    - regexp: PAPERLESS_ALLOWED_HOSTS
+      line: "PAPERLESS_ALLOWED_HOSTS={{ paperlessng_allowed_hosts }}"
+    - regexp: PAPERLESS_CORS_ALLOWED_HOSTS
+      line: "PAPERLESS_CORS_ALLOWED_HOSTS={{ paperlessng_cors_allowed_hosts }}"
+    - regexp: PAPERLESS_FORCE_SCRIPT_NAME
+      line: "PAPERLESS_FORCE_SCRIPT_NAME={{ paperlessng_force_script_name }}"
+    - regexp: PAPERLESS_STATIC_URL
+      line: "PAPERLESS_STATIC_URL={{ paperlessng_static_url }}"
+    - regexp: PAPERLESS_AUTO_LOGIN_USERNAME
+      line: "PAPERLESS_AUTO_LOGIN_USERNAME={{ paperlessng_auto_login_username }}"
+    - regexp: PAPERLESS_COOKIE_PREFIX
+      line: "PAPERLESS_COOKIE_PREFIX={{ paperlessng_cookie_prefix }}"
+    - regexp: PAPERLESS_ENABLE_HTTP_REMOTE_USER
+      line: "PAPERLESS_ENABLE_HTTP_REMOTE_USER={{ paperlessng_enable_http_remote_user }}"
+    # OCR settings
     - regexp: PAPERLESS_OCR_LANGUAGE
-      line: "PAPERLESS_OCR_LANGUAGE={{ paperlessng_ocr_languages | join('+') }}"
+      line: "PAPERLESS_OCR_LANGUAGE={{ paperlessng_ocr_languages | join('+') | replace('-','_') }}"
+    - regexp: PAPERLESS_OCR_MODE
+      line: "PAPERLESS_OCR_MODE={{ paperlessng_ocr_mode }}"
+    - regexp: PAPERLESS_OCR_CLEAN
+      line: "PAPERLESS_OCR_CLEAN={{ paperlessng_ocr_clean }}"
+    - regexp: PAPERLESS_OCR_DESKEW
+      line: "PAPERLESS_OCR_DESKEW={{ paperlessng_ocr_deskew }}"
+    - regexp: PAPERLESS_OCR_ROTATE_PAGES
+      line: "PAPERLESS_OCR_ROTATE_PAGES={{ paperlessng_ocr_rotate_pages }}"
+    - regexp: PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD
+      line: "PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD={{ paperlessng_ocr_rotate_pages_threshold }}"
+    - regexp: PAPERLESS_OCR_OUTPUT_TYPE
+      line: "PAPERLESS_OCR_OUTPUT_TYPE={{ paperlessng_ocr_output_type }}"
+    - regexp: PAPERLESS_OCR_PAGES
+      line: "PAPERLESS_OCR_PAGES={{ paperlessng_ocr_pages }}"
+    - regexp: PAPERLESS_OCR_IMAGE_DPI
+      line: "PAPERLESS_OCR_IMAGE_DPI={{ paperlessng_ocr_image_dpi }}"
     - regexp: PAPERLESS_OCR_USER_ARGS
-      line: "PAPERLESS_OCR_USER_ARGS={{ paperlessng_ocrmypdf_args | combine({'jbig2_lossy': true} if paperlessng_big2enc_lossy else {}) | to_json }}"
-    - regexp: PAPERLESS_TIME_ZONE
-      line: "PAPERLESS_TIME_ZONE={{ paperlessng_time_zone }}"
+      line: "PAPERLESS_OCR_USER_ARGS={{ paperlessng_ocr_user_args | combine({'jbig2_lossy': true} if paperlessng_big2enc_lossy else {}) | to_json }}"
+    # Tika settings
     - regexp: PAPERLESS_TIKA_ENABLED
       line: "PAPERLESS_TIKA_ENABLED={{ paperlessng_tika_enabled }}"
-  no_log: yes
-
-- name: configure paperless-ng [tika]
-  lineinfile:
-    path: "{{ paperlessng_directory }}/paperless.conf.template"
-    regexp: "^#?{{ item.regexp }}="
-    line: "'{{ item.line }}' if paperlessng_tika_enabled else '#{{ item.line }}'"
-  with_items:
     - regexp: PAPERLESS_TIKA_ENDPOINT
       line: "PAPERLESS_TIKA_ENDPOINT={{ paperlessng_tika_endpoint }}"
     - regexp: PAPERLESS_TIKA_GOTENBERG_ENDPOINT
       line: "PAPERLESS_TIKA_GOTENBERG_ENDPOINT={{ paperlessng_tika_endpoint }}"
+    # Software tweaks
+    - regexp: PAPERLESS_TIME_ZONE
+      line: "PAPERLESS_TIME_ZONE={{ paperlessng_time_zone }}"
+    - regexp: PAPERLESS_CONSUMER_POLLING
+      line: "PAPERLESS_CONSUMER_POLLING={{ paperlessng_consumer_polling }}"
+    - regexp: PAPERLESS_CONSUMER_DELETE_DUPLICATES
+      line: "PAPERLESS_CONSUMER_DELETE_DUPLICATES={{ paperlessng_consumer_delete_duplicates }}"
+    - regexp: PAPERLESS_CONSUMER_RECURSIVE
+      line: "PAPERLESS_CONSUMER_RECURSIVE={{ paperlessng_consumer_recursive }}"
+    - regexp: PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS
+      line: "PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS={{ paperlessng_consumer_subdirs_as_tags }}"
+    - regexp: PAPERLESS_CONVERT_MEMORY_LIMIT
+      line: "PAPERLESS_CONVERT_MEMORY_LIMIT={{ paperlessng_convert_memory_limit }}"
+    - regexp: PAPERLESS_CONVERT_TMPDIR
+      line: "PAPERLESS_CONVERT_TMPDIR={{ paperlessng_convert_tmpdir }}"
+    - regexp: PAPERLESS_OPTIMIZE_THUMBNAILS
+      line: "PAPERLESS_OPTIMIZE_THUMBNAILS={{ paperlessng_optimize_thumbnails }}"
+    - regexp: PAPERLESS_POST_CONSUME_SCRIPT
+      line: "PAPERLESS_POST_CONSUME_SCRIPT={{ paperlessng_post_consume_script }}"
+    - regexp: PAPERLESS_FILENAME_DATE_ORDER
+      line: "PAPERLESS_FILENAME_DATE_ORDER={{ paperlessng_filename_date_order }}"
+    - regexp: PAPERLESS_THUMBNAIL_FONT_NAME
+      line: "PAPERLESS_THUMBNAIL_FONT_NAME={{ paperlessng_thumbnail_font_name }}"
+    - regexp: PAPERLESS_IGNORE_DATES
+      line: "PAPERLESS_IGNORE_DATES={{ paperlessng_ignore_dates }}"
+  no_log: yes
 
 - name: configure paperless-ng database [sqlite]
   lineinfile:
@@ -228,6 +381,8 @@
       line: "PAPERLESS_DBUSER={{ paperlessng_db_user }}"
     - regexp: PAPERLESS_DBPASS
       line: "PAPERLESS_DBPASS={{ paperlessng_db_pass }}"
+    - regexp: PAPERLESS_DBSSLMODE
+      line: "PAPERLESS_DBSSLMODE={{ paperlessng_db_sslmode }}"
   when: paperlessng_db_type == 'postgresql'
   no_log: yes
 
@@ -238,7 +393,7 @@
     dest: /etc/paperless.conf
     owner: root
     group: root
-    mode: '0644'
+    mode: "0644"
   register: configuration
 
 - name: create paperlessng venv
@@ -249,36 +404,21 @@
     creates: "{{ paperlessng_virtualenv }}"
   register: venv
 
-- name: install paperlessng requirements
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"
-  pip:
-    requirements: "{{ paperlessng_directory }}/requirements.txt"
-    executable: "{{ paperlessng_virtualenv }}/bin/pip3"
-    extra_args: --upgrade
-  when: paperlessng_current_version.stdout != paperlessng_version | string
-
-- name: collect static files
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"
-  command: "{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py collectstatic --no-input"
-  when: paperlessng_current_version.stdout != paperlessng_version | string
-  register: static_files
-  changed_when: static_files.stdout is not match("0 static files copied .*")
-
-- name: create database schema
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"
-  command: "{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py migrate"
-  when: paperlessng_current_version.stdout != paperlessng_version | string
-  register: database_schema
-  changed_when: '"No migrations to apply." not in database_schema.stdout'
-
-- name: compile translations
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"
-  command: "{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py compilemessages"
-  when: paperlessng_current_version.stdout != paperlessng_version | string
+- block:
+    - name: install paperlessng requirements
+      become: yes
+      become_user: "{{ paperlessng_system_user }}"
+      pip:
+        requirements: "{{ paperlessng_directory }}/requirements.txt"
+        executable: "{{ paperlessng_virtualenv }}/bin/pip3"
+        extra_args: --upgrade
+    - name: migrate database schema
+      become: yes
+      become_user: "{{ paperlessng_system_user }}"
+      command: "{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py migrate"
+      register: database_schema
+      changed_when: '"No migrations to apply." not in database_schema.stdout'
+  when: not reconfigure_only
 
 - name: configure paperless superuser
   become: yes
@@ -307,7 +447,7 @@
       else:
           User.objects.create_superuser('{{ paperlessng_superuser_name }}', '{{ paperlessng_superuser_email }}', '{{ paperlessng_superuser_password }}')
           print('changed')
-  command: "{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py shell -c \"{{ creation_script }}\""
+  command: '{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py shell -c "{{ creation_script }}"'
   register: superuser
   changed_when: superuser.stdout == 'changed'
   no_log: yes
@@ -320,7 +460,7 @@
     owner: "{{ paperlessng_system_user }}"
     group: "{{ paperlessng_system_group }}"
     mode: g-w,o-rwx
-  when: venv.changed or paperlessng_current_version.stdout != paperlessng_version | string
+  when: venv.changed or not reconfigure_only
 
 - name: configure ghostscript for PDF
   lineinfile:
@@ -329,6 +469,12 @@
     line: '\1<policy domain="coder" rights="read|write" pattern="PDF" />'
     backrefs: yes
 
+- name: configure gunicorn web server
+  lineinfile:
+    path: "{{ paperlessng_directory }}/gunicorn.conf.py"
+    regexp: '^bind = '
+    line: "bind = '{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}'"
+
 - name: configure systemd services
   ini_file:
     path: "{{ paperlessng_directory }}/scripts/{{ item[0] }}"
@@ -343,34 +489,13 @@
       ]
     - [
         # https://www.freedesktop.org/software/systemd/man/systemd.exec.html
-        {
-          option: "User",
-          value: "{{ paperlessng_system_user }}",
-        },
-        {
-          option: "Group",
-          value: "{{ paperlessng_system_group }}",
-        },
-        {
-          option: "WorkingDirectory",
-          value: "{{ paperlessng_directory }}/src",
-        },
-        {
-          option: "ProtectSystem",
-          value: "full",
-        },
-        {
-          option: "NoNewPrivileges",
-          value: "true",
-        },
-        {
-          option: "PrivateUsers",
-          value: "true",
-        },
-        {
-          option: "PrivateDevices",
-          value: "true",
-        }
+        { option: "User", value: "{{ paperlessng_system_user }}" },
+        { option: "Group", value: "{{ paperlessng_system_group }}" },
+        { option: "WorkingDirectory", value: "{{ paperlessng_directory }}/src" },
+        { option: "ProtectSystem", value: "full" },
+        { option: "NoNewPrivileges", value: "true" },
+        { option: "PrivateUsers", value: "true" },
+        { option: "PrivateDevices", value: "true" },
       ]
 
 - name: configure paperless-consumer service
@@ -392,7 +517,7 @@
     path: "{{ paperlessng_directory }}/scripts/paperless-webserver.service"
     section: "Service"
     option: "ExecStart"
-    value: "{{ paperlessng_virtualenv }}/bin/gunicorn paperless.wsgi -w 2 -b {{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}"
+    value: "{{ paperlessng_virtualenv }}/bin/gunicorn -c {{ paperlessng_directory }}/gunicorn.conf.py paperless.asgi:application"
 
 - name: copy systemd services
   copy:

crowdin.yml

@@ -0,0 +1,6 @@
+commit_message: '[ci skip]'
+files:
+  - source: /src/locale/en_US/LC_MESSAGES/django.po
+    translation: /src/locale/%locale_with_underscore%/LC_MESSAGES/django.po
+  - source: /src-ui/messages.xlf
+    translation: /src-ui/src/locale/messages.%locale_with_underscore%.xlf

docker/compose/.env

@@ -1 +1 @@
-COMPOSE_PROJECT_NAME=paperless
+COMPOSE_PROJECT_NAME=paperless

docker/compose/docker-compose.portainer.yml

@@ -0,0 +1,94 @@
+# docker-compose file for running paperless from the Docker Hub.
+# This file contains everything paperless needs to run.
+# Paperless supports amd64, arm and arm64 hardware.
+#
+# All compose files of paperless configure paperless in the following way:
+#
+# - Paperless is (re)started on system boot, if it was running before shutdown.
+# - Docker volumes for storing data are managed by Docker.
+# - Folders for importing and exporting files are created in the same directory
+#   as this file and mounted to the correct folders inside the container.
+# - Paperless listens on port 8010.
+#
+# In addition to that, this docker-compose file adds the following optional
+# configurations:
+#
+# - Instead of SQLite (default), PostgreSQL is used as the database server.
+#
+# To install and update paperless with this file, do the following:
+#
+# - Open portainer Stacks list and click 'Add stack'
+# - Paste the contents of this file and assign a name, e.g. 'Paperless'
+# - Click 'Deploy the stack' and wait for it to be deployed
+# - Open the list of containers, select paperless_webserver_1
+# - Click 'Console' and then 'Connect' to open the command line inside the container
+# - Run 'python3 manage.py createsuperuser' to create a user
+# - Exit the console
+#
+# For more extensive installation and update instructions, refer to the
+# documentation.
+
+version: "3.4"
+services:
+  broker:
+    image: redis:6.0
+    restart: unless-stopped
+
+  db:
+    image: postgres:13
+    restart: unless-stopped
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: paperless
+      POSTGRES_USER: paperless
+      POSTGRES_PASSWORD: paperless
+
+  webserver:
+    image: jonaswinkler/paperless-ng:latest
+    restart: unless-stopped
+    depends_on:
+      - db
+      - broker
+    ports:
+      - 8010:8000
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - data:/usr/src/paperless/data
+      - media:/usr/src/paperless/media
+      - ./export:/usr/src/paperless/export
+      - ./consume:/usr/src/paperless/consume
+    environment:
+      PAPERLESS_REDIS: redis://broker:6379
+      PAPERLESS_DBHOST: db
+# The UID and GID of the user used to run paperless in the container. Set this
+# to your UID and GID on the host so that you have write access to the
+# consumption directory.
+      USERMAP_UID: 1000
+      USERMAP_GID: 100
+# Additional languages to install for text recognition, separated by a
+# whitespace. Note that this is
+# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
+# language used for OCR.
+# The container installs English, German, Italian, Spanish and French by
+# default.
+# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
+# for available languages.
+      #PAPERLESS_OCR_LANGUAGES: tur ces
+# Adjust this key if you plan to make paperless available publicly. It should
+# be a very long sequence of random characters. You don't need to remember it.
+      #PAPERLESS_SECRET_KEY: change-me
+# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
+      #PAPERLESS_TIME_ZONE: America/Los_Angeles
+# The default language to use for OCR. Set this to the language most of your
+# documents are written in.
+      #PAPERLESS_OCR_LANGUAGE: eng
+
+volumes:
+  data:
+  media:
+  pgdata:

docker/docker-entrypoint.sh

@@ -4,85 +4,37 @@ set -e
 
 # 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 -u "${USERMAP_NEW_UID}" paperless
-        groupmod -o -g "${USERMAP_NEW_GID}" paperless
-    fi
-}
-
-
-wait_for_postgres() {
-	attempt_num=1
-	max_attempts=5
-
-	echo "Waiting for PostgreSQL to start..."
-
-	host="${PAPERLESS_DBHOST}"
-	port="${PAPERLESS_DBPORT}"
-
-	if [[ -z $port ]] ;
-	then
-		port="5432"
+	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 -u "${USERMAP_NEW_UID}" paperless
+		groupmod -o -g "${USERMAP_NEW_GID}" paperless
 	fi
-
-	while !</dev/tcp/$host/$port ;
-	do
-
-		if [ $attempt_num -eq $max_attempts ]
-		then
-			echo "Unable to connect to database."
-			exit 1
-		else
-			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
-
-		fi
-
-		attempt_num=$(expr "$attempt_num" + 1)
-		sleep 5
-	done
-
-
-}
-
-
-migrations() {
-
-	if [[ -n "${PAPERLESS_DBHOST}" ]]
-	then
-		wait_for_postgres
-	fi
-
-	(
-		# flock is in place to prevent multiple containers from doing migrations
-		# simultaneously. This also ensures that the db is ready when the command
-		# of the current container starts.
-		flock 200
-		echo "Apply database migrations..."
-		sudo -HEu paperless python3 manage.py migrate
-	)  200>/usr/src/paperless/data/migration_lock
-
 }
 
 initialize() {
 	map_uidgid
 
 	for dir in export data data/index media media/documents media/documents/originals media/documents/thumbnails; do
-		if [[ ! -d "../$dir" ]]
-		then
-			echo "creating directory ../$dir"
+		if [[ ! -d "../$dir" ]]; then
+			echo "Creating directory ../$dir"
 			mkdir ../$dir
 		fi
 	done
 
-	chown -R paperless:paperless ../
+	echo "Creating directory /tmp/paperless"
+	mkdir -p /tmp/paperless
 
-	migrations
+	set +e
+	echo "Adjusting permissions of paperless files. This may take a while."
+	chown -R paperless:paperless /tmp/paperless
+	find .. -not \( -user paperless -and -group paperless \) -exec chown paperless:paperless {} +
+	set -e
 
+	gosu paperless /sbin/docker-prepare.sh
 }
 
 install_languages() {
@@ -98,44 +50,43 @@ install_languages() {
 	apt-get update
 
 	for lang in "${langs[@]}"; do
-        pkg="tesseract-ocr-$lang"
-        # English is installed by default
-        #if [[ "$lang" ==  "eng" ]]; then
-        #    continue
-        #fi
+		pkg="tesseract-ocr-$lang"
+		# English is installed by default
+		#if [[ "$lang" ==  "eng" ]]; then
+		#    continue
+		#fi
 
-        if dpkg -s $pkg &> /dev/null; then
-        	echo "package $pkg already installed!"
-        	continue
-        fi
+		if dpkg -s $pkg &>/dev/null; then
+			echo "Package $pkg already installed!"
+			continue
+		fi
 
-        if ! apt-cache show $pkg &> /dev/null; then
-        	echo "package $pkg not found! :("
-        	continue
-        fi
+		if ! apt-cache show $pkg &>/dev/null; then
+			echo "Package $pkg not found! :("
+			continue
+		fi
 
-				echo "Installing package $pkg..."
-				if ! apt-get -y install "$pkg" &> /dev/null; then
-					echo "Could not install $pkg"
-					exit 1
-				fi
-    done
+		echo "Installing package $pkg..."
+		if ! apt-get -y install "$pkg" &>/dev/null; then
+			echo "Could not install $pkg"
+			exit 1
+		fi
+	done
 }
 
 echo "Paperless-ng docker container starting..."
 
 # Install additional languages if specified
-if [[ ! -z "$PAPERLESS_OCR_LANGUAGES"  ]]; then
-		install_languages "$PAPERLESS_OCR_LANGUAGES"
+if [[ ! -z "$PAPERLESS_OCR_LANGUAGES" ]]; then
+	install_languages "$PAPERLESS_OCR_LANGUAGES"
 fi
 
 initialize
 
 if [[ "$1" != "/"* ]]; then
 	echo Executing management command "$@"
-	exec sudo -HEu paperless python3 manage.py "$@"
+	exec gosu paperless python3 manage.py "$@"
 else
 	echo Executing "$@"
 	exec "$@"
 fi
-

docker/docker-prepare.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+wait_for_postgres() {
+	attempt_num=1
+	max_attempts=5
+
+	echo "Waiting for PostgreSQL to start..."
+
+	host="${PAPERLESS_DBHOST}"
+	port="${PAPERLESS_DBPORT}"
+
+	if [[ -z $port ]]; then
+		port="5432"
+	fi
+
+	while ! </dev/tcp/$host/$port; do
+
+		if [ $attempt_num -eq $max_attempts ]; then
+			echo "Unable to connect to database."
+			exit 1
+		else
+			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
+
+		fi
+
+		attempt_num=$(expr "$attempt_num" + 1)
+		sleep 5
+	done
+}
+
+migrations() {
+	(
+		# flock is in place to prevent multiple containers from doing migrations
+		# simultaneously. This also ensures that the db is ready when the command
+		# of the current container starts.
+		flock 200
+		echo "Apply database migrations..."
+		python3 manage.py migrate
+	) 200>/usr/src/paperless/data/migration_lock
+}
+
+search_index() {
+	index_version=1
+	index_version_file=/usr/src/paperless/data/.index_version
+
+	if [[ (! -f "$index_version_file") || $(<$index_version_file) != "$index_version" ]]; then
+		echo "Search index out of date. Updating..."
+		python3 manage.py document_index reindex
+		echo $index_version | tee $index_version_file >/dev/null
+	fi
+}
+
+superuser() {
+	if [[ -n "${PAPERLESS_ADMIN_USER}" ]]; then
+		python3 manage.py manage_superuser
+	fi
+}
+
+do_work() {
+	if [[ -n "${PAPERLESS_DBHOST}" ]]; then
+		wait_for_postgres
+	fi
+
+	migrations
+
+	search_index
+
+	superuser
+
+}
+
+do_work

docker/install_management_commands.sh

@@ -0,0 +1,6 @@
+for command in document_archiver document_exporter document_importer mail_fetcher document_create_classifier document_index document_renamer document_retagger document_thumbnails document_sanity_checker manage_superuser;
+do
+	echo "installing $command..."
+	sed "s/management_command/$command/g" management_script.sh > /usr/local/bin/$command
+	chmod +x /usr/local/bin/$command
+done

docker/management_script.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -e
+
+cd /usr/src/paperless/src/
+
+if [[ $(id -u) == 0 ]] ;
+then
+  gosu paperless python3 manage.py management_command "$@"
+elif [[ $(id -un) == "paperless" ]] ;
+then
+  python3 manage.py management_command "$@"
+else
+  echo "Unknown user."
+fi

docker/supervisord.conf

@@ -8,7 +8,7 @@ loglevel=info                ; log level; default info; others: debug,warn,trace
 user=root
 
 [program:gunicorn]
-command=gunicorn -c /usr/src/paperless/gunicorn.conf.py paperless.wsgi
+command=gunicorn -c /usr/src/paperless/gunicorn.conf.py paperless.asgi:application
 user=paperless
 
 stdout_logfile=/dev/stdout

docs/administration.rst

@@ -20,6 +20,14 @@ Options available to any installation of paperless:
     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:
 
@@ -53,6 +61,9 @@ Restoring
 Updating Paperless
 ##################
 
+Docker Route
+============
+
 If a new release of paperless-ng is available, upgrading depends on how you
 installed paperless-ng in the first place. The releases are available at the
 `release page <https://github.com/jonaswinkler/paperless-ng/releases>`_.
@@ -72,10 +83,10 @@ A.  If you pull the image from the docker hub, all you need to do is:
 
         $ 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
@@ -85,64 +96,138 @@ B.  If you built the image yourself, do the following:
         $ docker-compose build
         $ docker-compose up
 
-Running `docker-compose up` will also apply any new database migrations.
+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-ng with ``-d`` to have it run in the background.
 
-Updating paperless without docker
-=================================
+    .. 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/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
+        or edit the ``docker-compose.yml`` file, find the line that says
+
+            .. code::
+
+                image: jonaswinkler/paperless-ng:0.9.x
+
+        and replace the version with ``latest``:
+
+            .. code::
+
+                image: jonaswinkler/paperless-ng:latest
+
+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 
+    dependencies. The dependencies required are listed in the section about
     :ref:`bare metal installations <setup-bare_metal>`.
 
-2.  Update python requirements. If you use Pipenv, this is done with the following steps.
+2.  Update python requirements. Keep in mind to activate your virtual environment
+    before that, if you use one.
 
     .. code:: shell-session
 
-        $ pip install --upgrade pipenv
-        $ cd /path/to/paperless
-        $ pipenv clean
-        $ pipenv install
+        $ pip install -r requirements.txt
 
-    This creates a new virtual environment (or uses your existing environment)
-    and installs all dependencies into it.
-
-    You can also use the included ``requirements.txt`` file instead and create the virtual
-    environment yourself. This file includes exactly the same dependencies.
-    
 3.  Migrate the database.
 
     .. code:: shell-session
 
         $ cd src
-        $ pipenv run python3 manage.py migrate
-    
+        $ python3 manage.py migrate
+
     This might not actually do anything. Not every new paperless version comes with new
     database migrations.
-    
-        
+
+Ansible Route
+=============
+
+Most of the update process is automated when using the ansible role.
+
+1.  Update the role to the target release tag to make sure the ansible scripts are compatible:
+
+    .. code:: shell-session
+
+        $ ansible-galaxy install git+https://github.com/jonaswinkler/paperless-ng.git,master --force
+
+2.  Update the role variable definitions ``vars/paperless-ng.yml`` (where appropriate).
+
+3.  Run the ansible playbook you created created during :ref:`installation <setup-ansible>` again:
+
+    .. note::
+
+        When ansible detects that an update run is in progress, it backs up the entire ``paperlessng_directory`` to ``paperlessng_directory-TIMESTAMP``.
+        Updates can be rolled back by simply moving the timestamped folder back to the original location.
+        If the update succeeds and you want to continue using the new release, please don't forget to delete the backup folder.
+
+    .. code:: shell-session
+
+        $ ansible-playbook playbook.yml
+
+
+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 either by
+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 run --rm webserver <command> <arguments>
+    $ docker-compose exec webserver <command> <arguments>
 
-or
+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
-    $ pipenv run python manage.py <command> <arguments>
-
-depending on whether you use docker or not.
+    $ python3 manage.py <command> <arguments>
 
 All commands have built-in help, which can be accessed by executing them with
 the argument ``--help``.
@@ -157,7 +242,12 @@ backup or migration to another DMS.
 
 .. code::
 
-    document_exporter target
+    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
@@ -167,6 +257,24 @@ 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:
 
@@ -297,6 +405,34 @@ the naming scheme.
 The command takes no arguments and processes all your documents at once.
 
 
+.. _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
 ===============
 
@@ -361,7 +497,7 @@ Documents can be stored in Paperless using GnuPG encryption.
     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
@@ -384,6 +520,3 @@ Basic usage to disable encryption of your document store:
 .. code::
 
     decrypt_documents [--passphrase SECR3TP4SSPHRA$E]
-
-
-.. _Pipenv: https://pipenv.pypa.io/en/latest/

docs/advanced_usage.rst

@@ -10,14 +10,13 @@ easier.
 Matching tags, correspondents and document types
 ################################################
 
-After the consumer has tried to figure out what it could from the file name,
-it starts looking at the content of the document itself.  It will compare the
-matching algorithms defined by every tag and correspondent already set in your
-database to see if they apply to the text in that document.  In other words,
-if you defined 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.
+Paperless will compare the matching algorithms defined by every tag and
+correspondent already set in your database to see if they apply to the text in
+a document.  In other words, if you defined 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, and supports searching the text of your
 document with different algorithms, and as such, some experimentation may be
@@ -217,6 +216,7 @@ will create a directory structure as follows:
 
 Paperless provides the following placeholders withing 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.

docs/api.rst

@@ -147,93 +147,57 @@ The REST api provides three different forms of authentication.
 Searching for documents
 #######################
 
-Paperless-ng offers API endpoints for full text search. These are as follows:
+Full text searching is available on the ``/api/documents/`` endpoint. Two specific
+query parameters cause the API to return full text search results:
 
-``/api/search/``
-================
+*   ``/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`.
 
-Get search results based on a query.
+*   ``/api/documents/?more_like=1234``: Search for documents similar to the document with id 1234.
 
-Query parameters:
+Pagination works exactly the same as it does for normal requests on this endpoint.
 
-*   ``query``: The query string. See
-    `here <https://whoosh.readthedocs.io/en/latest/querylang.html>`_
-    for details on the syntax.
-*   ``page``: Specify the page you want to retrieve. Each page
-    contains 10 search results and the first page is ``page=1``, which
-    is the default if this is omitted.
+Certain limitations apply to full text queries:
 
-Result list object returned by the endpoint:
+*   Results are always sorted by search score. The results matching the query best will show up first.
 
-.. code:: json
+*   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": 1,
-        "page": 1,
-        "page_count": 1,
-        "corrected_query": "",
+        "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
+                }
+            },
+
+            ...
+
         ]
     }
 
-*   ``count``: The approximate total number of results.
-*   ``page``: The page returned to you. This might be different from
-    the page you requested, if you requested a page that is behind
-    the last page. In that case, the last page is returned.
-*   ``page_count``: The total number of pages.
-*   ``corrected_query``: Corrected version of the query string. Can be null.
-    If not null, can be used verbatim to start a new query.
-*   ``results``: A list of result objects on the current page.
-
-Result object:
-
-.. code:: json
-
-    {
-        "id": 1,
-        "highlights": [
-
-        ],
-        "score": 6.34234,
-        "rank": 23,
-        "document": {
-
-        }
-    }
-
-*   ``id``: the primary key of the found document
-*   ``highlights``: an object containing parsable highlights for the result.
-    See below.
-*   ``score``: The score assigned to the document. A higher score indicates a
-    better match with the query. Search results are sorted descending by score.
-*   ``rank``: the position of the document within the entire search results list.
-*   ``document``: The full json of the document, as returned by
-    ``/api/documents/<id>/``.
-
-Highlights object:
-
-Highlights are provided as a list of fragments. A fragment is a longer section of
-text from the original document.
-Each fragment contains a list of strings, and some of them are marked as a highlight.
-
-.. code:: json
-
-    [
-        [
-            {"text": "This is a sample text with a ", "highlight": false},
-            {"text": "highlighted", "highlight": true},
-            {"text": " word.", "highlight": false}
-        ],
-        [
-            {"text": "Another", "highlight": true},
-            {"text": " fragment with a highlight.", "highlight": false}
-        ]
-    ]
-
-A client may use this example to produce the following output:
-
-... This is a sample text with a **highlighted** word. ... **Another** fragment with a highlight. ...
+*   ``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/``
 =============================
@@ -284,3 +248,53 @@ The endpoint supports the following optional form fields:
 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-ng 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``.

docs/changelog.rst

@@ -5,6 +5,350 @@
 Changelog
 *********
 
+paperless-ng 1.4.5
+##################
+
+This is a maintenance release.
+
+* Updated Python and Angular dependencies.
+* Changed the algorithm that changes permissions during startup. This is still fast,
+  and will hopefully cause less issues.
+* Fixed an issue that would sometimes cause paperless to write an incomplete
+  classification model file to disk.
+* Fixed an issue with the OCRmyPDF parser that would always try to extract text
+  with PDFminer even from non-PDF files.
+
+paperless-ng 1.4.4
+##################
+
+* Drastically decreased the startup time of the docker container. The startup script adjusts file permissions of all data only if changes are required.
+* Paperless mail: Added ability to specify the character set for each server.
+* Document consumption: Ignore Mac OS specific files such as ``.DS_STORE`` and ``._XXXXX.pdf``.
+* Fixed an issue with the automatic matching algorithm that prevents paperless from consuming new files.
+* Updated translations.
+
+paperless-ng 1.4.3
+##################
+
+* Additions and changes
+
+  * Added Swedish locale.
+  * `Stéphane Brunner`_ added an option to disable the progress bars of all management commands.
+  * `Jo Vandeginste`_ added support for RTF documents to the Apache TIKA parser.
+  * `Michael Shamoon`_ added dark mode for the login and logout pages.
+  * `Alexander Menk`_ added additional stylesheets for printing. You can now print any page of paperless and the print result will hide the page header, sidebar, and action buttons.
+  * Added support for sorting when using full text search.
+
+* Fixes
+
+  * `puuu`_ fixed ``PAPERLESS_FORCE_SCRIPT_NAME``. You can now host paperless on sub paths such as ``https://localhost:8000/paperless/``.
+  * Fixed an issue with the document consumer crashing on certain documents due to issues with pdfminer.six. This library is used for PDF text extraction.
+
+paperless-ng 1.4.2
+##################
+
+* Fixed an issue with ``sudo`` that caused paperless to not start on many Raspberry Pi devices. Thank you `WhiteHatTux`_!
+
+paperless-ng 1.4.1
+##################
+
+* Added Polish locale.
+
+* Changed some parts of the Dockerfile to hopefully restore functionality on certain ARM devices.
+
+* Updated python dependencies.
+
+* `Michael Shamoon`_ added a sticky filter / bulk edit bar.
+
+* `sbrl`_ changed the docker-entrypoint.sh script to increase compatibility with NFS shares.
+
+* `Chris Nagy`_ added support for creating a super user by passing ``PAPERLESS_ADMIN_USER`` and
+  ``PAPERLESS_ADMIN_PASSWORD`` as environment variables to the docker container.
+
+paperless-ng 1.4.0
+##################
+
+* Docker images now use tesseract 4.1.1, which should fix a series of issues with OCR.
+
+* The full text search now displays results using the default document list. This enables
+  selection, filtering and bulk edit on search results.
+
+* Changes
+
+  * Firefox only: Highlight search query in PDF previews.
+
+  * New URL pattern for accessing documents by ASN directly (http://<paperless>/asn/123)
+
+  * Added logging when executing pre- and post-consume scripts.
+
+  * Better error logging during document consumption.
+
+  * Updated python dependencies.
+
+  * Automatically inserts typed text when opening "Create new" dialogs on the document details page.
+
+* Fixes
+
+  * Fixed an issue with null characters in the document content.
+
+.. note::
+
+  The changed to the full text searching require you to reindex your documents.
+  *The docker image does this automatically, you don't need to do anything.*
+  To do this, execute the ``document_index reindex`` management command
+  (see :ref:`administration-index`).
+
+.. note::
+
+  Some packages that paperless depends on are slowly dropping Python 3.6
+  support one after another, including the web server. Supporting Python
+  3.6 means that I cannot update these packages anymore.
+
+  At some point, paperless will drop Python 3.6 support. If using a bare
+  metal installation and you're still on Python 3.6, upgrade to 3.7 or newer.
+
+  If using docker, this does not affect you.
+
+paperless-ng 1.3.2
+##################
+
+* Added translation into Portuguese.
+
+* Changes
+
+  * The exporter now exports user accounts, mail accounts, mail rules and saved views as well.
+
+* Fixes
+
+  * Minor layout issues with document cards and the log viewer.
+
+  * Fixed an issue with any/all/exact matching when characters used in regular expressions were used for the match.
+
+paperless-ng 1.3.1
+##################
+
+* Added translation into Spanish and Russian.
+
+* Other changes
+
+  * ISO-8601 date format will now always show years with 4 digits.
+
+  * Added the ability to search for a document with a specific ASN.
+
+  * The document cards now display ASN, types and dates in a more organized way.
+
+  * Added document previews when hovering over the preview button.
+
+* Fixes
+
+  * The startup check for write permissions now works properly on NFS shares.
+
+  * Fixed an issue with the search results score indicator.
+
+  * Paperless was unable to generate thumbnails for encrypted PDF files and failed. Paperless will now generate a default thumbnail for these files.
+
+  * Fixed ``AUTO_LOGIN_USERNAME``: Unable to perform POST/PUT/DELETE requests and unable to receive WebSocket messages.
+
+paperless-ng 1.3.0
+##################
+
+This release contains new database migrations.
+
+* Changes
+
+  * The REST API is versioned from this point onwards. This will allow me to make changes without breaking existing clients. See the documentation about :ref:`api-versioning` for details.
+
+  * Added a color picker for tag colors.
+
+  * Added the ability to use the filter for searching the document content as well.
+
+  * Added translations into Italian and Romanian. Thank you!
+
+  * Close individual documents from the sidebar. Thanks to `Michael Shamoon`_.
+
+  * `BolkoSchreiber <https://github.com/BolkoSchreiber>`_ added an option to disable/enable thumbnail inversion in dark mode.
+
+  * `Simon Taddiken <https://github.com/skuzzle>`_ added the ability to customize the header used for remote user authentication with SSO applications.
+
+* Bug fixes
+
+  * Fixed an issue with the auto matching algorithm when more than 256 tags were used.
+
+
+paperless-ng 1.2.1
+##################
+
+* `Rodrigo Avelino <https://github.com/rodavelino>`_ translated Paperless into Portuguese (Brazil)!
+
+* The date input fields now respect the currently selected date format.
+
+* Added a fancy icon when adding paperless to the home screen on iOS devices. Thanks to `Joel Nordell <https://github.com/joelnordell>`_.
+
+* When using regular expression matching, the regular expression is now validated before saving the tag/correspondent/type.
+
+* Regression fix: Dates on the front end did not respect date locale settings in some cases.
+
+paperless-ng 1.2.0
+##################
+
+* Changes to the OCRmyPDF integration
+
+  * Added support for deskewing and automatic rotation of incorrectly rotated pages. This is enabled by default, see :ref:`configuration-ocr`.
+  * Better support for encrypted files.
+  * Better support for various other PDF files: Paperless will now attempt to force OCR with safe options when OCR fails with the configured options.
+  * Added an explicit option to skip cleaning with ``unpaper``.
+
+* Download multiple selected documents as a zip archive.
+
+* The document list now remembers the current page.
+
+* Improved responsiveness when switching between saved views and the document list.
+
+* Increased the default wait time when observing files in the consumption folder
+  with polling from 1 to 5 seconds. This will decrease the likelihood of paperless
+  consuming partially written files.
+
+* Fixed a crash of the document archiver management command when trying to process documents with unknown mime types.
+
+* Paperless no longer depends on ``libpoppler-cpp-dev``.
+
+paperless-ng 1.1.4
+##################
+
+* Added English (GB) locale.
+
+* Added ISO-8601 date display option.
+
+paperless-ng 1.1.3
+##################
+
+* Added a docker-specific configuration option to adjust the number of
+  worker processes of the web server. See :ref:`configuration-docker`.
+
+* Some more memory usage optimizations.
+
+* Don't show inbox statistics if no inbox tag is defined.
+
+paperless-ng 1.1.2
+##################
+
+* Always show top left corner of thumbnails, even for extra wide documents.
+
+* Added a management command for executing the sanity checker directly.
+  See :ref:`utilities-sanity-checker`.
+
+* The weekly sanity check now reports messages in the log files.
+
+* Fixed an issue with the metadata tab not reporting anything in case of missing files.
+
+* Reverted a change from 1.1.0 that caused huge memory usage due to redis caching.
+
+* Some memory usage optimizations.
+
+paperless-ng 1.1.1
+##################
+
+This release contains new database migrations.
+
+* Fixed a bug in the sanity checker that would cause it to display "x not in list" errors instead of actual issues.
+
+* Fixed a bug with filename generation for archive filenames that would cause the archive files of two documents to overlap.
+
+  * This happened when ``PAPERLESS_FILENAME_FORMAT`` is used and the filenames of two or more documents are the same, except for the file extension.
+  * Paperless will now store the archive filename in the database as well instead of deriving it from the original filename, and use the
+    same logic for detecting and avoiding filename clashes that's also used for original filenames.
+  * The migrations will repair any missing archive files. If you're using tika, ensure that tika is running while performing the migration. Docker-compose will take care of that.
+
+* Fixed a bug with thumbnail regeneration when TIKA integration was used.
+
+* Added ASN as a placeholder field to the filename format.
+
+* The docker image now comes with built-in shortcuts for most management commands. These are now the recommended way to execute management commands, since these
+  also ensure that they're always executed as the paperless user and you're less likely to run into permission issues. See :ref:`utilities-management-commands`.
+
+paperless-ng 1.1.0
+##################
+
+* Document processing status
+
+  * Paperless now shows the status of processing documents on the dashboard in real time.
+  * Status notifications when
+
+    * New documents are detected in the consumption folder, in mails, uploaded on the front end,
+      or added with one of the mobile apps.
+    * Documents are successfully added to paperless.
+    * Document consumption failed (with error messages)
+
+  * Configuration options to enable/disable individual notifications.
+
+* Live updates to document lists and saved views when new documents are added.
+
+  .. hint::
+
+    For status notifications and live updates to work, paperless now requires an `ASGI <https://asgi.readthedocs.io/en/latest/>`_-enabled
+    web server. The docker images uses ``gunicorn`` and an ASGI-enabled worker called `uvicorn <http://www.uvicorn.org/>`_,
+    and there is no need to configure anything.
+
+    For bare metal installations, changes are required for the notifications to work. Adapt the service ``paperless-webserver.service``
+    to use the supplied ``gunicorn.conf.py`` configuration file and adapt the reference to the ASGI application as follows:
+
+    .. code::
+
+      ExecStart=/opt/paperless/.local/bin/gunicorn -c /opt/paperless/gunicorn.conf.py paperless.asgi:application
+
+    Paperless will continue to work with WSGI, but you will not get any status notifications.
+
+    Apache ``mod_wsgi`` users, see :ref:`this note <faq-mod_wsgi>`.
+
+* Paperless now offers suggestions for tags, correspondents and types on the document detail page.
+
+* Added an interactive easy install script that automatically downloads, configures and starts paperless with docker.
+
+* Official support for Python 3.9.
+
+* Other changes and fixes
+
+  * Adjusted the default parallelization settings to run more than one task in parallel on systems with 4 or less cores.
+    This addresses issues with paperless not consuming any new files when other tasks are running.
+
+  * Fixed a rare race condition that would cause paperless to process incompletely written files when using the upload on the dashboard.
+
+  * The document classifier no longer issues warnings and errors when auto matching is not used at all.
+
+  * Better icon for document previews.
+
+  * Better info section in the side bar.
+
+  * Paperless no longer logs to the database. Instead, logs are written to rotating log files. This solves many "database is locked"
+    issues on Raspberry Pi, especially when SQLite is used.
+
+  * By default, log files are written to ``PAPERLESS_DATA_DIR/log/``. Logging settings can be adjusted with
+    ``PAPERLESS_LOGGING_DIR``, ``PAPERLESS_LOGROTATE_MAX_SIZE`` and
+    ``PAPERLESS_LOGROTATE_MAX_BACKUPS``.
+
+paperless-ng 1.0.0
+##################
+
+Nothing special about this release, but since there are relatively few bug reports coming in, I think that this is reasonably stable.
+
+* Document export
+
+  * The document exporter has been rewritten to support updating an already existing export in place.
+    This enables incremental backups with ``rsync``.
+  * The document exporter supports naming exported files according to ``PAPERLESS_FILENAME_FORMAT``.
+  * The document exporter locks the media directory and the database during execution to ensure that
+    the resulting export is consistent.
+  * See the :ref:`updated documentation <utilities-exporter>` for more details.
+
+* Other changes and additions
+
+  * Added a language selector to the settings.
+  * Added date format options to the settings.
+  * Range selection with shift clicking is now possible in the document list.
+  * Filtering correspondent, type and tag management pages by name.
+  * Focus "Name" field in dialogs by default.
+
+
 paperless-ng 0.9.14
 ###################
 
@@ -116,7 +460,7 @@ paperless-ng 0.9.10
   * There are some configuration options in the settings to alter the behavior.
 
 * Other changes and additions
-  
+
   * Thanks to `zjean`_, paperless now publishes a webmanifest, which is useful for adding the application to home screens on mobile devices.
   * The Paperless-ng logo now navigates to the dashboard.
   * Filter for documents that don't have any correspondents, types or tags assigned.
@@ -136,7 +480,7 @@ paperless-ng 0.9.10
   The bulk delete operations did not update the search index. Therefore, documents that you deleted remained in the index and
   caused the search to return messages about missing documents when searching. Further bulk operations will properly update
   the index.
-  
+
   However, this change is not retroactive: If you used the delete method of the bulk editor, you need to reindex your search index
   by :ref:`running the management command document_index with the argument reindex <administration-index>`.
 
@@ -191,12 +535,12 @@ paperless-ng 0.9.7
 
   * Thanks to the hard work of `Michael Shamoon`_, paperless now comes with a much more streamlined UI for
     filtering documents.
-  
+
   * `Michael Shamoon`_ replaced the document preview with another component. This should fix compatibility with Safari browsers.
 
   * Added buttons to the management pages to quickly show all documents with one specific tag, correspondent, or title.
-  
-  * Paperless now stores your saved views on the server and associates them with your user account. 
+
+  * Paperless now stores your saved views on the server and associates them with your user account.
     This means that you can access your views on multiple devices and have separate views for different users.
     You will have to recreate your views.
 
@@ -214,7 +558,7 @@ paperless-ng 0.9.7
     This option enables you to be logged in into multiple instances by specifying different cookie names for each instance.
 
 * Fixes
-  
+
   * Sometimes paperless would assign dates in the future to newly consumed documents.
   * The filename format fields ``{created_month}`` and ``{created_day}`` now use a leading zero for single digit values.
   * The filename format field ``{tags}`` can no longer be used without arguments.
@@ -1061,6 +1405,11 @@ bulk of the work on this big change.
 
 * Initial release
 
+.. _Alexander Menk: https://github.com/amenk
+.. _puuu: https://github.com/puuu
+.. _WhiteHatTux: https://github.com/WhiteHatTux
+.. _Chris Nagy: https://github.com/what-name
+.. _sbrl: https://github.com/sbrl
 .. _slorenz: https://github.com/sisao
 .. _Jo Vandeginste: https://github.com/jovandeginste
 .. _zjean: https://github.com/zjean

docs/conf.py

@@ -28,7 +28,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Paperless-ng'
-copyright = u'2015, Daniel Quinn'
+copyright = u'2021, Daniel Quinn, Jonas Winkler'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/configuration.rst

@@ -72,13 +72,13 @@ PAPERLESS_CONSUMPTION_DIR=<path>
     container. Change the local consumption directory in the docker-compose.yml
     file instead.
 
-    Defaults to "../consume", relative to the "src" directory.
+    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.
+    Defaults to "../data/", relative to the "src" directory.
 
 PAPERLESS_MEDIA_ROOT=<path>
     This is where your documents and thumbnails are stored.
@@ -86,7 +86,7 @@ PAPERLESS_MEDIA_ROOT=<path>
     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.
+    Defaults to "../media/", relative to the "src" directory.
 
 PAPERLESS_STATICDIR=<path>
     Override the default STATIC_ROOT here.  This is where all static files
@@ -94,7 +94,7 @@ PAPERLESS_STATICDIR=<path>
 
     Unless you're doing something fancy, there is no need to override this.
 
-    Defaults to "../static", relative to the "src" directory.
+    Defaults to "../static/", relative to the "src" directory.
 
 PAPERLESS_FILENAME_FORMAT=<format>
     Changes the filenames paperless uses to store documents in the media directory.
@@ -102,6 +102,25 @@ PAPERLESS_FILENAME_FORMAT=<format>
 
     Default is none, 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 & Security
 ##################
 
@@ -135,10 +154,6 @@ 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!
 
-    .. note::
-
-        I don't know if this works in paperless-ng. Probably not.
-
     Defaults to none, which hosts paperless at "/".
 
 PAPERLESS_STATIC_URL=<path>
@@ -158,6 +173,30 @@ PAPERLESS_AUTO_LOGIN_USERNAME=<username>
 
     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 seperately, 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
@@ -172,8 +211,28 @@ 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`.
+
 .. _configuration-ocr:
 
 OCR settings
@@ -183,7 +242,6 @@ 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.
@@ -226,6 +284,54 @@ PAPERLESS_OCR_MODE=<mode>
     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.
 
@@ -252,7 +358,6 @@ PAPERLESS_OCR_PAGES=<num>
 
     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.
@@ -263,17 +368,17 @@ PAPERLESS_OCR_IMAGE_DPI=<num>
 
     Set this to the DPI your scanner produces images at.
 
-    Default is none, which causes paperless to fail if no DPI information is
-    present in an image.
+    Default is none, which will automatically calculate image DPI so that
+    the produced PDF documents are A4 sized.
 
 
-PAPERLESS_OCR_USER_ARG=<json>
+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 dashed.
+    use underscores instead of dashes.
 
     .. caution::
 
@@ -333,7 +438,7 @@ requires are as follows:
                 PAPERLESS_TIKA_ENABLED: 1
                 PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
                 PAPERLESS_TIKA_ENDPOINT: http://tika:9998
-        
+
         # ...
 
         gotenberg:
@@ -376,25 +481,24 @@ PAPERLESS_THREADS_PER_WORKER=<num>
         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, and leaving at least one core
-    free for other tasks:
+    with a slight favor towards threads per worker:
 
     +----------------+---------+---------+
     | CPU core count | Workers | Threads |
     +----------------+---------+---------+
     |              1 |       1 |       1 |
     +----------------+---------+---------+
-    |              2 |       1 |       1 |
+    |              2 |       2 |       1 |
     +----------------+---------+---------+
-    |              4 |       1 |       3 |
+    |              4 |       2 |       2 |
     +----------------+---------+---------+
-    |              6 |       2 |       2 |
+    |              6 |       2 |       3 |
     +----------------+---------+---------+
-    |              8 |       2 |       3 |
+    |              8 |       2 |       4 |
     +----------------+---------+---------+
-    |             12 |       3 |       3 |
+    |             12 |       3 |       4 |
     +----------------+---------+---------+
-    |             16 |       3 |       5 |
+    |             16 |       4 |       4 |
     +----------------+---------+---------+
 
     If you only specify PAPERLESS_TASK_WORKERS, paperless will adjust
@@ -518,6 +622,14 @@ PAPERLESS_IGNORE_DATES=<string>
 
     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.
+
+
 
 Binaries
 ########
@@ -537,3 +649,65 @@ PAPERLESS_GS_BINARY=<path>
 
 PAPERLESS_OPTIPNG_BINARY=<path>
     Defaults to "/usr/bin/optipng".
+
+
+.. _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.
+
+    Consider configuring this to 1 on low power devices with limited amount of RAM.
+
+    Defaults to 2.
+
+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.

docs/contributing.rst

@@ -6,7 +6,7 @@ Contributing to Paperless
 .. warning::
 
     This section is not updated to paperless-ng yet.
-    
+
 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 Free software is that you can see what's wrong and help to get it

docs/extending.rst

@@ -5,29 +5,82 @@ Paperless development
 
 This section describes the steps you need to take to start development on paperless-ng.
 
-1.  Check out the source from github. The repository is organized in the following way:
+Check out the source from github. The repository is organized in the following way:
 
-    *   ``master`` 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.
-    
-    Apart from that, the folder structure is as follows:
+*   ``master`` 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.
 
-    *   ``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.
+When making functional changes to paperless, *always* make your changes on the ``dev`` branch.
 
-2.  Install some dependencies.
+Apart from that, the folder structure is as follows:
 
-    *   Python 3.6.
-    *   All dependencies listed in the :ref:`Bare metal route <setup-bare_metal>`
-    *   redis. You can either install redis or use the included scritps/start-services.sh
-        to use docker to fire up a redis instance (and some other services such as tika,
-        gotenberg and a postgresql server).
+*   ``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.
+
+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.  Create ``consume`` and ``media`` folders in the cloned root folder.
+
+    .. code:: shell-session
+
+        mkdir -p consume media
+
+5.  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 postgresql server) or
+    *  spin up a bare redis container
+
+        .. code:: shell-session
+
+            docker run -d -p 6379:6379 -restart unless-stopped redis:latest
+
+6.  Install the python dependencies by performing in the src/ directory.
+
+    .. code:: shell-session
+
+        pipenv install --dev
+
+7.  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 root folder:
+
+    .. code:: shell-session
+
+        compile-frontend.sh
+
+8.  Apply migrations and create a superuser for your dev instance:
+
+    .. code:: shell-session
+
+        python3 manage.py migrate
+        python3 manage.py createsuperuser
+
+9.  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
+
+10. 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
 ====================
@@ -35,21 +88,18 @@ Back end development
 The backend is a django application. I use PyCharm for development, but you can use whatever
 you want.
 
-Install the python dependencies by performing ``pipenv install --dev`` in the src/ directory.
-This will also create a virtual environment, which you can enter with ``pipenv shell`` or
-execute one-shot commands in with ``pipenv run``.
-
-Copy ``paperless.conf.example`` to ``paperless.conf`` and enable debug mode.
-
 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 consumer
+*   python3 manage.py document_consumer
 
-Depending on which part of paperless you're developing for, you need to have some or all of
-them running.
+To start them all:
+
+.. code:: shell-session
+
+    python3 manage.py runserver & python3 manage.py document_consumer & python3 manage.py qcluster
 
 Testing and code style:
 
@@ -62,7 +112,7 @@ Testing and code style:
 
         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 make some lines fit, especially complicated IF cases. Append ``# NOQA: E501``
         to disable this check for certain lines.
 
 Front end development
@@ -109,6 +159,133 @@ This will build the front end and put it in a location from which the Django ser
 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
+=========================
+
+Building the docker image from source requires the following two steps:
+
+1.  Build the front end.
+
+    .. code:: shell-session
+
+        ./compile-frontend.sh
+
+2.  Build the docker image.
+
+    .. code:: shell-session
+
+        docker build . -t <your-tag>
+
 Extending Paperless
 ===================
 
@@ -143,7 +320,7 @@ methods ``parse`` and ``get_thumbnail``. You can provide your own implementation
 
             # 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")
 

docs/faq.rst

@@ -62,21 +62,28 @@ file extensions do not matter.
 
 **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 tesseract OCR. On Raspberry Pi,
+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 should be a lot snappier, since it runs
+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-ng on Raspberry Pi?*
 
 **A:** Docker images are available for arm and arm64 hardware, so just follow
-the docker-compose instructions, or go the bare metal route.
+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?*
 
@@ -95,12 +102,21 @@ occasionally build the image on and see if it works.
 
 **Q:** *How do I proxy this with NGINX?*
 
-.. code::
+**A:** See :ref:`here <setup-nginx>`.
 
-    location / {
-        proxy_pass http://localhost:8000/
-    }
+.. _faq-mod_wsgi:
 
-And that's about it. Paperless serves everything, including static files by itself
-when running the docker image. If you want to do anything fancy, you have to
-install paperless bare metal.
+**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

docs/index.rst

@@ -49,7 +49,7 @@ resources in the documentation:
     paperless-ng.
 *   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. 
+    at a glance when and why something is not working.
 *   The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes
     in paperless-ng.
 
@@ -70,8 +70,8 @@ Contents
    configuration
    api
    faq
-   extending
    troubleshooting
+   extending
    contributing
    scanners
    screenshots

docs/scanners.rst

@@ -13,26 +13,35 @@ that works right for you based on recommendations from other Paperless users.
 Physical scanners
 =================
 
-+---------+----------------+-----+-----+-----+----------------+
-| Brand   | Model          | Supports        | Recommended By |
-+---------+----------------+-----+-----+-----+----------------+
-|         |                | FTP | NFS | SMB |                |
-+=========+================+=====+=====+=====+================+
-| Brother | `ADS-1500W`_   | yes | no  | yes | `danielquinn`_ |
-+---------+----------------+-----+-----+-----+----------------+
-| Brother | `MFC-J6930DW`_ | yes |     |     | `ayounggun`_   |
-+---------+----------------+-----+-----+-----+----------------+
-| Brother | `MFC-J5910DW`_ | yes |     |     | `bmsleight`_   |
-+---------+----------------+-----+-----+-----+----------------+
-| Brother | `MFC-9142CDN`_ | yes |     | yes | `REOLDEV`_     |
-+---------+----------------+-----+-----+-----+----------------+
-| Fujitsu | `ix500`_       | yes |     | yes | `eonist`_      |
-+---------+----------------+-----+-----+-----+----------------+
-| Epson   | `WF-7710DWF`_  | yes |     | yes | `Skylinar`_    |
-+---------+----------------+-----+-----+-----+----------------+
-| Fujitsu | `S1300i`_      | yes |     | yes | `jonaswinkler`_|
-+---------+----------------+-----+-----+-----+----------------+
++---------+----------------+-----+-----+-----+------+----------------+
+| Brand   | Model          | Supports               | Recommended By |
++---------+----------------+-----+-----+-----+------+----------------+
+|         |                | FTP | NFS | SMB | SMTP |                |
++=========+================+=====+=====+=====+======+================+
+| Brother | `ADS-1700W`_   | yes | no  | yes | yes  |`holzhannes`_   |
++---------+----------------+-----+-----+-----+------+----------------+
+| Brother | `ADS-1600W`_   | yes | no  | yes | yes  |`holzhannes`_   |
++---------+----------------+-----+-----+-----+------+----------------+
+| Brother | `ADS-1500W`_   | yes | no  | yes | yes  |`danielquinn`_  |
++---------+----------------+-----+-----+-----+------+----------------+
+| Brother | `MFC-J6930DW`_ | yes |     |     |      |`ayounggun`_    |
++---------+----------------+-----+-----+-----+------+----------------+
+| Brother | `MFC-L5850DW`_ | yes |     |     | yes  |`holzhannes`_   |
++---------+----------------+-----+-----+-----+------+----------------+
+| Brother | `MFC-J5910DW`_ | yes |     |     |      |`bmsleight`_    |
++---------+----------------+-----+-----+-----+------+----------------+
+| Brother | `MFC-9142CDN`_ | yes |     | yes |      |`REOLDEV`_      |
++---------+----------------+-----+-----+-----+------+----------------+
+| Fujitsu | `ix500`_       | yes |     | yes |      |`eonist`_       |
++---------+----------------+-----+-----+-----+------+----------------+
+| Epson   | `WF-7710DWF`_  | yes |     | yes |      |`Skylinar`_     |
++---------+----------------+-----+-----+-----+------+----------------+
+| Fujitsu | `S1300i`_      | yes |     | yes |      |`jonaswinkler`_ |
++---------+----------------+-----+-----+-----+------+----------------+
 
+.. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw
+.. _ADS-1700W: https://www.brother-usa.com/products/ads1700w
+.. _ADS-1600W: https://www.brother-usa.com/products/ads1600w
 .. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
 .. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
 .. _MFC-J5910DW: https://www.brother.co.uk/printers/inkjet-printers/mfcj5910dw
@@ -41,6 +50,7 @@ Physical scanners
 .. _WF-7710DWF: https://www.epson.de/en/products/printers/inkjet-printers/for-home/workforce-wf-7710dwf
 .. _S1300i: https://www.fujitsu.com/global/products/computing/peripheral/scanners/soho/s1300i/
 
+
 .. _danielquinn: https://github.com/danielquinn
 .. _ayounggun: https://github.com/ayounggun
 .. _bmsleight: https://github.com/bmsleight
@@ -48,25 +58,33 @@ Physical scanners
 .. _REOLDEV: https://github.com/REOLDEV
 .. _Skylinar: https://github.com/Skylinar
 .. _jonaswinkler: https://github.com/jonaswinkler
+.. _holzhannes: https://github.com/holzhannes
 
 Mobile phone software
 =====================
 
 You can use your phone to "scan" documents. The regular camera app will work, but may have too low contrast for OCR to work well. Apps specifically for scanning are recommended.
 
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
-| Name              | OS             | Supports                         | Recommended By |
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
-|                   |                | FTP | NFS | SMB | Email | WebDav |                |
-+===================+================+=====+=====+=====+=======+========+================+
-| `Office Lens`_    | Android        | ?   | ?   | ?   | ?     | ?      | `jonaswinkler`_|
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
-| `Genius Scan`_    | Android        | yes | no  | yes | yes   | yes    | `hannahswain`_ |
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
++-------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| Name              | OS             | Supports                         | Recommended By   |
++-------------------+----------------+-----+-----+-----+-------+--------+------------------+
+|                   |                | FTP | NFS | SMB | Email | WebDav |                  |
++===================+================+=====+=====+=====+=======+========+==================+
+| `Office Lens`_    | Android        | ?   | ?   | ?   | ?     | ?      | `jonaswinkler`_  |
++-------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| `Genius Scan`_    | Android        | yes | no  | yes | yes   | yes    | `hannahswain`_   |
++-------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| `OpenScan`_       | Android        | no  | no  | no  | no    | no     | `benjaminfrank`_ |
++-------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| `Quick Scan`_     | iOS            | no  | no  | no  | no    | no     | `holzhannes`_    |
++-------------------+----------------+-----+-----+-----+-------+--------+------------------+
 
-On Android, you can use these applications in combination with one of the :ref:`Paperless-ng compatible apps <usage-mobile_upload>` to "Share" the documents produced by these scanner apps with paperless.
+On Android, you can use these applications in combination with one of the :ref:`Paperless-ng compatible apps <usage-mobile_upload>` to "Share" the documents produced by these scanner apps with paperless. On iOS, you can share the scanned documents via iOS-Sharing to other mail, WebDav or FTP apps.
 
 .. _Office Lens: https://play.google.com/store/apps/details?id=com.microsoft.office.officelens
 .. _Genius Scan: https://play.google.com/store/apps/details?id=com.thegrizzlylabs.geniusscan.free
+.. _Quick Scan: https://apps.apple.com/us/app/quickscan-scanner-text-ocr/id1513790291
+.. _OpenScan: https://github.com/Ethereal-Developers-Inc/OpenScan
 
 .. _hannahswain: https://github.com/hannahswain
+.. _benjaminfrank: https://github.com/benjaminfrank

docs/setup.rst

@@ -20,45 +20,45 @@ Paperless consists of the following components:
     .. code:: shell-session
 
         $ cd /path/to/paperless/src/
-        $ pipenv run gunicorn -c /usr/src/paperless/gunicorn.conf.py -b 0.0.0.0:8000 paperless.wsgi
+        $ 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 consume really consume your documents anymore.
-    It rather notifies a task processor that a new file is ready for consumption.
+    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 also used to check your emails, but that's now gone elsewhere as well.
+    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/
-        $ pipenv run python3 manage.py document_consumer
+        $ 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 much of the heavy lifting. This is a task queue that accepts tasks from
-    multiple sources and processes tasks in parallel. It also comes with a scheduler that executes
+    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.
-    *   Consuming emails. It periodically checks your configured accounts for new mails and
-        produces consumption tasks for any documents it finds.
     *   The task processor also performs the consumption of any documents you upload through
         the web interface.
-    *   Maintain the search index and the automatic matching algorithm. These are things that paperless
+    *   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, consumption with full ocr is blazing fast.
+    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 see whenever any of the
+    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).
 
@@ -67,11 +67,11 @@ Paperless consists of the following components:
     .. code:: shell-session
 
         $ cd /path/to/paperless/src/
-        $ pipenv run python3 manage.py qcluster
+        $ 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 consumer to the task scheduler. These run in different
-    processes (maybe even on different machines!), and therefore, this is necessary.
+    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 both PostgreSQL and SQLite for storing its data.
 
@@ -79,28 +79,56 @@ Paperless consists of the following components:
 Installation
 ############
 
-You can go multiple routes with setting up and running Paperless:
+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 (bare metal) <setup-bare_metal>`
+* :ref:`Install Paperless directly on your system manually (bare metal) <setup-bare_metal>`
+* :ref:`Use ansible to install Paperless on your system automatically (bare metal) <setup-ansible>`
 
 The Docker routes are quick & easy. These are the recommended routes. This configures all the stuff
-from above automatically so that it just works and uses sensible defaults for all configuration options.
+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://sehn.tech/post/devops-with-docker/>`_
 
-The bare metal route is more complicated to setup but makes it easier
+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.
 
+The ansible route combines benefits of both options:
+the setup process is fully automated, reproducible and `idempotent <https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency>`_,
+it includes the same sensible defaults, and it simultaneously provides the flexibility of a bare metal installation.
+
+.. _CLI Basics: https://sehn.tech/post/devops-with-docker/
+.. _idempotent: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency
+
+.. _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
+
+        $ curl -L https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/install-paperless-ng.sh | bash
+
 .. _setup-docker_hub:
 
 Install Paperless from Docker Hub
 =================================
 
-1.  Go to the `/docker/compose directory on the project page <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
-    and download one of the ``docker-compose.*.yml`` files, depending on which database backend you
+1.  Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ng` 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/jonaswinkler/paperless-ng/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 its name.
+    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.
 
@@ -109,25 +137,26 @@ Install Paperless from Docker Hub
         For new installations, it is recommended to use PostgreSQL as the database
         backend.
 
-2.  Install `Docker`_ and `docker-compose`_.
+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 an up-to-date version of docker-compose, follow the
+        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/
 
-3.  Modify ``docker-compose.yml`` to your preferences. You may want to change the path
-    to the consumption directory in this file. Find the line that specifies where
+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::
@@ -143,31 +172,34 @@ Install Paperless from Docker Hub
     Don't change the part after the colon or paperless wont find your documents.
 
 
-4.  Modify ``docker-compose.env``, following the comments in the file. The
+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. This ensures that
+    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.
+    work out of the box without any modifications. `id "username"` to check.
 
     .. note::
 
-        You can use any settings from the file ``paperless.conf.example`` in this file.
-        Have a look at :ref:`configuration` to see whats available.
+        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.
 
     .. caution::
 
-        Certain file systems such as NFS network shares don't support file system
+        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 be unable to pick up new files
+        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>`.
 
-5.  Run ``docker-compose up -d``. This will create and start the necessary
-    containers.
+6.  Run ``docker-compose pull``, followed by ``docker-compose up -d``.
+    This will pull the image, create and start the necessary containers.
 
-6.  To be able to login, you will need a super user. To create it, execute the
+7.  To be able to login, you will need a super user. To create it, execute the
     following command:
 
     .. code-block:: shell-session
@@ -175,19 +207,19 @@ Install Paperless from Docker Hub
         $ docker-compose run --rm webserver createsuperuser
 
     This will prompt you to set a username, an optional e-mail address and
-    finally a password.
+    finally a password (at least 8 characters).
 
-7.  The default ``docker-compose.yml`` exports the webserver on your local port
-    8000. If you haven't adapted this, you should now be able to visit your
-    Paperless instance at ``http://127.0.0.1:8000``. You can login with the
-    user and password you just created.
+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
+Build the Docker image yourself
 ===============================
 
 1.  Clone the entire repository of paperless:
@@ -208,7 +240,7 @@ Build the docker image yourself
 
         webserver:
             image: jonaswinkler/paperless-ng:latest
-    
+
     and replace it with a line that instructs docker-compose to build the image from the current working directory instead:
 
     .. code:: yaml
@@ -218,14 +250,14 @@ Build the docker image yourself
 
 4.  Run the ``compile-frontend.sh`` script. This requires ``node`` and ``npm >= v15``.
 
-5.  Follow steps 2 to 7 of :ref:`setup-docker_hub`. When asked to run
-    ``docker-compose up -d`` to start the containers, do
+5.  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
 
-    before that to build the image.
+    instead to build the image.
 
 .. _setup-bare_metal:
 
@@ -238,19 +270,24 @@ writing. Windows is not and will never be supported.
 
 1.  Install dependencies. Paperless requires the following packages.
 
-    *   ``python3`` 3.6, 3.7, 3.8 (3.9 is untested).
-    *   ``python3-pip``, optionally ``pipenv`` for package installation
+    *   ``python3`` 3.6, 3.7, 3.8, 3.9
+    *   ``python3-pip``
     *   ``python3-dev``
 
     *   ``fonts-liberation`` for generating thumbnails for plain text files
     *   ``imagemagick`` >= 6 for PDF conversion
     *   ``optipng`` for optimizing thumbnails
     *   ``gnupg`` for handling encrypted documents
-    *   ``libpoppler-cpp-dev`` for PDF to text conversion
     *   ``libpq-dev`` for PostgreSQL
     *   ``libmagic-dev`` for mime type detection
     *   ``mime-support`` for mime type detection
 
+    Use this list for your preferred package management:
+
+    .. code::
+
+        python3 python3-pip python3-dev imagemagick fonts-liberation optipng gnupg libpq-dev libmagic-dev mime-support
+
     These dependencies are required for OCRmyPDF, which is used for text recognition.
 
     *   ``unpaper``
@@ -264,6 +301,12 @@ writing. Windows is not and will never be supported.
     *   ``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``
@@ -275,7 +318,7 @@ writing. Windows is not and will never be supported.
 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, SQLite is avialable as well.
+    to use PostgreSQL, SQLite is available as well.
 
 4.  Get the release archive from `<https://github.com/jonaswinkler/paperless-ng/releases>`_.
     If you clone the git repo as it is, you also have to compile the front end by yourself.
@@ -299,8 +342,14 @@ writing. Windows is not and will never be supported.
     *   Set ``PAPERLESS_OCR_LANGUAGE`` to the language most of your documents are written in.
     *   Set ``PAPERLESS_TIME_ZONE`` to your local time zone.
 
-6.  Setup permissions. Create a system users under which you wish to run paperless. Ensure that these directories exist
-    and that the user has write permissions to the following directories
+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``
@@ -308,39 +357,51 @@ writing. Windows is not and will never be supported.
 
     Adjust as necessary if you configured different folders.
 
-7.  Install python requirements. Paperless comes with both Pipfiles for ``pipenv`` as well as with a ``requirements.txt``.
-    Both will install exactly the same requirements. It is up to you if you wish to use a virtual environment or not.
+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.
 
-8.  Go to ``/opt/paperless/src``, and execute the following commands:
+    .. 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.
-        python3 manage.py migrate
+        sudo -Hu paperless python3 manage.py migrate
 
         # This creates your first paperless user
-        python3 manage.py createsuperuser
+        sudo -Hu paperless python3 manage.py createsuperuser
 
-9.  Optional: Test that paperless is working by executing
+10. Optional: Test that paperless is working by executing
 
       .. code:: bash
 
         # This collects static files from paperless and django.
-        python3 manage.py runserver
+        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.
+        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.
 
-10. Setup systemd services to run paperless automatically. You may
+11. Setup systemd services to run paperless automatically. You may
     use the service definition files included in the ``scripts`` folder
     as a starting point.
 
@@ -348,17 +409,15 @@ writing. Windows is not and will never be supported.
     ``consumer`` script to watch the input folder, and the ``scheduler``
     script to run tasks such as email checking and document consumption.
 
+    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 additinal dependencies.
-
-    .. hint::
-
-        You may optionally set up your preferred web server to serve
-        paperless as a wsgi application directly instead of running the
-        ``webserver`` service. The module containing the wsgi application
-        is named ``paperless.wsgi``.
+    add additional dependencies.
 
     .. caution::
 
@@ -367,10 +426,13 @@ writing. Windows is not and will never be supported.
         however, the documentation of GUnicorn states that you should
         use a proxy server in front of gunicorn instead.
 
-11. Optional: Install a samba server and make the consumption folder
+        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.
 
-12. Configure ImageMagick to allow processing of PDF documents. Most distributions have
+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.
@@ -387,17 +449,130 @@ writing. Windows is not and will never be supported.
 
         <policy domain="coder" rights="read|write" pattern="PDF" />
 
-13. Optional: Install the `jbig2enc <https://ocrmypdf.readthedocs.io/en/latest/jbig2.html>`_
+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.
 
+.. _setup-ansible:
+
+Install Paperless using ansible
+===============================
+
+.. note::
+
+    This role currently only supports Debian 10 Buster and Ubuntu 20.04 Focal or later as target hosts.
+		Additionally, only i386 or amd64 based hosts are supported right now, i.e. installation on arm hosts will fail.
+
+1.  Install ansible 2.7+ on the management node.
+    This may be the target host paperless-ng is being installed on or any remote host which can access the target host.
+    For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation.
+
+    On Debian and Ubuntu, the official repositories should provide a suitable version:
+
+    .. code:: bash
+
+        apt install ansible
+        ansible --version
+
+    Alternatively, you can install the most recent ansible release using PyPI:
+
+    .. code:: bash
+
+        python3 -m pip install ansible
+        ansible --version
+
+    Make sure your taget hosts are accessible:
+
+    .. code:: sh
+
+        ansible -m ping YourAnsibleTargetHostGoesHere
+
+2.  Install the latest tag of the ansible role using ansible-galaxy
+
+    .. code:: sh
+
+        ansible-galaxy install git+https://github.com/jonaswinkler/paperless-ng.git,ng-1.4.2
+
+3.  Create an ansible ``playbook.yml`` in a directory of your choice:
+
+    .. code:: yaml
+
+        - hosts: YourAnsibleTargetHostGoesHere
+          become: yes
+          vars_files:
+            - vars/paperless-ng.yml
+          roles:
+            - paperless-ng
+
+    Optional: If you also want to use PostgreSQL on the target system, install and add (for example) the `geerlingguy.postgresql <https://github.com/geerlingguy/ansible-role-postgresql>`_ role:
+
+    .. code:: sh
+
+        ansible-galaxy install geerlingguy.postgresql
+
+    .. code:: yaml
+
+        - hosts: YourAnsibleTargetHostGoesHere
+          become: yes
+          vars_files:
+            - vars/paperless-ng.yml
+          roles:
+            - geerlingguy.postgresql
+            - paperless-ng
+
+    Optional: If you also want to use a reverse proxy on the target system, install and add (for example) the `geerlingguy.nginx <https://github.com/geerlingguy/ansible-role-nginx>`_ role:
+
+    .. code:: sh
+
+        ansible-galaxy install geerlingguy.nginx
+
+    .. code:: yaml
+
+        - hosts: YourAnsibleTargetHostGoesHere
+          become: yes
+          vars_files:
+            - vars/paperless-ng.yml
+          roles:
+            - geerlingguy.postgresql
+            - paperless-ng
+            - geerlingguy.nginx
+
+4.  Create ``vars/paperless-ng.yml`` to configure your ansible deployment:
+
+    .. code:: yaml
+
+        paperlessng_secret_key: PleaseGenerateAStrongKeyForThis
+
+        paperlessng_superuser_name: YourUserName
+        paperlessng_superuser_email: name@domain.tld
+        paperlessng_superuser_password: YourDesiredPasswordUsedForFirstLogin
+
+        paperlessng_ocr_languages:
+            - eng
+            - deu
+
+    For all of the available options, please check ``ansible/README.md`` and :ref:`configuration`.
+
+    Optional configurations for the above-mentioned PostgreSQL and nginx roles would also go here.
+
+5. Run the ansible playbook from the management node:
+
+    .. code:: sh
+
+        ansible-playbook playbook.yml
+
+    When this step completes successfully, paperless-ng will be available on the target host at ``http://127.0.0.1:8000`` (or the address you configured).
+
 Migration to paperless-ng
 #########################
 
 At its core, paperless-ng 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. The important things to keep in mind are as follows.
+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 :ref:`changelog <paperless_changelog>` and take note of breaking changes.
 * You should decide if you want to stick with SQLite or want to migrate your database
@@ -425,18 +600,25 @@ Migration to paperless-ng is then performed in a few simple steps:
     paperless.
 
 3.  Download the latest release of paperless-ng. You can either go with the
-    docker-compose files from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
+    docker-compose files from `here <https://github.com/jonaswinkler/paperless-ng/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-ng
     in a different location.
 
     .. caution::
 
-        Paperless includes a ``.env`` file. This will set the
-        project name for docker compose to ``paperless`` so that paperless-ng will
-        automatically reuse your existing paperless volumes. When you start it, it
-        will migrate your existing data. After that, your old paperless installation
-        will be incompatible with the migrated volumes.
+        Paperless-ng 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-ng. However, if you experience that paperless-ng
+        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
@@ -517,14 +699,12 @@ management commands as below.
 
         This will launch the container and initialize the PostgreSQL database.
 
-    b)  Without docker, open a shell in your virtual environment, switch to
+    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
-            $ pipenv shell
-            $ cd src
+            $ cd /path/to/paperless/src
             $ python3 manage.py migrate
 
         This will not copy any data yet.
@@ -541,7 +721,7 @@ management commands as below.
 
         $ python3 manage.py loaddata data.json
 
-6.  Exit the shell.
+6.  If operating inside Docker, you may exit the shell now.
 
     .. code:: shell-session
 
@@ -590,7 +770,8 @@ 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.
+    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
@@ -601,8 +782,13 @@ configuring some options in paperless can help improve performance immensely:
     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 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.
 *   Set ``PAPERLESS_OPTIMIZE_THUMBNAILS`` to 'false' if you want faster consumption
     times. Thumbnails will be about 20% larger.
+*   If using docker, consider setting ``PAPERLESS_WEBSERVER_WORKERS`` to
+    1. This will save some memory.
 
 For details, refer to :ref:`configuration`.
 
@@ -619,3 +805,46 @@ For details, refer to :ref:`configuration`.
     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;
+            }
+        }
+    }
+
+Also read `this <https://channels.readthedocs.io/en/stable/deploying.html#nginx-supervisor-ubuntu>`__, towards the end of the section.

docs/troubleshooting.rst

@@ -30,13 +30,22 @@ 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, check out
-the configuration file and enable filesystem polling with the setting
-``PAPERLESS_CONSUMER_POLLING``.
+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
 #######################
 
@@ -51,7 +60,8 @@ 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.
+Ensure that ``chown`` is possible on these directories.
+
 
 Classifier error: No training data available
 ############################################
@@ -64,6 +74,50 @@ This may have two reasons:
     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/convert/office
+
+Gotenberg is a server that converts Office documents into PDF documents and has a default timeout of 10 seconds.
+When conversion takes longer, Gotenberg raises this error.
+
+You can increase the timeout by configuring an environment variable for gotenberg (see also `here <https://thecodingmachine.github.io/gotenberg/#environment_variables.default_wait_timeout>`__).
+If using docker-compose, this is achieved by the following configuration change in the ``docker-compose.yml`` file:
+
+.. code:: yaml
+
+    gotenberg:
+        image: thecodingmachine/gotenberg
+        restart: unless-stopped
+        environment:
+            DISABLE_GOOGLE_CHROME: 1
+            DEFAULT_WAIT_TIMEOUT: 30
+
 Permission denied errors in the consumption directory
 #####################################################
 
@@ -78,3 +132,92 @@ Ensure that ``USERMAP_UID`` and ``USERMAP_GID`` are set to the user id and group
 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.

docs/usage_overview.rst

@@ -71,7 +71,7 @@ your documents:
 
     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 
+    configuring ``PAPERLESS_OCR_MODE=skip_noarchive``. Please read the
     :ref:`relevant section in the documentation <configuration-ocr>`.
 
 .. note::
@@ -255,6 +255,8 @@ Here are a couple examples of tags and types that you could use in your collecti
 * 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
 #########
 
@@ -287,7 +289,7 @@ Matching specific tags, correspondents or types:
 Matching dates:
 
 .. code::
-  
+
   created:[2005 to 2009]
   added:yesterday
   modified:today
@@ -304,11 +306,11 @@ Matching inexact words:
   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. 
+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:
 
@@ -383,7 +385,7 @@ Once you have scanned in a document, proceed in paperless as follows.
 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

gunicorn.conf.py

@@ -1,21 +1,9 @@
+import os
+
 bind = '0.0.0.0:8000'
-backlog = 2048
-workers = 3
-worker_class = 'sync'
-worker_connections = 1000
-timeout = 20
-keepalive = 2
-spew = False
-daemon = False
-pidfile = None
-umask = 0
-user = None
-group = None
-tmp_upload_dir = None
-loglevel = 'info'
-errorlog = '-'
-accesslog = '-'
-proc_name = None
+workers = int(os.getenv("PAPERLESS_WEBSERVER_WORKERS", 2))
+worker_class = 'paperless.workers.ConfigurableWorker'
+timeout = 120
 
 def pre_fork(server, worker):
     pass

install-paperless-ng.sh

@@ -0,0 +1,318 @@
+#!/bin/bash
+
+ask() {
+	while true ; do
+		if [[ -z $3 ]] ; then
+			read -p "$1 [$2]: " result
+		else
+			read -p "$1 ($3) [$2]: " result
+		fi
+		if [[ -z $result ]]; then
+			ask_result=$2
+			return
+		fi
+		array=$3
+		if [[ -z $3 || " ${array[@]} " =~ " ${result} " ]]; then
+			ask_result=$result
+			return
+		else
+			echo "Invalid option: $result"
+		fi
+	done
+}
+
+ask_docker_folder() {
+	while true ; do
+
+		read -p "$1 [$2]: " result
+
+		if [[ -z $result ]]; then
+			ask_result=$2
+			return
+		fi
+
+		if [[ $result == /* || $result == ./* ]]; then
+			ask_result=$result
+			return
+		else
+			echo "Invalid folder: $result"
+		fi
+
+
+	done
+}
+
+if [[ $(id -u) == "0" ]] ; then
+	echo "Do not run this script as root."
+	exit 1
+fi
+
+if [[ -z $(which wget) ]] ; then
+	echo "wget executable not found. Is wget installed?"
+	exit 1
+fi
+
+if [[ -z $(which docker) ]] ; then
+	echo "docker executable not found. Is docker installed?"
+	exit 1
+fi
+
+if [[ -z $(which docker-compose) ]] ; then
+	echo "docker-compose executable not found. Is docker-compose installed?"
+	exit 1
+fi
+
+# Check if user has permissions to run Docker by trying to get the status of Docker (docker status).
+# If this fails, the user probably does not have permissions for Docker.
+docker stats --no-stream 2>/dev/null 1>&2
+if [ $? -ne 0 ] ; then
+	echo ""
+	echo "WARN: It look like the current user does not have Docker permissions."
+	echo "WARN: Use 'sudo usermod -aG docker $USER' to assign Docker permissions to the user."
+	echo ""
+	sleep 3
+fi
+
+default_time_zone=$(timedatectl show -p Timezone --value)
+
+set -e
+
+echo ""
+echo "############################################"
+echo "###   Paperless-ng docker installation   ###"
+echo "############################################"
+echo ""
+echo "This script will download, configure and start paperless-ng."
+
+echo ""
+echo "1. Folder configuration"
+echo "======================="
+echo ""
+echo "The target folder is used to store the configuration files of "
+echo "paperless. You can move this folder around after installing paperless."
+echo "You will need this folder whenever you want to start, stop, update or "
+echo "maintain your paperless instance."
+echo ""
+
+ask "Target folder" "$(pwd)/paperless-ng"
+TARGET_FOLDER=$ask_result
+
+echo ""
+echo "The consume folder is where paperles will search for new documents."
+echo "Point this to a folder where your scanner is able to put your scanned"
+echo "documents."
+echo ""
+echo "CAUTION: You must specify an absolute path starting with / or a relative "
+echo "path starting with ./ here. Examples:"
+echo "  /mnt/consume"
+echo "  ./consume"
+echo ""
+
+ask_docker_folder "Consume folder" "$TARGET_FOLDER/consume"
+CONSUME_FOLDER=$ask_result
+
+echo ""
+echo "The media folder is where paperless stores your documents."
+echo "Leave empty and docker will manage this folder for you."
+echo "Docker usually stores managed folders in /var/lib/docker/volumes."
+echo ""
+echo "CAUTION: If specified, you must specify an absolute path starting with /"
+echo "or a relative path starting with ./ here."
+echo ""
+
+ask_docker_folder "Media folder" ""
+MEDIA_FOLDER=$ask_result
+
+echo ""
+echo "The data folder is where paperless stores other data, such as your"
+echo "SQLite database (if used), the search index and other data."
+echo "As with the media folder, leave empty to have this managed by docker."
+echo ""
+echo "CAUTION: If specified, you must specify an absolute path starting with /"
+echo "or a relative path starting with ./ here."
+echo ""
+
+ask_docker_folder "Data folder" ""
+DATA_FOLDER=$ask_result
+
+echo ""
+echo "2. Application configuration"
+echo "============================"
+
+echo ""
+echo "The port on which the paperless webserver will listen for incoming"
+echo "connections."
+echo ""
+
+ask "Port" "8000"
+PORT=$ask_result
+
+echo ""
+echo "Paperless requires you to configure the current time zone correctly."
+echo "Otherwise, the dates of your documents may appear off by one day,"
+echo "depending on where you are on earth."
+echo ""
+
+ask "Current time zone" "$default_time_zone"
+TIME_ZONE=$ask_result
+
+echo ""
+echo "Database backend: PostgreSQL and SQLite are available. Use PostgreSQL"
+echo "if unsure. If you're running on a low-power device such as Raspberry"
+echo "Pi, use SQLite to save resources."
+echo ""
+
+ask "Database backend" "postgres" "postgres sqlite"
+DATABASE_BACKEND=$ask_result
+
+echo ""
+echo "Paperless is able to use Apache Tika to support Office documents such as"
+echo "Word, Excel, Powerpoint, and Libreoffice equivalents. This feature"
+echo "requires more resources due to the required services."
+echo ""
+
+ask "Enable Apache Tika?" "no" "yes no"
+TIKA_ENABLED=$ask_result
+
+echo ""
+echo "Specify the default language that most of your documents are written in."
+echo "Use ISO 639-2, (T) variant language codes: "
+echo "https://www.loc.gov/standards/iso639-2/php/code_list.php"
+echo "Common values: eng (English) deu (German) nld (Dutch) fra (French)"
+echo ""
+
+ask "OCR language" "eng"
+OCR_LANGUAGE=$ask_result
+
+echo ""
+echo "Specify the user id and group id you wish to run paperless as."
+echo "Paperless will also change ownership on the data, media and consume"
+echo "folder to the specified values, so it's a good idea to supply the user id"
+echo "and group id of your unix user account."
+echo "If unsure, leave default."
+echo ""
+
+ask "User ID" "$(id -u)"
+USERMAP_UID=$ask_result
+
+ask "Group ID" "$(id -g)"
+USERMAP_GID=$ask_result
+
+echo ""
+echo "3. Login credentials"
+echo "===================="
+echo ""
+echo "Specify initial login credentials. You can change these later."
+echo "A mail address is required, however it is not used in paperless. You don't"
+echo "need to provide an actual mail address."
+echo ""
+
+ask "Paperless username" "$(whoami)"
+USERNAME=$ask_result
+
+while true; do
+	read -sp "Paperless password: " PASSWORD
+	echo ""
+
+	if [[ -z $PASSWORD ]] ; then
+		echo "Password cannot be empty."
+		continue
+	fi
+
+	read -sp "Paperless password (again): " PASSWORD_REPEAT
+	echo ""
+
+	if [[ ! "$PASSWORD" == "$PASSWORD_REPEAT" ]] ; then
+		echo "Passwords did not match"
+	else
+		break
+	fi
+done
+
+ask "Email" "$USERNAME@localhost"
+EMAIL=$ask_result
+
+echo ""
+echo "Summary"
+echo "======="
+echo ""
+
+echo "Target folder: $TARGET_FOLDER"
+echo "Consume folder: $CONSUME_FOLDER"
+if [[ -z $MEDIA_FOLDER ]] ; then
+	echo "Media folder: Managed by docker"
+else
+	echo "Media folder: $MEDIA_FOLDER"
+fi
+if [[ -z $DATA_FOLDER ]] ; then
+	echo "Data folder: Managed by docker"
+else
+	echo "Data folder: $DATA_FOLDER"
+fi
+echo ""
+echo "Port: $PORT"
+echo "Database: $DATABASE_BACKEND"
+echo "Tika enabled: $TIKA_ENABLED"
+echo "OCR language: $OCR_LANGUAGE"
+echo "User id: $USERMAP_UID"
+echo "Group id: $USERMAP_GID"
+echo ""
+echo "Paperless username: $USERNAME"
+echo "Paperless email: $EMAIL"
+
+echo ""
+read -p "Press any key to install."
+
+echo ""
+echo "Installing paperless..."
+echo ""
+
+mkdir -p "$TARGET_FOLDER"
+
+cd "$TARGET_FOLDER"
+
+DOCKER_COMPOSE_VERSION=$DATABASE_BACKEND
+
+if [[ $TIKA_ENABLED == "yes" ]] ; then
+	DOCKER_COMPOSE_VERSION="$DOCKER_COMPOSE_VERSION-tika"
+fi
+
+wget "https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml
+wget "https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/docker/compose/.env" -O .env
+
+SECRET_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1)
+
+DEFAULT_LANGUAGES="deu eng fra ita spa"
+
+{
+	if [[ ! $USERMAP_UID == "1000" ]] ; then
+		echo "USERMAP_UID=$USERMAP_UID"
+	fi
+	if [[ ! $USERMAP_GID == "1000" ]] ; then
+		echo "USERMAP_GID=$USERMAP_GID"
+	fi
+	echo "PAPERLESS_TIME_ZONE=$TIME_ZONE"
+	echo "PAPERLESS_OCR_LANGUAGE=$OCR_LANGUAGE"
+	echo "PAPERLESS_SECRET_KEY=$SECRET_KEY"
+	if [[ ! " ${DEFAULT_LANGUAGES[@]} " =~ " ${OCR_LANGUAGE} " ]] ; then
+		echo "PAPERLESS_OCR_LANGUAGES=$OCR_LANGUAGE"
+	fi
+} > docker-compose.env
+
+sed -i "s/- 8000:8000/- $PORT:8000/g" docker-compose.yml
+
+sed -i "s#- \./consume:/usr/src/paperless/consume#- $CONSUME_FOLDER:/usr/src/paperless/consume#g" docker-compose.yml
+
+if [[ -n $MEDIA_FOLDER ]] ; then
+	sed -i "s#- media:/usr/src/paperless/media#- $MEDIA_FOLDER:/usr/src/paperless/media#g" docker-compose.yml
+fi
+
+if [[ -n $DATA_FOLDER ]] ; then
+	sed -i "s#- data:/usr/src/paperless/data#- $DATA_FOLDER:/usr/src/paperless/data#g" docker-compose.yml
+fi
+
+docker-compose pull
+
+docker-compose run --rm -e DJANGO_SUPERUSER_PASSWORD="$PASSWORD" webserver createsuperuser --noinput --username "$USERNAME" --email "$EMAIL"
+
+docker-compose up -d

paperless.conf.example

@@ -27,7 +27,7 @@
 
 #PAPERLESS_SECRET_KEY=change-me
 #PAPERLESS_ALLOWED_HOSTS=example.com,www.example.com
-#PAPERLESS_CORS_ALLOWED_HOSTS=localhost:8080,example.com,localhost:8000
+#PAPERLESS_CORS_ALLOWED_HOSTS=http://example.com,http://localhost:8000
 #PAPERLESS_FORCE_SCRIPT_NAME=
 #PAPERLESS_STATIC_URL=/static/
 #PAPERLESS_AUTO_LOGIN_USERNAME=
@@ -41,6 +41,10 @@
 #PAPERLESS_OCR_OUTPUT_TYPE=pdfa
 #PAPERLESS_OCR_PAGES=1
 #PAPERLESS_OCR_IMAGE_DPI=300
+#PAPERLESS_OCR_CLEAN=clean
+#PAPERLESS_OCR_DESKEW=true
+#PAPERLESS_OCR_ROTATE_PAGES=true
+#PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD=12.0
 #PAPERLESS_OCR_USER_ARGS={}
 #PAPERLESS_CONVERT_MEMORY_LIMIT=0
 #PAPERLESS_CONVERT_TMPDIR=/var/tmp/paperless

requirements.txt

@@ -7,68 +7,94 @@
 
 -i https://pypi.python.org/simple
 --extra-index-url https://www.piwheels.org/simple
-arrow==0.17.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-asgiref==3.3.1; python_version >= '3.5'
-blessed==1.17.12
-certifi==2020.12.5
-cffi==1.14.4
+aioredis==1.3.1
+arrow==1.1.0; python_version >= '3.6'
+asgiref==3.3.4; python_version >= '3.6'
+async-timeout==3.0.1; python_full_version >= '3.5.3'
+attrs==21.2.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+autobahn==21.3.1; python_version >= '3.7'
+automat==20.2.0
+blessed==1.18.0
+certifi==2021.5.30
+cffi==1.14.5
+channels-redis==3.2.0
+channels==3.0.3
 chardet==4.0.0; python_version >= '3.1'
-coloredlogs==15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-cryptography==3.3.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'
-dateparser==0.7.6
-django-cors-headers==3.6.0
-django-extensions==3.1.0
+click==8.0.1; python_version >= '3.6'
+coloredlogs==15.0.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+concurrent-log-handler==0.9.19
+constantly==15.1.0
+cryptography==3.4.7
+daphne==3.0.2; python_version >= '3.6'
+dateparser==1.0.0
+django-cors-headers==3.7.0
+django-extensions==3.1.3
 django-filter==2.4.0
 django-picklefield==3.0.1; python_version >= '3'
-django-q==1.3.4
-django==3.1.5
-djangorestframework==3.12.2
+django-q==1.3.8
+django==3.2.4
+djangorestframework==3.12.4
 filelock==3.0.12
-fuzzywuzzy==0.18.0
-gunicorn==20.0.4
-humanfriendly==9.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+fuzzywuzzy[speedup]==0.18.0
+gunicorn==20.1.0
+h11==0.12.0; python_version >= '3.6'
+hiredis==2.0.0; python_version >= '3.6'
+httptools==0.2.0
+humanfriendly==9.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+hyperlink==21.0.0
 idna==2.10; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-imap-tools==0.34.0
-img2pdf==0.4.0
-importlib-metadata==3.4.0; python_version < '3.8'
+imap-tools==0.41.0
+img2pdf==0.4.1
+incremental==21.3.0
 inotify-simple==1.3.5; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 inotifyrecursive==0.3.5
-joblib==1.0.0; python_version >= '3.6'
-langdetect==1.0.8
-lxml==4.6.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-numpy==1.19.5; python_version >= '3.6'
-ocrmypdf==11.4.5
-pathvalidate==2.3.2
-pdfminer.six==20201018; python_version >= '3.4'
-pdftotext==2.1.5
-pikepdf==2.2.5
-pillow==8.1.0
+joblib==1.0.1; python_version >= '3.6'
+langdetect==1.0.9
+lxml==4.6.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+msgpack==1.0.2
+numpy==1.19.5
+ocrmypdf==12.0.3
+pathvalidate==2.4.1
+pdfminer.six==20201018
+pikepdf==2.12.2
+pillow==8.2.0
 pluggy==0.13.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+portalocker==2.3.0; python_version >= '3'
 psycopg2-binary==2.8.6
+pyasn1-modules==0.2.8
+pyasn1==0.4.8
 pycparser==2.20; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+pyopenssl==20.0.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
 python-dateutil==2.8.1
-python-dotenv==0.15.0
-python-gnupg==0.4.6
-python-levenshtein==0.12.0
-python-magic==0.4.18
-pytz==2020.5
+python-dotenv==0.17.1
+python-gnupg==0.4.7
+python-levenshtein==0.12.2
+python-magic==0.4.24
+pytz==2021.1
+pyyaml==5.4.1
 redis==3.5.3
-regex==2020.11.13
-reportlab==3.5.59
+regex==2021.4.4
+reportlab==3.5.67; python_version >= '2.7' and python_version < '4'
 requests==2.25.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
 scikit-learn==0.24.0
-scipy==1.5.4; python_version >= '3.6'
-six==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-sortedcontainers==2.3.0
+scipy==1.5.4
+service-identity==21.1.0
+six==1.16.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+sortedcontainers==2.4.0
 sqlparse==0.4.1; python_version >= '3.5'
 threadpoolctl==2.1.0; python_version >= '3.5'
 tika==1.24
-tqdm==4.56.0
-typing-extensions==3.7.4.3; python_version < '3.8'
+tqdm==4.61.1
+twisted[tls]==21.2.0; python_full_version >= '3.5.4'
+txaio==21.2.1; python_version >= '3.6'
 tzlocal==2.1
-urllib3==1.26.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'
+urllib3==1.26.5; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'
+uvicorn[standard]==0.14.0
+uvloop==0.14.0
 watchdog==1.0.2
+watchgod==0.7
 wcwidth==0.2.5
+websockets==9.1
 whitenoise==5.2.0
 whoosh==2.7.4
-zipp==3.4.0; python_version >= '3.6'
+zope.interface==5.4.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'

resources/logo.txt

@@ -0,0 +1,16 @@
+                         9w
+                       {@@N
+                     Q@@@@H
+                  G@@@@@@@\
+               SilN@@@@@@@
+            *Q  *@@@@@@@@S        /= = = = = = = = = = = = = = = = = =\
+          *@   B@@@@@@@@N        ||                                   ||
+ N       R$  A@@@@@@@@@@         ||           PAPERLESS-NG            ||
+x@@     $U  B@@@@@@@@@R          ||                                   ||
+N@@N^   @  N@@@@@@@@@*            \= = = = = = = = = = = = = = = = = =/
+|@@@u   @ E@@@@@@@@l
+ Q@@@ \ Px@@@@@@P
+  1@@S`  @@@o'
+    z$  ;
+       v
+      /

scripts/paperless-scheduler.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=Paperless consumer
+Description=Paperless scheduler
 Requires=redis.service
 
 [Service]

scripts/paperless-webserver.service

@@ -8,7 +8,7 @@ Requires=redis.service
 User=paperless
 Group=paperless
 WorkingDirectory=/opt/paperless/src
-ExecStart=/opt/paperless/.local/bin/gunicorn paperless.wsgi -w 2 -b 0.0.0.0:8000
+ExecStart=/opt/paperless/.local/bin/gunicorn -c /opt/paperless/gunicorn.conf.py paperless.asgi:application
 
 [Install]
 WantedBy=multi-user.target

scripts/start_services.sh

@@ -1,4 +1,4 @@
-docker run -p 5432:5432 -v paperless_pgdata:/var/lib/postgresql/data -d postgres:13
+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 thecodingmachine/gotenberg
 docker run -p 9998:9998 -d apache/tika

src-ui/angular.json

@@ -16,9 +16,18 @@
 			"i18n": {
 				"sourceLocale": "en-US",
 				"locales": {
-					"de": "src/locale/messages.de.xlf",
+					"de-DE": "src/locale/messages.de_DE.xlf",
 					"nl-NL": "src/locale/messages.nl_NL.xlf",
-					"fr": "src/locale/messages.fr.xlf"
+					"fr-FR": "src/locale/messages.fr_FR.xlf",
+					"en-GB": "src/locale/messages.en_GB.xlf",
+					"pt-BR": "src/locale/messages.pt_BR.xlf",
+					"pt-PT": "src/locale/messages.pt_PT.xlf",
+					"it-IT": "src/locale/messages.it_IT.xlf",
+					"ro-RO": "src/locale/messages.ro_RO.xlf",
+					"ru-RU": "src/locale/messages.ru_RU.xlf",
+					"es-ES": "src/locale/messages.es_ES.xlf",
+					"pl-PL": "src/locale/messages.pl_PL.xlf",
+					"sv-SE": "src/locale/messages.sv_SE.xlf"
 				}
 			},
 			"architect": {
@@ -35,6 +44,7 @@
 						"aot": true,
 						"assets": [
 							"src/favicon.ico",
+							"src/apple-touch-icon.png",
 							"src/assets",
 							"src/manifest.webmanifest", {
 								"glob": "pdf.worker.min.js",
@@ -62,7 +72,6 @@
 							"optimization": true,
 							"outputHashing": "none",
 							"sourceMap": false,
-							"extractCss": true,
 							"namedChunks": false,
 							"extractLicenses": true,
 							"vendorChunk": false,
@@ -99,7 +108,8 @@
 				"extract-i18n": {
 					"builder": "@angular-devkit/build-angular:extract-i18n",
 					"options": {
-						"browserTarget": "paperless-ui:build"
+						"browserTarget": "paperless-ui:build",
+						"ivy": true
 					}
 				},
 				"test": {
@@ -111,6 +121,7 @@
 						"karmaConfig": "karma.conf.js",
 						"assets": [
 							"src/favicon.ico",
+							"src/apple-touch-icon.png",
 							"src/assets",
 							"src/manifest.webmanifest"
 						],

src-ui/e2e/protractor.conf.js

@@ -33,4 +33,4 @@ exports.config = {
       }
     }));
   }
-};
+};

src-ui/package.json

@@ -11,39 +11,41 @@
   },
   "private": true,
   "dependencies": {
-    "@angular/animations": "~10.1.5",
-    "@angular/common": "~10.1.5",
-    "@angular/compiler": "~10.1.5",
-    "@angular/core": "~10.1.5",
-    "@angular/forms": "~10.1.5",
-    "@angular/localize": "~10.1.5",
-    "@angular/platform-browser": "~10.1.5",
-    "@angular/platform-browser-dynamic": "~10.1.5",
-    "@angular/router": "~10.1.5",
-    "@ng-bootstrap/ng-bootstrap": "^8.0.0",
-    "@ng-select/ng-select": "^5.0.9",
+    "@angular/animations": "~11.2.14",
+    "@angular/common": "~11.2.14",
+    "@angular/compiler": "~11.2.14",
+    "@angular/core": "~11.2.14",
+    "@angular/forms": "~11.2.14",
+    "@angular/localize": "~11.2.14",
+    "@angular/platform-browser": "~11.2.14",
+    "@angular/platform-browser-dynamic": "~11.2.14",
+    "@angular/router": "~11.2.14",
+    "@ng-bootstrap/ng-bootstrap": "^9.1.2",
+    "@ng-select/ng-select": "^7.0.0",
     "bootstrap": "^4.5.0",
-    "ng-bootstrap": "^1.6.3",
+    "file-saver": "^2.0.5",
     "ng2-pdf-viewer": "^6.3.2",
+    "ngx-bootstrap": "^6.2.0",
+    "ngx-color": "^6.2.0",
     "ngx-cookie-service": "^10.1.1",
-    "ngx-file-drop": "^10.0.0",
+    "ngx-file-drop": "^11.1.0",
     "ngx-infinite-scroll": "^9.1.0",
     "rxjs": "~6.6.0",
     "tslib": "^2.0.0",
     "uuid": "^8.3.1",
-    "zone.js": "~0.10.2"
+    "zone.js": "~0.11.4"
   },
   "devDependencies": {
-    "@angular-devkit/build-angular": "^0.1002.0",
-    "@angular/cli": "~10.1.5",
-    "@angular/compiler-cli": "~10.1.5",
-    "@types/jasmine": "~3.5.0",
+    "@angular-devkit/build-angular": "~0.1102.13",
+    "@angular/cli": "~11.2.14",
+    "@angular/compiler-cli": "~11.2.14",
+    "@types/jasmine": "~3.6.0",
     "@types/jasminewd2": "~2.0.3",
     "@types/node": "^12.11.1",
     "codelyzer": "^6.0.0",
     "jasmine-core": "~3.6.0",
     "jasmine-spec-reporter": "~5.0.0",
-    "karma": "~5.0.0",
+    "karma": "~6.3.3",
     "karma-chrome-launcher": "~3.1.0",
     "karma-coverage-istanbul-reporter": "~3.0.2",
     "karma-jasmine": "~4.0.0",
@@ -51,6 +53,6 @@
     "protractor": "~7.0.0",
     "ts-node": "~8.3.0",
     "tslint": "~6.1.0",
-    "typescript": "~4.0.2"
+    "typescript": "~4.1.5"
   }
 }

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

@@ -10,7 +10,7 @@ import { LogsComponent } from './components/manage/logs/logs.component';
 import { SettingsComponent } from './components/manage/settings/settings.component';
 import { TagListComponent } from './components/manage/tag-list/tag-list.component';
 import { NotFoundComponent } from './components/not-found/not-found.component';
-import { SearchComponent } from './components/search/search.component';
+import {DocumentAsnComponent} from "./components/document-asn/document-asn.component";
 
 const routes: Routes = [
   {path: '', redirectTo: 'dashboard', pathMatch: 'full'},
@@ -18,22 +18,22 @@ const routes: Routes = [
     {path: 'dashboard', component: DashboardComponent },
     {path: 'documents', component: DocumentListComponent },
     {path: 'view/:id', component: DocumentListComponent },
-    {path: 'search', component: SearchComponent },
     {path: 'documents/:id', component: DocumentDetailComponent },
-  
+      {path: 'asn/:id', component: DocumentAsnComponent },
+
     {path: 'tags', component: TagListComponent },
     {path: 'documenttypes', component: DocumentTypeListComponent },
     {path: 'correspondents', component: CorrespondentListComponent },
     {path: 'logs', component: LogsComponent },
     {path: 'settings', component: SettingsComponent },
-  ]}, 
+  ]},
 
   {path: '404', component: NotFoundComponent},
   {path: '**', redirectTo: '/404', pathMatch: 'full'}
 ];
 
 @NgModule({
-  imports: [RouterModule.forRoot(routes)],
+  imports: [RouterModule.forRoot(routes, { relativeLinkResolution: 'legacy' })],
   exports: [RouterModule]
 })
 export class AppRoutingModule { }

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

@@ -1,3 +1,3 @@
 <app-toasts></app-toasts>
 
-<router-outlet></router-outlet>
+<router-outlet></router-outlet>

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

@@ -1,17 +1,70 @@
-import { Component } from '@angular/core';
-import { SettingsService } from './services/settings.service';
+import { SettingsService, SETTINGS_KEYS } from './services/settings.service';
+import { Component, OnDestroy, OnInit } from '@angular/core';
+import { Router } from '@angular/router';
+import { Subscription } from 'rxjs';
+import { ConsumerStatusService } from './services/consumer-status.service';
+import { ToastService } from './services/toast.service';
 
 @Component({
   selector: 'app-root',
   templateUrl: './app.component.html',
   styleUrls: ['./app.component.scss']
 })
-export class AppComponent {
+export class AppComponent implements OnInit, OnDestroy {
 
-  constructor (private settings: SettingsService) {
+  newDocumentSubscription: Subscription;
+  successSubscription: Subscription;
+  failedSubscription: Subscription;
+
+  constructor (private settings: SettingsService, private consumerStatusService: ConsumerStatusService, private toastService: ToastService, private router: Router) {
     let anyWindow = (window as any)
-    anyWindow.pdfWorkerSrc = '/assets/js/pdf.worker.min.js';
+    anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.js';
     this.settings.updateDarkModeSettings()
   }
 
+  ngOnDestroy(): void {
+    this.consumerStatusService.disconnect()
+    if (this.successSubscription) {
+      this.successSubscription.unsubscribe()
+    }
+    if (this.failedSubscription) {
+      this.failedSubscription.unsubscribe()
+    }
+    if (this.newDocumentSubscription) {
+      this.newDocumentSubscription.unsubscribe()
+    }
+  }
+
+  private showNotification(key) {
+    if (this.router.url == '/dashboard' && this.settings.get(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD)) {
+      return false
+    }
+    return this.settings.get(key)
+  }
+
+  ngOnInit(): void {
+    this.consumerStatusService.connect()
+
+
+    this.successSubscription = this.consumerStatusService.onDocumentConsumptionFinished().subscribe(status => {
+      if (this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS)) {
+        this.toastService.show({title: $localize`Document added`, delay: 10000, content: $localize`Document ${status.filename} was added to paperless.`, actionName: $localize`Open document`, action: () => {
+          this.router.navigate(['documents', status.documentId])
+        }})
+      }
+    })
+
+    this.failedSubscription = this.consumerStatusService.onDocumentConsumptionFailed().subscribe(status => {
+      if (this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED)) {
+        this.toastService.showError($localize`Could not add ${status.filename}\: ${status.message}`)
+      }
+    })
+
+    this.newDocumentSubscription = this.consumerStatusService.onDocumentDetected().subscribe(status => {
+      if (this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT)) {
+        this.toastService.show({title: $localize`New document detected`, delay: 5000, content: $localize`Document ${status.filename} is being processed by paperless.`})
+      }
+    })
+  }
+
 }

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

@@ -3,7 +3,7 @@ import { NgModule } from '@angular/core';
 
 import { AppRoutingModule } from './app-routing.module';
 import { AppComponent } from './app.component';
-import { NgbModule } from '@ng-bootstrap/ng-bootstrap';
+import { NgbDateAdapter, NgbDateParserFormatter, NgbModule } from '@ng-bootstrap/ng-bootstrap';
 import { HttpClientModule, HTTP_INTERCEPTORS } from '@angular/common/http';
 import { DocumentListComponent } from './components/document-list/document-list.component';
 import { DocumentDetailComponent } from './components/document-detail/document-detail.component';
@@ -13,7 +13,7 @@ import { DocumentTypeListComponent } from './components/manage/document-type-lis
 import { LogsComponent } from './components/manage/logs/logs.component';
 import { SettingsComponent } from './components/manage/settings/settings.component';
 import { FormsModule, ReactiveFormsModule } from '@angular/forms';
-import { DatePipe } from '@angular/common';
+import { DatePipe, registerLocaleData } from '@angular/common';
 import { NotFoundComponent } from './components/not-found/not-found.component';
 import { CorrespondentListComponent } from './components/manage/correspondent-list/correspondent-list.component';
 import { ConfirmDialogComponent } from './components/common/confirm-dialog/confirm-dialog.component';
@@ -21,8 +21,6 @@ import { CorrespondentEditDialogComponent } from './components/manage/correspond
 import { TagEditDialogComponent } from './components/manage/tag-list/tag-edit-dialog/tag-edit-dialog.component';
 import { DocumentTypeEditDialogComponent } from './components/manage/document-type-list/document-type-edit-dialog/document-type-edit-dialog.component';
 import { TagComponent } from './components/common/tag/tag.component';
-import { SearchComponent } from './components/search/search.component';
-import { ResultHighlightComponent } from './components/search/result-highlight/result-highlight.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';
@@ -39,7 +37,6 @@ import { SelectComponent } from './components/common/input/select/select.compone
 import { CheckComponent } from './components/common/input/check/check.component';
 import { SaveViewConfigDialogComponent } from './components/document-list/save-view-config-dialog/save-view-config-dialog.component';
 import { InfiniteScrollModule } from 'ngx-infinite-scroll';
-import { DateTimeComponent } from './components/common/input/date-time/date-time.component';
 import { TagsComponent } from './components/common/input/tags/tags.component';
 import { SortableDirective } from './directives/sortable.directive';
 import { CookieService } from 'ngx-cookie-service';
@@ -59,6 +56,40 @@ import { SelectDialogComponent } from './components/common/select-dialog/select-
 import { NgSelectModule } from '@ng-select/ng-select';
 import { NumberComponent } from './components/common/input/number/number.component';
 import { SafePipe } from './pipes/safe.pipe';
+import { CustomDatePipe } from './pipes/custom-date.pipe';
+import { DateComponent } from './components/common/input/date/date.component';
+import { ISODateTimeAdapter } from './utils/ngb-iso-date-time-adapter';
+import { LocalizedDateParserFormatter } from './utils/ngb-date-parser-formatter';
+import { ApiVersionInterceptor } from './interceptors/api-version.interceptor';
+import { ColorSliderModule } from 'ngx-color/slider';
+import { ColorComponent } from './components/common/input/color/color.component';
+import { DocumentAsnComponent } from './components/document-asn/document-asn.component';
+
+import localeFr from '@angular/common/locales/fr';
+import localeNl from '@angular/common/locales/nl';
+import localeDe from '@angular/common/locales/de';
+import localePt from '@angular/common/locales/pt';
+import localeIt from '@angular/common/locales/it';
+import localeEnGb from '@angular/common/locales/en-GB';
+import localeRo from '@angular/common/locales/ro';
+import localeRu from '@angular/common/locales/ru';
+import localeEs from '@angular/common/locales/es';
+import localePl from '@angular/common/locales/pl';
+import localeSv from '@angular/common/locales/sv';
+
+
+registerLocaleData(localeFr)
+registerLocaleData(localeNl)
+registerLocaleData(localeDe)
+registerLocaleData(localePt, "pt-BR")
+registerLocaleData(localePt, "pt-PT")
+registerLocaleData(localeIt)
+registerLocaleData(localeEnGb)
+registerLocaleData(localeRo)
+registerLocaleData(localeRu)
+registerLocaleData(localeEs)
+registerLocaleData(localePl)
+registerLocaleData(localeSv)
 
 @NgModule({
   declarations: [
@@ -77,8 +108,6 @@ import { SafePipe } from './pipes/safe.pipe';
     TagEditDialogComponent,
     DocumentTypeEditDialogComponent,
     TagComponent,
-    SearchComponent,
-    ResultHighlightComponent,
     PageHeaderComponent,
     AppFrameComponent,
     ToastsComponent,
@@ -93,7 +122,6 @@ import { SafePipe } from './pipes/safe.pipe';
     SelectComponent,
     CheckComponent,
     SaveViewConfigDialogComponent,
-    DateTimeComponent,
     TagsComponent,
     SortableDirective,
     SavedViewWidgetComponent,
@@ -108,7 +136,11 @@ import { SafePipe } from './pipes/safe.pipe';
     MetadataCollapseComponent,
     SelectDialogComponent,
     NumberComponent,
-    SafePipe
+    SafePipe,
+    CustomDatePipe,
+    DateComponent,
+    ColorComponent,
+    DocumentAsnComponent
   ],
   imports: [
     BrowserModule,
@@ -120,7 +152,8 @@ import { SafePipe } from './pipes/safe.pipe';
     NgxFileDropModule,
     InfiniteScrollModule,
     PdfViewerModule,
-    NgSelectModule
+    NgSelectModule,
+    ColorSliderModule
   ],
   providers: [
     DatePipe,
@@ -128,9 +161,15 @@ import { SafePipe } from './pipes/safe.pipe';
       provide: HTTP_INTERCEPTORS,
       useClass: CsrfInterceptor,
       multi: true
+    },{
+      provide: HTTP_INTERCEPTORS,
+      useClass: ApiVersionInterceptor,
+      multi: true
     },
     FilterPipe,
-    DocumentTitlePipe
+    DocumentTitlePipe,
+    {provide: NgbDateAdapter, useClass: ISODateTimeAdapter},
+    {provide: NgbDateParserFormatter, useClass: LocalizedDateParserFormatter}
   ],
   bootstrap: [AppComponent]
 })

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

@@ -5,7 +5,7 @@
     <span class="navbar-toggler-icon"></span>
   </button>
   <a class="navbar-brand col-auto col-md-3 col-lg-2 mr-0 px-3 py-3 order-sm-0" routerLink="/dashboard">
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 198.43 238.91" width="1rem" class="mr-2" fill="currentColor">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 198.43 238.91" width="1em" class="mr-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-ng</ng-container>
@@ -31,7 +31,7 @@
       </button>
       <div ngbDropdownMenu class="dropdown-menu-right shadow mr-2" aria-labelledby="userDropdown">
         <div *ngIf="displayName" class="d-sm-none">
-          <p class="small mb-0 px-3" i18n>Logged in as {{displayName}}</p>
+          <p class="small mb-0 px-3 text-muted" i18n>Logged in as {{displayName}}</p>
           <div class="dropdown-divider"></div>
         </div>
         <a ngbDropdownItem class="nav-link" routerLink="settings" (click)="closeMenu()">
@@ -52,12 +52,7 @@
 <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">
-
-      <div style="position: absolute; bottom: 0; left: 0;" class="text-muted p-1">
-        {{versionString}}
-      </div>
-
-      <div class="sidebar-sticky pt-3">
+      <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()">
@@ -75,7 +70,7 @@
           </li>
         </ul>
 
-        <h6 class="sidebar-heading d-flex justify-content-between align-items-center px-3 mt-4 mb-1 text-muted" *ngIf='savedViewService.sidebarViews.length > 0'>
+        <h6 class="sidebar-heading px-3 mt-4 mb-1 text-muted" *ngIf='savedViewService.sidebarViews.length > 0'>
           <ng-container i18n>Saved views</ng-container>
         </h6>
         <ul class="nav flex-column mb-2">
@@ -88,7 +83,7 @@
           </li>
         </ul>
 
-        <h6 class="sidebar-heading d-flex justify-content-between align-items-center px-3 mt-4 mb-1 text-muted" *ngIf='openDocuments.length > 0'>
+        <h6 class="sidebar-heading px-3 mt-4 mb-1 text-muted" *ngIf='openDocuments.length > 0'>
           <ng-container i18n>Open documents</ng-container>
         </h6>
         <ul class="nav flex-column mb-2">
@@ -97,9 +92,14 @@
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#file-text"/>
               </svg>&nbsp;{{d.title | documentTitle}}
+              <span class="close bg-light" (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"/>
+                </svg>
+              </span>
             </a>
           </li>
-          <li class="nav-item w-100" *ngIf="openDocuments.length > 1">
+          <li class="nav-item w-100" *ngIf="openDocuments.length >= 1">
             <a class="nav-link text-truncate" [routerLink]="" (click)="closeAll()">
               <svg class="sidebaricon" fill="currentColor">
                 <use xlink:href="assets/bootstrap-icons.svg#x"/>
@@ -108,7 +108,7 @@
           </li>
         </ul>
 
-        <h6 class="sidebar-heading d-flex justify-content-between align-items-center px-3 mt-4 mb-1 text-muted">
+        <h6 class="sidebar-heading px-3 mt-4 mb-1 text-muted">
           <ng-container i18n>Manage</ng-container>
         </h6>
         <ul class="nav flex-column mb-2">
@@ -156,8 +156,8 @@
           </li>
         </ul>
 
-        <h6 class="sidebar-heading d-flex justify-content-between align-items-center px-3 mt-4 mb-1 text-muted">
-          <ng-container i18n>Misc</ng-container>
+        <h6 class="sidebar-heading px-3 mt-auto pt-4 mb-1 text-muted">
+          <ng-container i18n>Info</ng-container>
         </h6>
         <ul class="nav flex-column mb-2">
           <li class="nav-item">
@@ -168,11 +168,24 @@
             </a>
           </li>
           <li class="nav-item">
-            <a class="nav-link" target="_blank" rel="noopener noreferrer" href="https://github.com/jonaswinkler/paperless-ng">
-              <svg class="sidebaricon" fill="currentColor">
-                <use xlink:href="assets/bootstrap-icons.svg#link"/>
-              </svg>&nbsp;<ng-container i18n>GitHub</ng-container>
-            </a>
+            <div class="d-flex w-100 flex-wrap">
+              <a class="nav-link pr-0 pb-0" target="_blank" rel="noopener noreferrer" href="https://github.com/jonaswinkler/paperless-ng">
+                <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" class="sidebaricon bi bi-github" viewBox="0 0 16 16">
+                  <path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.012 8.012 0 0 0 16 8c0-4.42-3.58-8-8-8z"/>
+                </svg>&nbsp;<ng-container i18n>GitHub</ng-container>
+              </a>
+              <a class="nav-link-additional small text-muted ml-3" target="_blank" rel="noopener noreferrer" href="https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests" title="Suggest an idea">
+                <svg xmlns="http://www.w3.org/2000/svg" width="1.3em" height="1.3em" fill="currentColor" class="bi bi-lightbulb pr-1" viewBox="0 0 16 16">
+                  <path d="M2 6a6 6 0 1 1 10.174 4.31c-.203.196-.359.4-.453.619l-.762 1.769A.5.5 0 0 1 10.5 13a.5.5 0 0 1 0 1 .5.5 0 0 1 0 1l-.224.447a1 1 0 0 1-.894.553H6.618a1 1 0 0 1-.894-.553L5.5 15a.5.5 0 0 1 0-1 .5.5 0 0 1 0-1 .5.5 0 0 1-.46-.302l-.761-1.77a1.964 1.964 0 0 0-.453-.618A5.984 5.984 0 0 1 2 6zm6-5a5 5 0 0 0-3.479 8.592c.263.254.514.564.676.941L5.83 12h4.342l.632-1.467c.162-.377.413-.687.676-.941A5 5 0 0 0 8 1z"/>
+                </svg>
+                <ng-container i18n>Suggest an idea</ng-container>
+              </a>
+            </div>
+          </li>
+          <li class="nav-item mt-2">
+            <div class="px-3 py-2 text-muted small">
+              {{versionString}}
+            </div>
           </li>
         </ul>
       </div>

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

@@ -24,6 +24,7 @@
   padding-top: 0.5rem;
   overflow-x: hidden;
   overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */
+  min-height: min-content;
 }
 @supports ((position: -webkit-sticky) or (position: sticky)) {
   .sidebar-sticky {
@@ -57,6 +58,49 @@
   text-transform: uppercase;
 }
 
+.nav {
+  flex-wrap: nowrap;
+}
+
+.nav-item {
+  position: relative;
+
+  &:hover .close {
+    display: block;
+  }
+
+  .close {
+    display: none;
+    position: absolute;
+    cursor: pointer;
+    opacity: 1;
+    top: 0;
+    padding: .25rem .3rem 0;
+    right: .4rem;
+    width: 1.8rem;
+    height: 100%;
+
+    svg {
+      opacity: 0.5;
+    }
+
+    &:hover svg {
+      opacity: 1;
+    }
+  }
+
+  .nav-link-additional {
+    margin-top: 0.2rem;
+    margin-left: 0.25rem;
+    padding-top: 0.5rem;
+
+    svg {
+      margin-bottom: 2px;
+    }
+  }
+}
+
+
 /*
  * Navbar
  */

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

@@ -1,7 +1,7 @@
-import { Component, OnDestroy, OnInit } from '@angular/core';
+import { Component, OnInit } from '@angular/core';
 import { FormControl } from '@angular/forms';
-import { ActivatedRoute, Router } from '@angular/router';
-import { from, Observable, Subscription } from 'rxjs';
+import { ActivatedRoute, Router, Params } from '@angular/router';
+import { from, Observable, Subscription, BehaviorSubject } from 'rxjs';
 import { debounceTime, distinctUntilChanged, map, switchMap } from 'rxjs/operators';
 import { PaperlessDocument } from 'src/app/data/paperless-document';
 import { OpenDocumentsService } from 'src/app/services/open-documents.service';
@@ -10,13 +10,15 @@ import { SearchService } from 'src/app/services/rest/search.service';
 import { environment } from 'src/environments/environment';
 import { DocumentDetailComponent } from '../document-detail/document-detail.component';
 import { Meta } from '@angular/platform-browser';
+import { DocumentListViewService } from 'src/app/services/document-list-view.service';
+import { FILTER_FULLTEXT_QUERY } from 'src/app/data/filter-rule-type';
 
 @Component({
   selector: 'app-app-frame',
   templateUrl: './app-frame.component.html',
   styleUrls: ['./app-frame.component.scss']
 })
-export class AppFrameComponent implements OnInit, OnDestroy {
+export class AppFrameComponent implements OnInit {
 
   constructor (
     public router: Router,
@@ -24,9 +26,10 @@ export class AppFrameComponent implements OnInit, OnDestroy {
     private openDocumentsService: OpenDocumentsService,
     private searchService: SearchService,
     public savedViewService: SavedViewService,
+    private list: DocumentListViewService,
     private meta: Meta
     ) {
-      
+
   }
 
   versionString = `${environment.appTitle} ${environment.version}`
@@ -39,9 +42,9 @@ export class AppFrameComponent implements OnInit, OnDestroy {
 
   searchField = new FormControl('')
 
-  openDocuments: PaperlessDocument[] = []
-
-  openDocumentsSubscription: Subscription
+  get openDocuments(): PaperlessDocument[] {
+    return this.openDocumentsService.getOpenDocuments()
+  }
 
   searchAutoComplete = (text$: Observable<string>) =>
     text$.pipe(
@@ -74,15 +77,27 @@ export class AppFrameComponent implements OnInit, OnDestroy {
 
   search() {
     this.closeMenu()
-    this.router.navigate(['search'], {queryParams: {query: this.searchField.value}})
+    this.list.quickFilter([{rule_type: FILTER_FULLTEXT_QUERY, value: this.searchField.value}])
+  }
+
+  closeDocument(d: PaperlessDocument) {
+    this.closeMenu()
+    this.openDocumentsService.closeDocument(d)
+
+    let route = this.activatedRoute.snapshot
+    while (route.firstChild) {
+      route = route.firstChild
+    }
+    if (route.component == DocumentDetailComponent && route.params['id'] == d.id) {
+      this.router.navigate([""])
+    }
   }
 
   closeAll() {
     this.closeMenu()
     this.openDocumentsService.closeAll()
 
-    // TODO: is there a better way to do this?
-    let route = this.activatedRoute
+    let route = this.activatedRoute.snapshot
     while (route.firstChild) {
       route = route.firstChild
     }
@@ -92,13 +107,6 @@ export class AppFrameComponent implements OnInit, OnDestroy {
   }
 
   ngOnInit() {
-    this.openDocuments = this.openDocumentsService.getOpenDocuments()
-  }
-
-  ngOnDestroy() {
-    if (this.openDocumentsSubscription) {
-      this.openDocumentsSubscription.unsubscribe()
-    }
   }
 
   get displayName() {

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

@@ -30,7 +30,7 @@ export class ConfirmDialogComponent implements OnInit {
 
   @Input()
   buttonsEnabled = true
-  
+
   confirmButtonEnabled = true
   seconds = 0
 

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

@@ -20,8 +20,17 @@
           </div>
 
           <div class="input-group input-group-sm">
-            <input type="date" class="form-control" id="date_after" [(ngModel)]="dateAfter" (change)="onChangeDebounce()">
+            <input class="form-control" [placeholder]="datePlaceHolder" (dateSelect)="onChangeDebounce()" (change)="onChangeDebounce()"
+                    [(ngModel)]="dateAfter" ngbDatepicker #dateAfterPicker="ngbDatepicker">
+            <div class="input-group-append">
+              <button class="btn btn-outline-secondary" (click)="dateAfterPicker.toggle()" type="button">
+                <svg xmlns="http://www.w3.org/2000/svg" width="13" height="13" fill="currentColor" class="bi bi-calendar" viewBox="0 0 16 16">
+                  <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
+                </svg>
+              </button>
+            </div>
           </div>
+
         </div>
         <div class="list-group-item d-flex flex-column align-items-start" role="menuitem">
 
@@ -36,8 +45,17 @@
           </div>
 
           <div class="input-group input-group-sm">
-            <input type="date" class="form-control" id="date_before" [(ngModel)]="dateBefore" (change)="onChangeDebounce()">
+            <input class="form-control" [placeholder]="datePlaceHolder" (dateSelect)="onChangeDebounce()" (change)="onChangeDebounce()"
+                    [(ngModel)]="dateBefore" ngbDatepicker #dateBeforePicker="ngbDatepicker">
+            <div class="input-group-append">
+              <button class="btn btn-outline-secondary" (click)="dateBeforePicker.toggle()" type="button">
+                <svg xmlns="http://www.w3.org/2000/svg" width="13" height="13" fill="currentColor" class="bi bi-calendar" viewBox="0 0 16 16">
+                  <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
+                </svg>
+              </button>
+            </div>
           </div>
+
         </div>
     </div>
   </div>

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

@@ -1,7 +1,10 @@
 import { formatDate } from '@angular/common';
 import { Component, EventEmitter, Input, Output, OnInit, OnDestroy } from '@angular/core';
+import { NgbDateAdapter } from '@ng-bootstrap/ng-bootstrap';
 import { Subject, Subscription } from 'rxjs';
-import { debounceTime, distinctUntilChanged } from 'rxjs/operators';
+import { debounceTime } from 'rxjs/operators';
+import { SettingsService } from 'src/app/services/settings.service';
+import { ISODateAdapter } from 'src/app/utils/ngb-iso-date-adapter';
 
 export interface DateSelection {
   before?: string
@@ -16,10 +19,17 @@ const LAST_YEAR = 3
 @Component({
   selector: 'app-date-dropdown',
   templateUrl: './date-dropdown.component.html',
-  styleUrls: ['./date-dropdown.component.scss']
+  styleUrls: ['./date-dropdown.component.scss'],
+  providers: [
+    {provide: NgbDateAdapter, useClass: ISODateAdapter},
+  ]
 })
 export class DateDropdownComponent implements OnInit, OnDestroy {
 
+  constructor(settings: SettingsService) {
+    this.datePlaceHolder = settings.getLocalizedDateInputFormat()
+  }
+
   quickFilters = [
     {id: LAST_7_DAYS, name: $localize`Last 7 days`},
     {id: LAST_MONTH, name: $localize`Last month`},
@@ -27,6 +37,8 @@ export class DateDropdownComponent implements OnInit, OnDestroy {
     {id: LAST_YEAR, name: $localize`Last year`}
   ]
 
+  datePlaceHolder: string
+
   @Input()
   dateBefore: string
 

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

@@ -27,6 +27,8 @@ export abstract class EditDialogComponent<T extends ObjectWithId> implements OnI
 
   networkActive = false
 
+  closeEnabled = false
+
   error = null
 
   abstract getForm(): FormGroup
@@ -37,6 +39,11 @@ export abstract class EditDialogComponent<T extends ObjectWithId> implements OnI
     if (this.object != null) {
       this.objectForm.patchValue(this.object)
     }
+
+    // wait to enable close button so it doesnt steal focus from input since its the first clickable element in the DOM
+    setTimeout(() => {
+      this.closeEnabled = true
+    });
   }
 
   getCreateTitle() {

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

@@ -83,7 +83,7 @@ export class FilterableDropdownSelectionModel {
     if (fireEvent) {
       this.changed.next(this)
     }
-    
+
   }
 
   private getNonTemporary(id: number) {

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

@@ -10,7 +10,7 @@
         <path d="M4 8a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7A.5.5 0 0 1 4 8z"/>
       </svg>
     </ng-container>
-    
+
   </div>
   <div class="mr-1">
     <app-tag *ngIf="isTag; else displayName" [tag]="item" [clickable]="true" linkTitle="Filter by tag"></app-tag>

src-ui/src/app/components/common/input/abstract-input.ts

@@ -11,7 +11,7 @@ export class AbstractInputComponent<T> implements OnInit, ControlValueAccessor {
   constructor() { }
 
   onChange = (newValue: T) => {};
-  
+
   onTouched = () => {};
 
   writeValue(newValue: any): void {

src-ui/src/app/components/common/input/check/check.component.html

@@ -2,4 +2,4 @@
   <input type="checkbox" class="custom-control-input" [id]="inputId" [(ngModel)]="value" (change)="onChange(value)" (blur)="onTouched()" [disabled]="disabled">
   <label class="custom-control-label" [for]="inputId">{{title}}</label>
   <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
-</div>
+</div>

src-ui/src/app/components/common/input/check/check.component.ts

@@ -15,7 +15,7 @@ import { AbstractInputComponent } from '../abstract-input';
 })
 export class CheckComponent extends AbstractInputComponent<boolean> {
 
-  constructor() { 
+  constructor() {
     super()
   }
 

src-ui/src/app/components/common/input/color/color.component.html

@@ -0,0 +1,33 @@
+<div class="form-group">
+  <label [for]="inputId">{{title}}</label>
+
+  <div class="input-group" [class.is-invalid]="error">
+      <div class="input-group-prepend">
+        <span class="input-group-text" [style.background-color]="value">&nbsp;&nbsp;&nbsp;</span>
+      </div>
+
+      <ng-template #popContent>
+        <div style="min-width: 200px;" class="pb-3">
+          <color-slider [color]="value" (onChangeComplete)="colorChanged($event.color.hex)"></color-slider>
+        </div>
+
+      </ng-template>
+
+      <input class="form-control" [class.is-invalid]="error" [id]="inputId" [(ngModel)]="value" (change)="onChange(value)" [autoClose]="'outside'" [ngbPopover]="popContent" placement="bottom" popoverClass="shadow">
+
+      <div class="input-group-append">
+        <button class="btn btn-outline-secondary" type="button" (click)="randomize()">
+          <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-dice-5" viewBox="0 0 16 16">
+            <path d="M13 1a2 2 0 0 1 2 2v10a2 2 0 0 1-2 2H3a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h10zM3 0a3 3 0 0 0-3 3v10a3 3 0 0 0 3 3h10a3 3 0 0 0 3-3V3a3 3 0 0 0-3-3H3z"/>
+            <path d="M5.5 4a1.5 1.5 0 1 1-3 0 1.5 1.5 0 0 1 3 0zm8 0a1.5 1.5 0 1 1-3 0 1.5 1.5 0 0 1 3 0zm0 8a1.5 1.5 0 1 1-3 0 1.5 1.5 0 0 1 3 0zm-8 0a1.5 1.5 0 1 1-3 0 1.5 1.5 0 0 1 3 0zm4-4a1.5 1.5 0 1 1-3 0 1.5 1.5 0 0 1 3 0z"/>
+          </svg>
+        </button>
+      </div>
+
+
+    </div>
+    <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
+    <div class="invalid-feedback">
+      {{error}}
+    </div>
+</div>

src-ui/src/app/components/common/input/color/color.component.spec.ts

@@ -1,20 +1,20 @@
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 
-import { SearchComponent } from './search.component';
+import { ColorComponent } from './color.component';
 
-describe('SearchComponent', () => {
-  let component: SearchComponent;
-  let fixture: ComponentFixture<SearchComponent>;
+describe('ColorComponent', () => {
+  let component: ColorComponent;
+  let fixture: ComponentFixture<ColorComponent>;
 
   beforeEach(async () => {
     await TestBed.configureTestingModule({
-      declarations: [ SearchComponent ]
+      declarations: [ ColorComponent ]
     })
     .compileComponents();
   });
 
   beforeEach(() => {
-    fixture = TestBed.createComponent(SearchComponent);
+    fixture = TestBed.createComponent(ColorComponent);
     component = fixture.componentInstance;
     fixture.detectChanges();
   });

src-ui/src/app/components/common/input/color/color.component.ts

@@ -0,0 +1,30 @@
+import { Component, forwardRef } from '@angular/core';
+import { NG_VALUE_ACCESSOR } from '@angular/forms';
+import { randomColor } from 'src/app/utils/color';
+import { AbstractInputComponent } from '../abstract-input';
+
+@Component({
+  providers: [{
+    provide: NG_VALUE_ACCESSOR,
+    useExisting: forwardRef(() => ColorComponent),
+    multi: true
+  }],
+  selector: 'app-input-color',
+  templateUrl: './color.component.html',
+  styleUrls: ['./color.component.scss']
+})
+export class ColorComponent extends AbstractInputComponent<string> {
+
+  constructor() {
+    super()
+  }
+
+  randomize() {
+    this.colorChanged(randomColor())
+  }
+
+  colorChanged(value) {
+    this.value = value
+    this.onChange(value)
+  }
+}

src-ui/src/app/components/common/input/date-time/date-time.component.html

@@ -1,13 +0,0 @@
-<div class="form-row">
-  <div class="form-group col">
-      <label for="created_date">{{titleDate}}</label>
-      <input type="date" class="form-control" id="created_date" [(ngModel)]="dateValue" (change)="dateOrTimeChanged()">
-  </div>
-  <div class="form-group col" *ngIf="titleTime">
-      <label for="created_time">{{titleTime}}</label>
-      <input type="time" class="form-control" id="created_time" [(ngModel)]="timeValue" (change)="dateOrTimeChanged()">
-  </div>
-</div>
-
-
-<!-- <small *ngIf="hint" class="form-text text-muted">{{hint}}</small> -->

src-ui/src/app/components/common/input/date-time/date-time.component.ts

@@ -1,61 +0,0 @@
-import { formatDate } from '@angular/common';
-import { Component, forwardRef, Input, OnInit } from '@angular/core';
-import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms';
-
-@Component({
-  providers: [{
-    provide: NG_VALUE_ACCESSOR,
-    useExisting: forwardRef(() => DateTimeComponent),
-    multi: true
-  }],
-  selector: 'app-input-date-time',
-  templateUrl: './date-time.component.html',
-  styleUrls: ['./date-time.component.scss']
-})
-export class DateTimeComponent implements OnInit,ControlValueAccessor  {
-
-  constructor() {
-  }
-
-  onChange = (newValue: any) => {};
-  
-  onTouched = () => {};
-
-  writeValue(newValue: any): void {
-    this.dateValue = formatDate(newValue, 'yyyy-MM-dd', "en-US")
-    this.timeValue = formatDate(newValue, 'HH:mm:ss', 'en-US')
-  }
-  registerOnChange(fn: any): void {
-    this.onChange = fn;
-  }
-  registerOnTouched(fn: any): void {
-    this.onTouched = fn;
-  }
-  setDisabledState?(isDisabled: boolean): void {
-    this.disabled = isDisabled;
-  }
-
-  @Input()
-  titleDate: string = "Date"
-
-  @Input()
-  titleTime: string
-
-  @Input()
-  disabled: boolean = false
-
-  @Input()
-  hint: string
-
-  timeValue
-
-  dateValue
-
-  ngOnInit(): void {
-  }
-
-  dateOrTimeChanged() {
-    this.onChange(formatDate(this.dateValue + "T" + this.timeValue,"yyyy-MM-ddTHH:mm:ssZZZZZ", "en-us", "UTC"))
-  }
-
-}

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

@@ -0,0 +1,16 @@
+<div class="form-group">
+  <label [for]="inputId">{{title}}</label>
+  <div class="input-group" [class.is-invalid]="error">
+    <input class="form-control" [class.is-invalid]="error"  [placeholder]="placeholder" [id]="inputId" (dateSelect)="onChange(value)" (change)="onChange(value)"
+           name="dp" [(ngModel)]="value" ngbDatepicker #datePicker="ngbDatepicker" #datePickerContent="ngModel">
+    <div class="input-group-append">
+      <button class="btn btn-outline-secondary calendar" (click)="datePicker.toggle()" type="button">
+        <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-calendar" viewBox="0 0 16 16">
+          <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
+        </svg>
+      </button>
+    </div>
+  </div>
+  <div class="invalid-feedback" i18n>Invalid date.</div>
+  <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
+</div>

src-ui/src/app/components/common/input/date/date.component.spec.ts

@@ -1,20 +1,20 @@
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 
-import { DateTimeComponent } from './date-time.component';
+import { DateComponent } from './date.component';
 
-describe('DateTimeComponent', () => {
-  let component: DateTimeComponent;
-  let fixture: ComponentFixture<DateTimeComponent>;
+describe('DateComponent', () => {
+  let component: DateComponent;
+  let fixture: ComponentFixture<DateComponent>;
 
   beforeEach(async () => {
     await TestBed.configureTestingModule({
-      declarations: [ DateTimeComponent ]
+      declarations: [ DateComponent ]
     })
     .compileComponents();
   });
 
   beforeEach(() => {
-    fixture = TestBed.createComponent(DateTimeComponent);
+    fixture = TestBed.createComponent(DateComponent);
     component = fixture.componentInstance;
     fixture.detectChanges();
   });

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

@@ -0,0 +1,32 @@
+import { Component, forwardRef, Input, OnInit, ViewChild } from '@angular/core';
+import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms';
+import { NgbDateAdapter, NgbDateParserFormatter, NgbDatepickerContent } from '@ng-bootstrap/ng-bootstrap';
+import { SettingsService } from 'src/app/services/settings.service';
+import { v4 as uuidv4 } from 'uuid';
+import { AbstractInputComponent } from '../abstract-input';
+
+
+@Component({
+  providers: [{
+    provide: NG_VALUE_ACCESSOR,
+    useExisting: forwardRef(() => DateComponent),
+    multi: true
+  }],
+  selector: 'app-input-date',
+  templateUrl: './date.component.html',
+  styleUrls: ['./date.component.scss']
+})
+export class DateComponent extends AbstractInputComponent<string> implements OnInit {
+
+  constructor(private settings: SettingsService) {
+    super()
+  }
+
+  ngOnInit(): void {
+    super.ngOnInit()
+    this.placeholder = this.settings.getLocalizedDateInputFormat()
+  }
+
+  placeholder: string
+
+}

src-ui/src/app/components/common/input/number/number.component.html

@@ -11,4 +11,4 @@
   </div>
   <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
 
-</div>
+</div>

src-ui/src/app/components/common/input/select/select.component.html

@@ -1,25 +1,38 @@
 <div class="form-group paperless-input-select">
   <label [for]="inputId">{{title}}</label>
-  <div [class.input-group]="showPlusButton()">
-    <ng-select name="inputId" [(ngModel)]="value"
-      [disabled]="disabled"
-      [style.color]="textColor"
-      [style.background]="backgroundColor"
-      [clearable]="allowNull"
-      [items]="items"
-      bindLabel="name"
-      bindValue="id"
-      (change)="onChange(value)"
-      (blur)="onTouched()">
-    </ng-select>
-
-    <div *ngIf="showPlusButton()" class="input-group-append">
-      <button class="btn btn-outline-secondary" type="button" (click)="createNew.emit()">
-        <svg class="buttonicon" fill="currentColor">
-          <use xlink:href="assets/bootstrap-icons.svg#plus" />
-        </svg>
-      </button>
+    <div [class.input-group]="allowCreateNew">
+      <ng-select name="inputId" [(ngModel)]="value"
+        [disabled]="disabled"
+        [style.color]="textColor"
+        [style.background]="backgroundColor"
+        [clearable]="allowNull"
+        [items]="items"
+        [addTag]="allowCreateNew && addItemRef"
+        addTagText="Add item"
+        i18n-addTagText="Used for both types and correspondents"
+        bindLabel="name"
+        bindValue="id"
+        (change)="onChange(value)"
+        (search)="onSearch($event)"
+        (focus)="clearLastSearchTerm()"
+        (clear)="clearLastSearchTerm()"
+        (blur)="onBlur()">
+      </ng-select>
+      <div *ngIf="allowCreateNew" class="input-group-append">
+        <button class="btn btn-outline-secondary" type="button" (click)="addItem()">
+          <svg class="buttonicon" fill="currentColor">
+            <use xlink:href="assets/bootstrap-icons.svg#plus" />
+          </svg>
+        </button>
+      </div>
     </div>
-  </div>
   <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
+  <small *ngIf="getSuggestions().length > 0">
+    <span i18n>Suggestions:</span>&nbsp;
+    <ng-container *ngFor="let s of getSuggestions()">
+      <a (click)="value = s.id; onChange(value)" [routerLink]="">{{s.name}}</a>&nbsp;
+    </ng-container>
+
+
+  </small>
 </div>

src-ui/src/app/components/common/input/select/select.component.ts

@@ -16,6 +16,7 @@ export class SelectComponent extends AbstractInputComponent<number> {
 
   constructor() {
     super()
+    this.addItemRef = this.addItem.bind(this)
    }
 
   @Input()
@@ -30,11 +31,51 @@ export class SelectComponent extends AbstractInputComponent<number> {
   @Input()
   allowNull: boolean = false
 
+  @Input()
+  suggestions: number[]
+
   @Output()
-  createNew = new EventEmitter()
-  
-  showPlusButton(): boolean {
+  createNew = new EventEmitter<string>()
+
+  public addItemRef: (name) => void
+
+  private _lastSearchTerm: string
+
+  get allowCreateNew(): boolean {
     return this.createNew.observers.length > 0
   }
 
+  getSuggestions() {
+    if (this.suggestions && this.items) {
+      return this.suggestions.filter(id => id != this.value).map(id => this.items.find(item => item.id == id))
+    } else {
+      return []
+    }
+  }
+
+  addItem(name: string) {
+    if (name) this.createNew.next(name)
+    else this.createNew.next(this._lastSearchTerm)
+    this.clearLastSearchTerm()
+  }
+
+  clickNew() {
+    this.createNew.next(this._lastSearchTerm)
+    this.clearLastSearchTerm()
+  }
+
+  clearLastSearchTerm() {
+    this._lastSearchTerm = null
+  }
+
+  onSearch($event) {
+    this._lastSearchTerm = $event.term
+  }
+
+  onBlur() {
+    setTimeout(() => {
+      this.clearLastSearchTerm()
+    }, 3000);
+  }
+
 }

src-ui/src/app/components/common/input/tags/tags.component.html

@@ -2,30 +2,31 @@
   <label for="tags" i18n>Tags</label>
 
   <div class="input-group flex-nowrap">
-    <ng-select name="tags" [items]="tags" bindLabel="name" bindValue="id" [(ngModel)]="displayValue"
+    <ng-select name="tags" [items]="tags" bindLabel="name" bindValue="id" [(ngModel)]="value"
       [multiple]="true"
       [closeOnSelect]="false"
       [clearSearchOnAdd]="true"
-      [disabled]="disabled"
       [hideSelected]="true"
-      (change)="ngSelectChange()">
+      [addTag]="createTagRef"
+      addTagText="Add tag"
+      i18n-addTagText
+      (change)="onChange(value)"
+      (search)="onSearch($event)"
+      (focus)="clearLastSearchTerm()"
+      (clear)="clearLastSearchTerm()"
+      (blur)="onBlur()">
 
       <ng-template ng-label-tmp let-item="item">
         <span class="tag-wrap tag-wrap-delete" (click)="removeTag(item.id)">
           <svg width="1.2em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
             <use xlink:href="assets/bootstrap-icons.svg#x"/>
           </svg>
-          <app-tag style="background-color: none;" [tag]="getTag(item.id)"></app-tag>
+          <app-tag *ngIf="item.id && tags" style="background-color: none;" [tag]="getTag(item.id)"></app-tag>
         </span>
       </ng-template>
       <ng-template ng-option-tmp let-item="item" let-index="index" let-search="searchTerm">
         <div class="tag-wrap">
-          <div class="selected-icon d-inline-block mr-1">
-            <svg *ngIf="displayValue.includes(item.id)" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
-              <use xlink:href="assets/bootstrap-icons.svg#check"/>
-            </svg>
-          </div>
-          <app-tag class="mr-2" [tag]="getTag(item.id)"></app-tag>
+          <app-tag *ngIf="item.id && tags" class="mr-2" [tag]="getTag(item.id)"></app-tag>
         </div>
       </ng-template>
     </ng-select>
@@ -39,5 +40,13 @@
     </div>
   </div>
   <small class="form-text text-muted" *ngIf="hint">{{hint}}</small>
+  <small *ngIf="getSuggestions().length > 0">
+    <span i18n>Suggestions:</span>&nbsp;
+    <ng-container *ngFor="let tag of getSuggestions()">
+      <a (click)="addTag(tag.id)" [routerLink]="">{{tag.name}}</a>&nbsp;
+    </ng-container>
+
+
+  </small>
 
 </div>

src-ui/src/app/components/common/input/tags/tags.component.ts

@@ -17,8 +17,9 @@ import { TagService } from 'src/app/services/rest/tag.service';
 })
 export class TagsComponent implements OnInit, ControlValueAccessor {
 
-  constructor(private tagService: TagService, private modalService: NgbModal) { }
-
+  constructor(private tagService: TagService, private modalService: NgbModal) {
+    this.createTagRef = this.createTag.bind(this)
+  }
 
   onChange = (newValue: number[]) => {};
 
@@ -26,9 +27,6 @@ export class TagsComponent implements OnInit, ControlValueAccessor {
 
   writeValue(newValue: number[]): void {
     this.value = newValue
-    if (this.tags) {
-      this.displayValue = newValue
-    }
   }
   registerOnChange(fn: any): void {
     this.onChange = fn;
@@ -43,7 +41,6 @@ export class TagsComponent implements OnInit, ControlValueAccessor {
   ngOnInit(): void {
     this.tagService.listAll().subscribe(result => {
       this.tags = result.results
-      this.displayValue = this.value
     })
   }
 
@@ -53,41 +50,74 @@ export class TagsComponent implements OnInit, ControlValueAccessor {
   @Input()
   hint
 
-  value: number[]
+  @Input()
+  suggestions: number[]
 
-  displayValue: number[] = []
+  value: number[]
 
   tags: PaperlessTag[]
 
-  getTag(id) {
-    return this.tags.find(tag => tag.id == id)
-  }
+  public createTagRef: (name) => void
 
-  removeTag(id) {
-    let index = this.displayValue.indexOf(id)
-    if (index > -1) {
-      let oldValue = this.displayValue
-      oldValue.splice(index, 1)
-      this.displayValue = [...oldValue]
-      this.onChange(this.displayValue)
+  private _lastSearchTerm: string
+
+  getTag(id) {
+    if (this.tags) {
+      return this.tags.find(tag => tag.id == id)
+    } else {
+      return null
     }
   }
 
-  createTag() {
+  removeTag(id) {
+    let index = this.value.indexOf(id)
+    if (index > -1) {
+      let oldValue = this.value
+      oldValue.splice(index, 1)
+      this.value = [...oldValue]
+      this.onChange(this.value)
+    }
+  }
+
+  createTag(name: string = null) {
     var modal = this.modalService.open(TagEditDialogComponent, {backdrop: 'static'})
     modal.componentInstance.dialogMode = 'create'
+    if (name) modal.componentInstance.object = { name: name }
+    else if (this._lastSearchTerm) modal.componentInstance.object = { name: this._lastSearchTerm }
     modal.componentInstance.success.subscribe(newTag => {
       this.tagService.listAll().subscribe(tags => {
         this.tags = tags.results
-        this.displayValue = [...this.displayValue, newTag.id]
-        this.onChange(this.displayValue)
+        this.value = [...this.value, newTag.id]
+        this.onChange(this.value)
       })
     })
   }
 
-  ngSelectChange() {
-    this.value = this.displayValue
-    this.onChange(this.displayValue)
+  getSuggestions() {
+    if (this.suggestions && this.tags) {
+      return this.suggestions.filter(id => !this.value.includes(id)).map(id => this.tags.find(tag => tag.id == id))
+    } else {
+      return []
+    }
+  }
+
+  addTag(id) {
+    this.value = [...this.value, id]
+    this.onChange(this.value)
+  }
+
+  clearLastSearchTerm() {
+    this._lastSearchTerm = null
+  }
+
+  onSearch($event) {
+    this._lastSearchTerm = $event.term
+  }
+
+  onBlur() {
+    setTimeout(() => {
+      this.clearLastSearchTerm()
+    }, 3000);
   }
 
 }

src-ui/src/app/components/common/input/text/text.component.html

@@ -5,4 +5,4 @@
   <div class="invalid-feedback">
     {{error}}
   </div>
-</div>
+</div>

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

@@ -12,4 +12,4 @@
 <div class="modal-footer">
   <button type="button" class="btn btn-outline-dark" (click)="cancelClicked()" i18n>Cancel</button>
   <button type="button" class="btn btn-primary" (click)="selectClicked.emit(selected)" i18n>Select</button>
-</div>
+</div>

src-ui/src/app/components/common/tag/tag.component.html

@@ -1,2 +1,2 @@
-<span *ngIf="!clickable" class="badge" [style.background]="getColour().value" [style.color]="getColour().textColor">{{tag.name}}</span>
-<a [routerLink]="" [title]="linkTitle" *ngIf="clickable" class="badge" [style.background]="getColour().value" [style.color]="getColour().textColor">{{tag.name}}</a>
+<span *ngIf="!clickable" class="badge" [style.background]="tag.color" [style.color]="tag.text_color">{{tag.name}}</span>
+<a [routerLink]="" [title]="linkTitle" *ngIf="clickable" class="badge" [style.background]="tag.color" [style.color]="tag.text_color">{{tag.name}}</a>

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

@@ -1,5 +1,5 @@
 import { Component, Input, OnInit } from '@angular/core';
-import { TAG_COLOURS, PaperlessTag } from 'src/app/data/paperless-tag';
+import { PaperlessTag } from 'src/app/data/paperless-tag';
 
 @Component({
   selector: 'app-tag',
@@ -22,8 +22,4 @@ export class TagComponent implements OnInit {
   ngOnInit(): void {
   }
 
-  getColour() {
-    return TAG_COLOURS.find(c => c.id == this.tag.colour)
-  }
-
 }

src-ui/src/app/components/common/toasts/toasts.component.html

@@ -3,5 +3,6 @@
   [header]="toast.title" [autohide]="true" [delay]="toast.delay"
   [class]="toast.classname"
   (hide)="toastService.closeToast(toast)">
-  {{toast.content}}
-</ngb-toast>
+  <p>{{toast.content}}</p>
+  <p *ngIf="toast.action"><button class="btn btn-sm btn-outline-secondary" (click)="toastService.closeToast(toast); toast.action()">{{toast.actionName}}</button></p>
+</ngb-toast>

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

@@ -12,10 +12,10 @@
     </thead>
     <tbody>
       <tr *ngFor="let doc of documents" routerLink="/documents/{{doc.id}}">
-        <td>{{doc.created | date}}</td>
+        <td>{{doc.created | customDate}}</td>
         <td>{{doc.title | documentTitle}}<app-tag [tag]="t" *ngFor="let t of doc.tags$ | async" class="ml-1"></app-tag>
       </tr>
     </tbody>
   </table>
 
-</app-widget-frame>
+</app-widget-frame>

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

@@ -1,8 +1,10 @@
-import { Component, Input, OnInit } from '@angular/core';
+import { Component, Input, OnDestroy, OnInit } from '@angular/core';
 import { Router } from '@angular/router';
+import { Subscription } from 'rxjs';
 import { PaperlessDocument } from 'src/app/data/paperless-document';
 import { PaperlessSavedView } from 'src/app/data/paperless-saved-view';
 import { DocumentListViewService } from 'src/app/services/document-list-view.service';
+import { ConsumerStatusService } from 'src/app/services/consumer-status.service';
 import { DocumentService } from 'src/app/services/rest/document.service';
 
 @Component({
@@ -10,19 +12,33 @@ import { DocumentService } from 'src/app/services/rest/document.service';
   templateUrl: './saved-view-widget.component.html',
   styleUrls: ['./saved-view-widget.component.scss']
 })
-export class SavedViewWidgetComponent implements OnInit {
+export class SavedViewWidgetComponent implements OnInit, OnDestroy {
 
   constructor(
     private documentService: DocumentService,
     private router: Router,
-    private list: DocumentListViewService) { }
-  
+    private list: DocumentListViewService,
+    private consumerStatusService: ConsumerStatusService) { }
+
   @Input()
   savedView: PaperlessSavedView
 
   documents: PaperlessDocument[] = []
 
+  subscription: Subscription
+
   ngOnInit(): void {
+    this.reload()
+    this.subscription = this.consumerStatusService.onDocumentConsumptionFinished().subscribe(status => {
+      this.reload()
+    })
+  }
+
+  ngOnDestroy(): void {
+    this.subscription.unsubscribe()
+  }
+
+  reload() {
     this.documentService.listFiltered(1,10,this.savedView.sort_field, this.savedView.sort_reverse, this.savedView.filter_rules).subscribe(result => {
       this.documents = result.results
     })
@@ -32,9 +48,9 @@ export class SavedViewWidgetComponent implements OnInit {
     if (this.savedView.show_in_sidebar) {
       this.router.navigate(['view', this.savedView.id])
     } else {
-      this.list.load(this.savedView)
+      this.list.loadSavedView(this.savedView, true)
       this.router.navigate(["documents"])
-      }
+    }
   }
 
 }

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

@@ -1,6 +1,6 @@
 <app-widget-frame title="Statistics" i18n-title>
   <ng-container content>
-    <p class="card-text" i18n>Documents in inbox: {{statistics.documents_inbox}}</p>
-    <p class="card-text" i18n>Total documents: {{statistics.documents_total}}</p>
+    <p class="card-text" i18n *ngIf="statistics?.documents_inbox != null">Documents in inbox: {{statistics?.documents_inbox}}</p>
+    <p class="card-text" i18n>Total documents: {{statistics?.documents_total}}</p>
   </ng-container>
-</app-widget-frame>
+</app-widget-frame>

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

@@ -1,6 +1,7 @@
 import { HttpClient } from '@angular/common/http';
-import { Component, OnInit } from '@angular/core';
-import { Observable } from 'rxjs';
+import { Component, OnDestroy, OnInit } from '@angular/core';
+import { Observable, Subscription } from 'rxjs';
+import { ConsumerStatusService } from 'src/app/services/consumer-status.service';
 import { environment } from 'src/environments/environment';
 
 export interface Statistics {
@@ -14,20 +15,34 @@ export interface Statistics {
   templateUrl: './statistics-widget.component.html',
   styleUrls: ['./statistics-widget.component.scss']
 })
-export class StatisticsWidgetComponent implements OnInit {
+export class StatisticsWidgetComponent implements OnInit, OnDestroy {
 
-  constructor(private http: HttpClient) { }
+  constructor(private http: HttpClient,
+    private consumerStatusService: ConsumerStatusService) { }
 
   statistics: Statistics = {}
 
-  getStatistics(): Observable<Statistics> {
+  subscription: Subscription
+
+  private getStatistics(): Observable<Statistics> {
     return this.http.get(`${environment.apiBaseUrl}statistics/`)
   }
-  
-  ngOnInit(): void {
+
+  reload() {
     this.getStatistics().subscribe(statistics => {
       this.statistics = statistics
     })
   }
 
+  ngOnInit(): void {
+    this.reload()
+    this.subscription = this.consumerStatusService.onDocumentConsumptionFinished().subscribe(status => {
+      this.reload()
+    })
+  }
+
+  ngOnDestroy(): void {
+    this.subscription.unsubscribe()
+  }
+
 }

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

@@ -1,18 +1,52 @@
 <app-widget-frame title="Upload new documents" i18n-title>
-
+  <div header-buttons>
+    <a *ngIf="getStatusSuccess().length > 0" (click)="dismissCompleted()" [routerLink]="" >
+      <span i18n="This button dismisses all status messages about processed documents on the dashboard (failed and successful)">Dismiss completed</span>&nbsp;
+      <svg xmlns="http://www.w3.org/2000/svg" width="1rem" height="1rem" fill="currentColor" class="bi bi-check2-all" viewBox="0 0 16 16">
+        <path d="M12.354 4.354a.5.5 0 0 0-.708-.708L5 10.293 1.854 7.146a.5.5 0 1 0-.708.708l3.5 3.5a.5.5 0 0 0 .708 0l7-7zm-4.208 7l-.896-.897.707-.707.543.543 6.646-6.647a.5.5 0 0 1 .708.708l-7 7a.5.5 0 0 1-.708 0z"/>
+        <path d="M5.354 7.146l.896.897-.707.707-.897-.896a.5.5 0 1 1 .708-.708z"/>
+      </svg>
+    </a>
+  </div>
   <div content>
     <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"
-        multiple="true" contentClassName="justify-content-center d-flex align-items-center p-5" [showBrowseBtn]=true
+        multiple="true" contentClassName="justify-content-center d-flex align-items-center py-5 px-2" [showBrowseBtn]=true
         browseBtnClassName="btn btn-sm btn-outline-primary ml-2" i18n-dropZoneLabel i18n-browseBtnLabel>
-
       </ngx-file-drop>
     </form>
-    <div *ngIf="uploadVisible" class="mt-3">
-      <p i18n>{uploadStatus.length, plural, =1 {Uploading file...} =other {Uploading {{uploadStatus.length}} files...}}</p>
-      <ngb-progressbar [value]="loadedSum" [max]="totalSum" [striped]="true" [animated]="uploadStatus.length > 0">
-      </ngb-progressbar>
+    <p class="mt-3" *ngIf="getStatus().length > 0">{{getStatusSummary()}}</p>
+    <div *ngFor="let status of getStatus()">
+      <ng-container [ngTemplateOutlet]="consumerAlert" [ngTemplateOutletContext]="{ $implicit: status }"></ng-container>
+    </div>
+    <div *ngIf="getStatusHidden().length" class="alerts-hidden">
+      <p *ngIf="!alertsExpanded" class="mt-3 mb-0 text-center">
+        <span i18n="This is shown as a summary line when there are more than 5 document in the processing pipeline.">{getStatusHidden().length, plural, =1 {One more document} other {{{getStatusHidden().length}} more documents}}</span>
+        &nbsp;&bull;&nbsp;
+        <a [routerLink]="" (click)="alertsExpanded = !alertsExpanded" aria-controls="hiddenAlerts" [attr.aria-expanded]="alertsExpanded" i18n>Show all</a>
+      </p>
+      <div #hiddenAlerts="ngbCollapse" [(ngbCollapse)]="!alertsExpanded">
+        <div *ngFor="let status of getStatusHidden()">
+          <ng-container [ngTemplateOutlet]="consumerAlert" [ngTemplateOutletContext]="{ $implicit: status }"></ng-container>
+        </div>
+      </div>
     </div>
   </div>
-</app-widget-frame>
+</app-widget-frame>
+
+<ng-template #consumerAlert let-status>
+  <ngb-alert type="secondary" class="mt-2 mb-0" [dismissible]="isFinished(status)" (closed)="dismiss(status)">
+    <h6 class="alert-heading">{{status.filename}}</h6>
+    <p class="mb-0 pb-1" *ngIf="!isFinished(status) || (isFinished(status) && !status.documentId)">{{status.message}}</p>
+    <ngb-progressbar [value]="status.getProgress()" [max]="1" [type]="getStatusColor(status)"></ngb-progressbar>
+    <div *ngIf="isFinished(status)">
+      <button *ngIf="status.documentId" class="btn btn-sm btn-outline-primary btn-open" routerLink="/documents/{{status.documentId}}" (click)="dismiss(status)">
+        <small i18n>Open document</small>
+        <svg xmlns="http://www.w3.org/2000/svg" width="1rem" height="1rem" fill="currentColor" class="bi bi-arrow-right-short" viewBox="0 0 16 16">
+          <path fill-rule="evenodd" d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/>
+        </svg>
+      </button>
+    </div>
+  </ngb-alert>
+</ng-template>

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

@@ -0,0 +1,35 @@
+@import "/src/theme";
+
+form {
+  position: relative;
+}
+
+.alert-heading {
+  font-size: 80%;
+  font-weight: bold;
+}
+
+.alerts-hidden {
+  .btn {
+    line-height: 1;
+  }
+}
+
+.btn-open {
+  line-height: 1;
+
+  svg {
+    margin-top: -1px;
+  }
+}
+
+.progress {
+  position: absolute;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  left: 0;
+  height: auto;
+  mix-blend-mode: soft-light;
+  pointer-events: none;
+}

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

@@ -1,14 +1,10 @@
 import { HttpEventType } from '@angular/common/http';
 import { Component, OnInit } from '@angular/core';
 import { FileSystemFileEntry, NgxFileDropEntry } from 'ngx-file-drop';
+import { ConsumerStatusService, FileStatus, FileStatusPhase } from 'src/app/services/consumer-status.service';
 import { DocumentService } from 'src/app/services/rest/document.service';
-import { ToastService } from 'src/app/services/toast.service';
 
-
-interface UploadStatus {
-  loaded: number
-  total: number 
-}
+const MAX_ALERTS = 5
 
 @Component({
   selector: 'app-upload-file-widget',
@@ -16,8 +12,89 @@ interface UploadStatus {
   styleUrls: ['./upload-file-widget.component.scss']
 })
 export class UploadFileWidgetComponent implements OnInit {
+  alertsExpanded = false
 
-  constructor(private documentService: DocumentService, private toastService: ToastService) { }
+  constructor(
+    private documentService: DocumentService,
+    private consumerStatusService: ConsumerStatusService
+  ) { }
+
+  getStatus() {
+    return this.consumerStatusService.getConsumerStatus().slice(0, MAX_ALERTS)
+  }
+
+  getStatusSummary() {
+    let strings = []
+    let countUploadingAndProcessing =  this.consumerStatusService.getConsumerStatusNotCompleted().length
+    let countFailed = this.getStatusFailed().length
+    let countSuccess = this.getStatusSuccess().length
+    if (countUploadingAndProcessing > 0) {
+      strings.push($localize`Processing: ${countUploadingAndProcessing}`)
+    }
+    if (countFailed > 0) {
+      strings.push($localize`Failed: ${countFailed}`)
+    }
+    if (countSuccess > 0) {
+      strings.push($localize`Added: ${countSuccess}`)
+    }
+    return strings.join($localize`:this string is used to separate processing, failed and added on the file upload widget:, `)
+  }
+
+  getStatusHidden() {
+    if (this.consumerStatusService.getConsumerStatus().length < MAX_ALERTS) return []
+    else return this.consumerStatusService.getConsumerStatus().slice(MAX_ALERTS)
+  }
+
+  getStatusUploading() {
+    return this.consumerStatusService.getConsumerStatus(FileStatusPhase.UPLOADING)
+  }
+
+  getStatusFailed() {
+    return this.consumerStatusService.getConsumerStatus(FileStatusPhase.FAILED)
+  }
+
+  getStatusSuccess() {
+    return this.consumerStatusService.getConsumerStatus(FileStatusPhase.SUCCESS)
+  }
+
+  getStatusCompleted() {
+    return this.consumerStatusService.getConsumerStatusCompleted()
+  }
+  getTotalUploadProgress() {
+    let current = 0
+    let max = 0
+
+    this.getStatusUploading().forEach(status => {
+      current += status.currentPhaseProgress
+      max += status.currentPhaseMaxProgress
+    })
+
+    return current / Math.max(max, 1)
+  }
+
+  isFinished(status: FileStatus) {
+    return status.phase == FileStatusPhase.FAILED || status.phase == FileStatusPhase.SUCCESS
+  }
+
+  getStatusColor(status: FileStatus) {
+    switch (status.phase) {
+      case FileStatusPhase.PROCESSING:
+      case FileStatusPhase.UPLOADING:
+          return "primary"
+      case FileStatusPhase.FAILED:
+        return "danger"
+      case FileStatusPhase.SUCCESS:
+        return "success"
+    }
+  }
+
+  dismiss(status: FileStatus) {
+    this.consumerStatusService.dismiss(status)
+  }
+
+  dismissCompleted() {
+    this.consumerStatusService.dismissCompleted()
+  }
 
   ngOnInit(): void {
   }
@@ -28,54 +105,39 @@ export class UploadFileWidgetComponent implements OnInit {
   public fileLeave(event){
   }
 
-  uploadStatus: UploadStatus[] = []
-  completedFiles = 0
-
-  uploadVisible = false
-
-  get loadedSum() {
-    return this.uploadStatus.map(s => s.loaded).reduce((a,b) => a+b, this.completedFiles > 0 ? 1 : 0)
-  }
-
-  get totalSum() {
-    return this.uploadStatus.map(s => s.total).reduce((a,b) => a+b, 1)
-  }
-
   public dropped(files: NgxFileDropEntry[]) {
     for (const droppedFile of files) {
       if (droppedFile.fileEntry.isFile) {
-      let uploadStatusObject: UploadStatus = {loaded: 0, total: 1}
-      this.uploadStatus.push(uploadStatusObject)
-      this.uploadVisible = true
 
       const fileEntry = droppedFile.fileEntry as FileSystemFileEntry;
         fileEntry.file((file: File) => {
           let formData = new FormData()
           formData.append('document', file, file.name)
+          let status = this.consumerStatusService.newFileUpload(file.name)
+
+          status.message = $localize`Connecting...`
 
           this.documentService.uploadDocument(formData).subscribe(event => {
             if (event.type == HttpEventType.UploadProgress) {
-              uploadStatusObject.loaded = event.loaded
-              uploadStatusObject.total = event.total
+              status.updateProgress(FileStatusPhase.UPLOADING, event.loaded, event.total)
+              status.message = $localize`Uploading...`
             } else if (event.type == HttpEventType.Response) {
-              this.uploadStatus.splice(this.uploadStatus.indexOf(uploadStatusObject), 1)
-              this.completedFiles += 1
-              this.toastService.showInfo($localize`The document has been uploaded and will be processed by the consumer shortly.`)
+              status.taskId = event.body["task_id"]
+              status.message = $localize`Upload complete, waiting...`
             }
-            
+
           }, error => {
-            this.uploadStatus.splice(this.uploadStatus.indexOf(uploadStatusObject), 1)
-            this.completedFiles += 1
             switch (error.status) {
               case 400: {
-                this.toastService.showInfo($localize`There was an error while uploading the document: ${error.error.document}`)
+                this.consumerStatusService.fail(status, error.error.document)
                 break;
               }
               default: {
-                this.toastService.showInfo($localize`An error has occurred while uploading the document. Sorry!`)
+                this.consumerStatusService.fail(status, $localize`HTTP error: ${error.status} ${error.statusText}`)
                 break;
               }
             }
+
           })
         });
       }

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

@@ -13,4 +13,4 @@
     <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>
+</app-widget-frame>