Merge branch 'main' into dev

.github/release-drafter.yml

@@ -28,9 +28,10 @@ include-labels:
 replacers: # Changes "Feature: Update checker" to "Update checker"
   - search: '/Feature:|Feat:|\[feature\]/gi'
     replace: ''
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+category-template: '### $TITLE'
+change-template: '- $TITLE [@$AUTHOR](https://github.com/$AUTHOR) ([#$NUMBER]($URL))'
 change-title-escapes: '\<*_&#@'
 template: |
-  # Changelog
+  ## paperless-ngx $RESOLVED_VERSION
 
   $CHANGES

.github/workflows/ci.yml

@@ -334,3 +334,21 @@ jobs:
           asset_path: ./paperless-ngx.tar.xz
           asset_name: paperless-ngx-${{ steps.get_version.outputs.version }}.tar.xz
           asset_content_type: application/x-xz
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: main
+      -
+        name: Append Changelog to docs
+        id: append-Changelog
+        working-directory: docs
+        run: |
+          echo -e "# Changelog\n\n${{ steps.create-release.outputs.body }}\n" > changelog-new.md
+          CURRENT_CHANGELOG=`tail --lines +2 changelog.md`
+          echo -e "$CURRENT_CHANGELOG" >> changelog-new.md
+          mv changelog-new.md changelog.md
+          git config --global user.name "github-actions"
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git commit -am "Changelog ${{ steps.get_version.outputs.version }} - GHA"
+          git push origin HEAD:main

Pipfile

@@ -69,3 +69,4 @@ sphinx_rtd_theme = "*"
 tox = "*"
 black = "*"
 pre-commit = "*"
+myst-parser = "*"

Pipfile.lock

@@ -1,7 +1,7 @@
 {
     "_meta": {
         "hash": {
-            "sha256": "9573af313c811561d467d814c52c6bd1439bc48e3b31d7f56afed5f0ebe4b648"
+            "sha256": "edaf53125fd5a0dc3aff5b75e188523ef3b7bc29bda792ee78ee67506e0b831d"
         },
         "pipfile-spec": 6,
         "requires": {},
@@ -99,7 +99,6 @@
                 "sha256:f04e857b59d9d1ccc39ce2da1021d196e47234873820cbeaad210724b1ee28ac",
                 "sha256:fadbfe37f74051d024037f223b8e001611eac868b5c5b06144ef4d8b799862f2"
             ],
-            "index": "pypi",
             "markers": "python_version < '3.9'",
             "version": "==0.2.1"
         },
@@ -1589,7 +1588,9 @@
             "version": "==8.1.3"
         },
         "coverage": {
-            "extras": [],
+            "extras": [
+                "toml"
+            ],
             "hashes": [
                 "sha256:06f54765cdbce99901871d50fe9f41d58213f18e98b170a30ca34f47de7dd5e8",
                 "sha256:114944e6061b68a801c5da5427b9173a0dd9d32cd5fcc18a13de90352843737d",
@@ -1744,6 +1745,14 @@
             "markers": "python_version >= '3.7'",
             "version": "==3.1.2"
         },
+        "markdown-it-py": {
+            "hashes": [
+                "sha256:93de681e5c021a432c63147656fe21790bc01231e0cd2da73626f1aa3ac0fe27",
+                "sha256:cf7e59fed14b5ae17c0006eff14a2d9a00ed5f3a846148153899a0224e2c07da"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==2.1.0"
+        },
         "markupsafe": {
             "hashes": [
                 "sha256:0212a68688482dc52b2d45013df70d169f542b7394fc744c02a57374a4207003",
@@ -1790,6 +1799,22 @@
             "markers": "python_version >= '3.7'",
             "version": "==2.1.1"
         },
+        "mdit-py-plugins": {
+            "hashes": [
+                "sha256:b1279701cee2dbf50e188d3da5f51fee8d78d038cdf99be57c6b9d1aa93b4073",
+                "sha256:ecc24f51eeec6ab7eecc2f9724e8272c2fb191c2e93cf98109120c2cace69750"
+            ],
+            "markers": "python_version ~= '3.6'",
+            "version": "==0.3.0"
+        },
+        "mdurl": {
+            "hashes": [
+                "sha256:6a8f6804087b7128040b2fb2ebe242bdc2affaeaa034d5fc9feeed30b443651b",
+                "sha256:f79c9709944df218a4cdb0fcc0b0c7ead2f44594e3e84dc566606f04ad749c20"
+            ],
+            "markers": "python_version >= '3.7'",
+            "version": "==0.1.1"
+        },
         "mypy-extensions": {
             "hashes": [
                 "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d",
@@ -1797,6 +1822,14 @@
             ],
             "version": "==0.4.3"
         },
+        "myst-parser": {
+            "hashes": [
+                "sha256:1635ce3c18965a528d6de980f989ff64d6a1effb482e1f611b1bfb79e38f3d98",
+                "sha256:4c076d649e066f9f5c7c661bae2658be1ca06e76b002bb97f02a09398707686c"
+            ],
+            "index": "pypi",
+            "version": "==0.17.2"
+        },
         "nodeenv": {
             "hashes": [
                 "sha256:3ef13ff90291ba2a4a7a4ff9a979b63ffdd00a464dbe04acf0ea6471517a4c2b",

README.md

@@ -102,7 +102,7 @@ For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/i
 
 Paperless has been around a while now, and people are starting to build stuff on top of it. If you're one of those people, we can add your project to this list:
 
-- [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless-ngx. Also works with the original Paperless and Paperless-ngx.
+- [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless-ngx. Also works with the original Paperless and Paperless-ng.
 - [Paperless Share](https://github.com/qcasey/paperless_share). Share any files from your Android application with paperless. Very simple, but works with all of the mobile scanning apps out there that allow you to share scanned documents.
 - [Scan to Paperless](https://github.com/sbrunner/scan-to-paperless): Scan and prepare (crop, deskew, OCR, ...) your documents for Paperless.
 

docs/_static/css/custom.css

@@ -64,6 +64,10 @@ body {
   color: var(--color-text-body);
 }
 
+.rst-content p {
+  word-break: break-word;
+}
+
 h1, h2, h3, h4, h5, h6 {
   font-family: inherit;
 }

docs/administration.rst

@@ -118,10 +118,10 @@ Then you can start paperless-ngx with ``-d`` to have it run in the background.
                 image: ghcr.io/paperless-ngx/paperless-ngx:latest
 
     .. note::
-        In version 1.7.1 and onwards, the Docker image can now pinned to a release series.
+        In version 1.7.1 and onwards, the Docker image can now be pinned to a release series.
         This is often combined with automatic updaters such as Watchtower to allow safer
         unattended upgrading to new bugfix releases only.  It is still recommended to always
-        review release notes before upgrading.  To ping your install to a release series, edit
+        review release notes before upgrading.  To pin your install to a release series, edit
         the ``docker-compose.yml`` find the line that says
 
             .. code::
@@ -390,8 +390,8 @@ the naming scheme.
 
 .. warning::
 
-    Since this command moves you documents around a lot, it is advised to to
+    Since this command moves your documents, it is advised to do
-    a backup before. The renaming logic is robust and will never overwrite
+    a backup beforehand. The renaming logic is robust and will never overwrite
     or delete a file, but you can't ever be careful enough.
 
 .. code::

docs/conf.py

@@ -14,13 +14,17 @@ extensions = [
     "sphinx.ext.imgmath",
     "sphinx.ext.viewcode",
     "sphinx_rtd_theme",
+    "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = ".rst"
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'

docs/index.rst

@@ -52,7 +52,7 @@ resources in the documentation:
 *   Paperless is now integrated with a
     :ref:`task processing queue <setup-task_processor>` that tells you
     at a glance when and why something is not working.
-*   The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes
+*   The :doc:`changelog </changelog>` contains a detailed list of all changes
     in paperless-ngx.
 
 Contents

docs/requirements.txt

@@ -0,0 +1 @@
+myst-parser==0.17.2

docs/scanners.rst

@@ -13,43 +13,45 @@ that works right for you based on recommendations from other Paperless users.
 Physical scanners
 =================
 
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brand   | Model             | Supports                                      | Recommended By |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 |         |                   | FTP | SFTP | NFS | SMB      | SMTP | API [1]_ |                |
-+=========+================+=====+======+=====+=====+======+==========+================+
++=========+===================+=====+======+=====+==========+======+==========+================+
 | Brother | `ADS-1700W`_      | yes |      |     | yes      | yes  |          |`holzhannes`_   |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `ADS-1600W`_      | yes |      |     | yes      | yes  |          |`holzhannes`_   |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `ADS-1500W`_      | yes |      |     | yes      | yes  |          |`danielquinn`_  |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `ADS-1100W`_      | yes |      |     |          |      |          |`ytzelf`_       |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `ADS-2800W`_      | yes | yes  |     | yes      | yes  |          |`philpagel`_    |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `MFC-J6930DW`_    | yes |      |     |          |      |          |`ayounggun`_    |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `MFC-L5850DW`_    | yes |      |     |          | yes  |          |`holzhannes`_   |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `MFC-L2750DW`_    | yes |      |     | yes      | yes  |          |`muued`_        |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `MFC-J5910DW`_    | yes |      |     |          |      |          |`bmsleight`_    |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `MFC-8950DW`_     | yes |      |     | yes      | yes  |          |`philpagel`_    |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Brother | `MFC-9142CDN`_    | yes |      |     | yes      |      |          |`REOLDEV`_      |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
+| Canon   | `Maxify MB 5350`_ |     |      |     | yes [2]_ | yes  |          |`eingemaischt`_ |
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Fujitsu | `ix500`_          | yes |      |     | yes      |      |          |`eonist`_       |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Epson   | `ES-580W`_        | yes |      |     | yes      | yes  |          |`fignew`_       |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Epson   | `WF-7710DWF`_     | yes |      |     | yes      |      |          |`Skylinar`_     |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Fujitsu | `S1300i`_         | yes |      |     | yes      |      |          |`jonaswinkler`_ |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 | Doxie   | `Q2`_             |     |      |     |          |      | yes      |`Unkn0wnCat`_   |
-+---------+----------------+-----+------+-----+-----+------+----------+----------------+
++---------+-------------------+-----+------+-----+----------+------+----------+----------------+
 
 .. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw
 .. _MFC-L2750DW: https://www.brother.de/drucker/laserdrucker/mfc-l2750dw
@@ -58,6 +60,7 @@ Physical scanners
 .. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
 .. _ADS-1100W: https://support.brother.com/g/b/downloadtop.aspx?c=fr&lang=fr&prod=ads1100w_eu_as_cn
 .. _ADS-2800W: https://www.brother-usa.com/products/ads2800w
+.. _Maxify MB 5350: https://www.canon.de/printers/inkjet/maxify/maxify_mb5350/specification.html
 .. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
 .. _MFC-J5910DW: https://www.brother.co.uk/printers/inkjet-printers/mfcj5910dw
 .. _MFC-8950DW: https://www.brother-usa.com/products/mfc8950dw
@@ -81,8 +84,11 @@ Physical scanners
 .. _Unkn0wnCat: https://github.com/Unkn0wnCat
 .. _muued: https://github.com/muued
 .. _philpagel: https://github.com/philpagel
+.. _eingemaischt: https://github.com/eingemaischt
 
 .. [1] Scanners with API Integration allow to push scanned documents directly to :ref:`Paperless API <api-file_uploads>`, sometimes referred to as Webhook or Document POST.
+.. [2] Canon Multi Function Printers show strange behavior over SMB. They close and reopen the file after every page. It's recommended to tune the
+       :ref:`polling <configuration-polling>` configuration values for your scanner. The scanner timeout is 3 minutes, so ``180`` is a good starting point.
 
 Mobile phone software
 =====================
@@ -105,6 +111,9 @@ You can use your phone to "scan" documents. The regular camera app will work, bu
 
 On Android, you can use these applications in combination with one of the :ref:`Paperless-ngx 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.
 
+There is also an iOS Shortcut that allows you to directly upload text, PDF and image documents available here: https://www.icloud.com/shortcuts/d234abc0885040129d9d75fa45fe1154
+Please note this only works for documents downloaded to iCloud / the device, in other words not directly from a URL.
+
 .. _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
 .. _OCR Scanner - QuickScan: https://apps.apple.com/us/app/quickscan-scanner-text-ocr/id1513790291

docs/setup.rst

@@ -519,7 +519,7 @@ 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.
+* Read the :doc:`changelog </changelog>` and take note of breaking changes.
 * You should decide if you want to stick with SQLite or want to migrate your database
   to PostgreSQL. See :ref:`setup-sqlite_to_psql` for details on how to move your data from
   SQLite to PostgreSQL. Both work fine with paperless. However, if you already have a