From 94b09614d92e20f88984c92da9fdbc367900c997 Mon Sep 17 00:00:00 2001 From: tooomm Date: Wed, 3 Aug 2022 15:00:23 +0200 Subject: [PATCH 01/18] typo --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 715fef588..735804560 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,7 +44,7 @@ resources in the documentation: learn about how paperless automates all tagging using machine learning. * Paperless now comes with a :ref:`proper email consumer ` that's fully tested and production ready. -* Paperless creates searchable PDF/A documents from whatever you you put into +* Paperless creates searchable PDF/A documents from whatever you put into the consumption directory. This means that you can select text in image-only documents coming from your scanner. * See :ref:`this note ` about GnuPG encryption in From a0617c1fad2bc32e5b84f0cdd1d474d8f26851c9 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Wed, 10 Aug 2022 17:19:13 -0700 Subject: [PATCH 02/18] CI: Add autolabeler --- .github/release-drafter.yml | 11 +++++++++++ .github/workflows/project-actions.yml | 10 ++++++++++ 2 files changed, 21 insertions(+) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 16538820d..a1b653554 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,3 +1,14 @@ +autolabeler: + - label: "bug" + branch: + - '/^fix/' + title: + - "/^fix/i" + - label: "enhancement" + branch: + - '/^feature/' + title: + - "/^feature/i" categories: - title: 'Breaking Changes' labels: diff --git a/.github/workflows/project-actions.yml b/.github/workflows/project-actions.yml index adfbc6d40..e8595edf1 100644 --- a/.github/workflows/project-actions.yml +++ b/.github/workflows/project-actions.yml @@ -13,6 +13,9 @@ on: - main - dev +permissions: + contents: read + env: todo: Todo done: Done @@ -35,6 +38,9 @@ jobs: pr_opened_or_reopened: name: pr_opened_or_reopened runs-on: ubuntu-latest + permissions: + # write permission is required for autolabeler + pull-requests: write if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') steps: - name: Set PR status to ${{ env.in_progress }} @@ -45,3 +51,7 @@ jobs: project_id: 2 resource_node_id: ${{ github.event.pull_request.node_id }} status_value: ${{ env.in_progress }} # Target status + - name: Label PR with release-drafter + uses: release-drafter/release-drafter@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 5dd4d0c37002292ed20d51e8a361c1cbe3ce25a3 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Fri, 29 Jul 2022 09:16:31 -0700 Subject: [PATCH 03/18] Add documentation as included label --- .github/release-drafter.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 16538820d..29f8c55bd 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -25,6 +25,7 @@ include-labels: - 'deployment' - 'translation' - 'dependencies' + - 'documentation' replacers: # Changes "Feature: Update checker" to "Update checker" - search: '/Feature:|Feat:|\[feature\]/gi' replace: '' From 8d3361766dd96214e053c25780755068f77d056e Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Wed, 10 Aug 2022 17:45:01 -0700 Subject: [PATCH 04/18] Draft more comprehensive changelog --- .github/release-drafter.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 29f8c55bd..f16f71d55 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -15,9 +15,15 @@ categories: - 'chore' - 'deployment' - 'translation' + - 'ci-cd' - title: 'Dependencies' collapse-after: 3 label: 'dependencies' + - title: 'All App Changes' + labels: + - 'frontend' + - 'backend' + collapse-after: 0 include-labels: - 'enhancement' - 'bug' @@ -26,8 +32,11 @@ include-labels: - 'translation' - 'dependencies' - 'documentation' + - 'frontend' + - 'backend' + - 'ci-cd' replacers: # Changes "Feature: Update checker" to "Update checker" - - search: '/Feature:|Feat:|\[feature\]/gi' + - search: '/Feature:?|Feat:?|\[feature\]/gi' replace: '' category-template: '### $TITLE' change-template: '- $TITLE [@$AUTHOR](https://github.com/$AUTHOR) ([#$NUMBER]($URL))' From 18a2a41682274d870c9a935feb4b8a20381e29f2 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Thu, 11 Aug 2022 09:49:04 -0700 Subject: [PATCH 05/18] Use fork of release-drafter to exclude prereleases --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d6db6e6d1..d7f57cde5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -332,7 +332,7 @@ jobs: - name: Create Release and Changelog id: create-release - uses: release-drafter/release-drafter@v5 + uses: paperless-ngx/release-drafter@master with: name: Paperless-ngx ${{ steps.get_version.outputs.version }} tag: ${{ steps.get_version.outputs.version }} From 40ae184c4eb1b764bf393091e668fe70f12ad201 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Thu, 11 Aug 2022 10:03:37 -0700 Subject: [PATCH 06/18] Exclude dependabot PRs from project --- .github/workflows/project-actions.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/project-actions.yml b/.github/workflows/project-actions.yml index e8595edf1..e6826f7b7 100644 --- a/.github/workflows/project-actions.yml +++ b/.github/workflows/project-actions.yml @@ -41,7 +41,7 @@ jobs: permissions: # write permission is required for autolabeler pull-requests: write - if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') + if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') && github.event.pull_request.user.login != "dependabot" steps: - name: Set PR status to ${{ env.in_progress }} uses: leonsteinhaeuser/project-beta-automations@v1.2.1 From 22fb659b72f95799606282e1c6bc5de81ae4062b Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Thu, 11 Aug 2022 10:10:08 -0700 Subject: [PATCH 07/18] Set status of new PRs to "Needs Review" --- .github/workflows/project-actions.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/project-actions.yml b/.github/workflows/project-actions.yml index e6826f7b7..91f8f27db 100644 --- a/.github/workflows/project-actions.yml +++ b/.github/workflows/project-actions.yml @@ -27,7 +27,7 @@ jobs: runs-on: ubuntu-latest if: github.event_name == 'issues' && (github.event.action == 'opened' || github.event.action == 'reopened') steps: - - name: Set issue status to ${{ env.todo }} + - name: Add issue to project and set status to ${{ env.todo }} uses: leonsteinhaeuser/project-beta-automations@v1.2.1 with: gh_token: ${{ secrets.GH_TOKEN }} @@ -43,14 +43,14 @@ jobs: pull-requests: write if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') && github.event.pull_request.user.login != "dependabot" steps: - - name: Set PR status to ${{ env.in_progress }} + - name: Add PR to project and set status to "Needs Review" uses: leonsteinhaeuser/project-beta-automations@v1.2.1 with: gh_token: ${{ secrets.GH_TOKEN }} organization: paperless-ngx project_id: 2 resource_node_id: ${{ github.event.pull_request.node_id }} - status_value: ${{ env.in_progress }} # Target status + status_value: "Needs Review" # Target status - name: Label PR with release-drafter uses: release-drafter/release-drafter@v5 env: From a8c575147b8f81c558b4bce1ebceab9b2d90dc1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lucas=20Ple=C3=9F?= Date: Sat, 13 Aug 2022 22:52:17 +0200 Subject: [PATCH 08/18] Update scanners.rst added Brother ADS-4300N. I tested it and can recommend the Device. It scans fast and reliable. --- docs/scanners.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/scanners.rst b/docs/scanners.rst index 1100516a9..f38a3164f 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -28,6 +28,8 @@ Physical scanners +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Brother | `ADS-2800W`_ | yes | yes | | yes | yes | |`philpagel`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ +| Brother | `ADS-4300N`_ | yes | yes | | yes | yes | |`derlucas`_ | ++---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Brother | `MFC-J6930DW`_ | yes | | | | | |`ayounggun`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Brother | `MFC-L5850DW`_ | yes | | | | yes | |`holzhannes`_ | @@ -60,6 +62,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 +.. _ADS-4300N: https://www.brother-usa.com/products/ads4300n .. _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 @@ -85,6 +88,7 @@ Physical scanners .. _muued: https://github.com/muued .. _philpagel: https://github.com/philpagel .. _eingemaischt: https://github.com/eingemaischt +.. _derlucas: https://github.com/derlucas .. [1] Scanners with API Integration allow to push scanned documents directly to :ref:`Paperless API `, 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 From 02456b271bdc65f639b223211a7529535d9326ff Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Mon, 15 Aug 2022 06:27:08 -0700 Subject: [PATCH 09/18] Fix incorrect double quote on string --- .github/workflows/project-actions.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/project-actions.yml b/.github/workflows/project-actions.yml index 91f8f27db..4366f8aa1 100644 --- a/.github/workflows/project-actions.yml +++ b/.github/workflows/project-actions.yml @@ -41,7 +41,7 @@ jobs: permissions: # write permission is required for autolabeler pull-requests: write - if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') && github.event.pull_request.user.login != "dependabot" + if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') && github.event.pull_request.user.login != 'dependabot' steps: - name: Add PR to project and set status to "Needs Review" uses: leonsteinhaeuser/project-beta-automations@v1.2.1 From f2cab81aed261ea18ed50fdc73acedd11bd46db2 Mon Sep 17 00:00:00 2001 From: glassbox-sco <57235495+glassbox-sco@users.noreply.github.com> Date: Wed, 17 Aug 2022 00:09:21 +0100 Subject: [PATCH 10/18] Update scanners.rst --- docs/scanners.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/scanners.rst b/docs/scanners.rst index f38a3164f..b89ff6685 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -54,6 +54,8 @@ Physical scanners +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Doxie | `Q2`_ | | | | | | yes |`Unkn0wnCat`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ +| HP | `MFP M277 dw ` | yes | | | yes | | yes |`glassbox_sco` | ++---------+-------------------+-----+------+-----+----------+------+----------+----------------+ .. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw .. _MFC-L2750DW: https://www.brother.de/drucker/laserdrucker/mfc-l2750dw @@ -73,6 +75,7 @@ Physical scanners .. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/ .. _S1300i: https://www.fujitsu.com/global/products/computing/peripheral/scanners/soho/s1300i/ .. _Q2: https://www.getdoxie.com/product/doxie-q/ +.. MFP M277 dw https://support.hp.com/us-en/drivers/selfservice/hp-color-laserjet-mfp-m277-series/7089945/model/7089949 .. _ayounggun: https://github.com/ayounggun .. _bmsleight: https://github.com/bmsleight From 1ec73518426975adfa50a82082d8ebbb6f09c732 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 16 Aug 2022 19:44:48 -0700 Subject: [PATCH 11/18] Minor doc fixes --- docs/scanners.rst | 5 +++-- docs/setup.rst | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/scanners.rst b/docs/scanners.rst index b89ff6685..3e0210cce 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -54,7 +54,7 @@ Physical scanners +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Doxie | `Q2`_ | | | | | | yes |`Unkn0wnCat`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ -| HP | `MFP M277 dw ` | yes | | | yes | | yes |`glassbox_sco` | +| HP | `MFP M277 dw`_ | yes | | | yes | | yes |`glassbox_sco`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ .. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw @@ -75,7 +75,7 @@ Physical scanners .. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/ .. _S1300i: https://www.fujitsu.com/global/products/computing/peripheral/scanners/soho/s1300i/ .. _Q2: https://www.getdoxie.com/product/doxie-q/ -.. MFP M277 dw https://support.hp.com/us-en/drivers/selfservice/hp-color-laserjet-mfp-m277-series/7089945/model/7089949 +.. _MFP M277 dw: https://support.hp.com/us-en/drivers/selfservice/hp-color-laserjet-mfp-m277-series/7089945/model/7089949 .. _ayounggun: https://github.com/ayounggun .. _bmsleight: https://github.com/bmsleight @@ -92,6 +92,7 @@ Physical scanners .. _philpagel: https://github.com/philpagel .. _eingemaischt: https://github.com/eingemaischt .. _derlucas: https://github.com/derlucas +.. _glassbox_sco: https://github.com/glassbox_sco .. [1] Scanners with API Integration allow to push scanned documents directly to :ref:`Paperless API `, 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 diff --git a/docs/setup.rst b/docs/setup.rst index 3aea55467..decb1ed65 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -224,6 +224,7 @@ Install Paperless from Docker Hub You can utilize Docker secrets for some configuration settings by appending `_FILE` to some configuration values. This is supported currently only by: + * PAPERLESS_DBUSER * PAPERLESS_DBPASS * PAPERLESS_SECRET_KEY From a4c4b81297445365602f2c460b617dffa3a63f2b Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Wed, 17 Aug 2022 08:30:40 -0700 Subject: [PATCH 12/18] Manually link authors only in docs/changelog.md --- .github/release-drafter.yml | 5 +---- .github/workflows/ci.yml | 2 ++ 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index f16f71d55..a23fc7165 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -35,11 +35,8 @@ include-labels: - 'frontend' - 'backend' - 'ci-cd' -replacers: # Changes "Feature: Update checker" to "Update checker" - - search: '/Feature:?|Feat:?|\[feature\]/gi' - replace: '' category-template: '### $TITLE' -change-template: '- $TITLE [@$AUTHOR](https://github.com/$AUTHOR) ([#$NUMBER]($URL))' +change-template: '- $TITLE @$AUTHOR ([#$NUMBER]($URL))' change-title-escapes: '\<*_&#@' template: | ## paperless-ngx $RESOLVED_VERSION diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d7f57cde5..cf86d0c82 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -372,6 +372,8 @@ jobs: git branch ${{ needs.publish-release.outputs.version }}-changelog git checkout ${{ needs.publish-release.outputs.version }}-changelog echo -e "# Changelog\n\n${{ needs.publish-release.outputs.changelog }}\n" > changelog-new.md + echo "Manually linking usernames" + sed -i -r 's|@(.+?) \(\[#|[@\1](https://github.com/\1) ([#|ig' changelog-new.md CURRENT_CHANGELOG=`tail --lines +2 changelog.md` echo -e "$CURRENT_CHANGELOG" >> changelog-new.md mv changelog-new.md changelog.md From a56de4547cb90b1c72f22997f1b828111cb8e52f Mon Sep 17 00:00:00 2001 From: Zerteax <111658582+Zerteax@users.noreply.github.com> Date: Sun, 21 Aug 2022 16:27:45 +0200 Subject: [PATCH 13/18] Changes to Redis documentation (#1441) * Added more description in PAPERLESS_REDIS * More Information on Redis * Update configuration.rst * Changed to Same as in the Documentation of Redis * Edited the link Linking directly to the Securing Redis part --- docs/configuration.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/configuration.rst b/docs/configuration.rst index fd68f61cb..94c7c2e64 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -26,6 +26,12 @@ Required services PAPERLESS_REDIS= This is required for processing scheduled tasks such as email fetching, index optimization and for training the automatic document matcher. + + * If your Redis server needs login credentials PAPERLESS_REDIS = ``redis://:@:`` + + * With the requirepass option PAPERLESS_REDIS = ``redis://:@:`` + + `More information on securing your Redis Instance `_. Defaults to redis://localhost:6379. From 66593a28f50f26c3208a2ebacdaf07d7578f4d4f Mon Sep 17 00:00:00 2001 From: Mark Stenglein Date: Tue, 23 Aug 2022 19:58:06 -0400 Subject: [PATCH 14/18] docs: scanners: add Brother ads4700w I've tested Paperless with the ADS-4700W and it works great. This commit adds the recommendation. --- docs/scanners.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/scanners.rst b/docs/scanners.rst index 3e0210cce..8b63614f9 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -30,6 +30,8 @@ Physical scanners +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Brother | `ADS-4300N`_ | yes | yes | | yes | yes | |`derlucas`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ +| Brother | `ADS-4700W`_ | yes | yes | | yes | yes | |`ocelotsloth`_ | ++---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Brother | `MFC-J6930DW`_ | yes | | | | | |`ayounggun`_ | +---------+-------------------+-----+------+-----+----------+------+----------+----------------+ | Brother | `MFC-L5850DW`_ | yes | | | | yes | |`holzhannes`_ | @@ -65,6 +67,7 @@ Physical scanners .. _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 .. _ADS-4300N: https://www.brother-usa.com/products/ads4300n +.. _ADS-4700W: https://www.brother-usa.com/products/ads4700w .. _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 @@ -93,6 +96,7 @@ Physical scanners .. _eingemaischt: https://github.com/eingemaischt .. _derlucas: https://github.com/derlucas .. _glassbox_sco: https://github.com/glassbox_sco +.. _ocelotsloth: https://github.com/ocelotsloth .. [1] Scanners with API Integration allow to push scanned documents directly to :ref:`Paperless API `, 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 From 9c2265d1aa9a68bfcf3e6e38e8721a4b80d4e97a Mon Sep 17 00:00:00 2001 From: tooomm Date: Sat, 27 Aug 2022 18:03:54 +0200 Subject: [PATCH 15/18] update mobile scanner section --- docs/scanners.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/scanners.rst b/docs/scanners.rst index 8b63614f9..a764a2a84 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -112,24 +112,24 @@ You can use your phone to "scan" documents. The regular camera app will work, bu +-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ | | | FTP | NFS | SMB | Email | WebDAV | | +=============================+================+=====+=====+=====+=======+========+==================+ -| `Office Lens`_ | Android | ? | ? | ? | ? | ? | `jonaswinkler`_ | +| `Microsoft Lens`_ | Android, iOS | ? | ? | ? | ? | ? | `jonaswinkler`_ | +-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `Genius Scan`_ | Android | yes | no | yes | yes | yes | `hannahswain`_ | +| `Genius Scan`_ | Android, iOS | yes | no | yes | yes | yes | `hannahswain`_ | +-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ | `OpenScan`_ | Android | no | no | no | no | no | `benjaminfrank`_ | +-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `OCR Scanner - QuickScan`_ | iOS | no | no | no | no | yes | `holzhannes`_ | +| `QuickScan`_ | iOS | no | no | no | no | yes | `holzhannes`_ | +-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -On Android, you can use these applications in combination with one of the :ref:`Paperless-ngx compatible apps ` 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. +On **Android**, you can use these applications in combination with one of the :ref:`Paperless-ngx compatible apps ` 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 +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 +.. _Microsoft Lens: https://play.google.com/store/apps/details?id=com.microsoft.office.officelens +.. _Genius Scan: https://www.thegrizzlylabs.com/genius-scan .. _OpenScan: https://github.com/Ethereal-Developers-Inc/OpenScan +.. _QuickScan: https://apps.apple.com/us/app/quickscan-scanner-text-ocr/id1513790291 .. _hannahswain: https://github.com/hannahswain .. _benjaminfrank: https://github.com/benjaminfrank From ebdd7afb678c909e085c077492675c81778ee55c Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 30 Aug 2022 22:04:13 -0700 Subject: [PATCH 16/18] Move scanner & software recs to GH wiki --- docs/scanners.rst | 154 ++-------------------------------------------- 1 file changed, 4 insertions(+), 150 deletions(-) diff --git a/docs/scanners.rst b/docs/scanners.rst index a764a2a84..68b0b335f 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -1,154 +1,8 @@ .. _scanners: -*********************** -Scanner recommendations -*********************** +******************* +Scanners & Software +******************* -As Paperless operates by watching a folder for new files, doesn't care what -scanner you use, but sometimes finding a scanner that will write to an FTP, -NFS, or SMB server can be difficult. This page is here to help you find one -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 | 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 | `ADS-4300N`_ | yes | yes | | yes | yes | |`derlucas`_ | -+---------+-------------------+-----+------+-----+----------+------+----------+----------------+ -| Brother | `ADS-4700W`_ | yes | yes | | yes | yes | |`ocelotsloth`_ | -+---------+-------------------+-----+------+-----+----------+------+----------+----------------+ -| 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`_ | -+---------+-------------------+-----+------+-----+----------+------+----------+----------------+ -| HP | `MFP M277 dw`_ | yes | | | yes | | yes |`glassbox_sco`_ | -+---------+-------------------+-----+------+-----+----------+------+----------+----------------+ - -.. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw -.. _MFC-L2750DW: https://www.brother.de/drucker/laserdrucker/mfc-l2750dw -.. _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 -.. _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 -.. _ADS-4300N: https://www.brother-usa.com/products/ads4300n -.. _ADS-4700W: https://www.brother-usa.com/products/ads4700w -.. _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 -.. _MFC-9142CDN: https://www.brother.co.uk/printers/laser-printers/mfc9140cdn -.. _ES-580W: https://epson.com/Support/Scanners/ES-Series/Epson-WorkForce-ES-580W/s/SPT_B11B258201 -.. _WF-7710DWF: https://www.epson.de/en/products/printers/inkjet-printers/for-home/workforce-wf-7710dwf -.. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/ -.. _S1300i: https://www.fujitsu.com/global/products/computing/peripheral/scanners/soho/s1300i/ -.. _Q2: https://www.getdoxie.com/product/doxie-q/ -.. _MFP M277 dw: https://support.hp.com/us-en/drivers/selfservice/hp-color-laserjet-mfp-m277-series/7089945/model/7089949 - -.. _ayounggun: https://github.com/ayounggun -.. _bmsleight: https://github.com/bmsleight -.. _danielquinn: https://github.com/danielquinn -.. _eonist: https://github.com/eonist -.. _fignew: https://github.com/fignew -.. _holzhannes: https://github.com/holzhannes -.. _jonaswinkler: https://github.com/jonaswinkler -.. _REOLDEV: https://github.com/REOLDEV -.. _Skylinar: https://github.com/Skylinar -.. _ytzelf: https://github.com/ytzelf -.. _Unkn0wnCat: https://github.com/Unkn0wnCat -.. _muued: https://github.com/muued -.. _philpagel: https://github.com/philpagel -.. _eingemaischt: https://github.com/eingemaischt -.. _derlucas: https://github.com/derlucas -.. _glassbox_sco: https://github.com/glassbox_sco -.. _ocelotsloth: https://github.com/ocelotsloth - -.. [1] Scanners with API Integration allow to push scanned documents directly to :ref:`Paperless API `, 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 ` and :ref:`inotify ` configuration values for your scanner. The scanner timeout is 3 minutes, so ``180`` is a good starting point. - -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 | | -+=============================+================+=====+=====+=====+=======+========+==================+ -| `Microsoft Lens`_ | Android, iOS | ? | ? | ? | ? | ? | `jonaswinkler`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `Genius Scan`_ | Android, iOS | yes | no | yes | yes | yes | `hannahswain`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `OpenScan`_ | Android | no | no | no | no | no | `benjaminfrank`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `QuickScan`_ | iOS | no | no | no | no | yes | `holzhannes`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ - -On **Android**, you can use these applications in combination with one of the :ref:`Paperless-ngx compatible apps ` 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. - -.. _Microsoft Lens: https://play.google.com/store/apps/details?id=com.microsoft.office.officelens -.. _Genius Scan: https://www.thegrizzlylabs.com/genius-scan -.. _OpenScan: https://github.com/Ethereal-Developers-Inc/OpenScan -.. _QuickScan: https://apps.apple.com/us/app/quickscan-scanner-text-ocr/id1513790291 - -.. _hannahswain: https://github.com/hannahswain -.. _benjaminfrank: https://github.com/benjaminfrank - -API Scanning Setup -================== - -This sections contains information on how to set up scanners to post directly to :ref:`Paperless API `. - -Doxie Q2 --------- - -This part assumes your Doxie is connected to WiFi and you know its IP. - -1. Open your Doxie web UI by navigating to its IP address -2. Navigate to Options -> Webhook -3. Set the *URL* to ``https://[your-paperless-ngx-instance]/api/documents/post_document/`` -4. Set the *File Parameter Name* to ``document`` -5. Add the username and password to the respective fields (Consider creating a user just for your Doxie) -6. Click *Submit* at the bottom of the page - -Congrats, you can now scan directly from your Doxie to your Paperless-ngx instance! +Paperless-ngx is compatible with many different scanners and scanning tools. A user-maintained list of scanners and other software is available on `the wiki `_. From 3828d712bd516cebeb5f6dc534f6c62240c6c2a9 Mon Sep 17 00:00:00 2001 From: viktor-c Date: Thu, 1 Sep 2022 01:36:13 +0200 Subject: [PATCH 17/18] Info about installing on subpath (#1350) * Update docker-compose.env * Update configuration.rst example.com/paperless is not a subdomain, but a subpath. Also when hosting from a subdomain like paperless.example.com one does not have to change anything in the configuration, it just works, because paperless expects to be hosted at root, i.e. paperless.example.com This however changes when paperless is not hosted at root anymore but for example at paperless.example.com/paperlessNgx * Update docker-compose.env * Apply suggestions from code review Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> --- docker/compose/docker-compose.env | 4 ++++ docs/configuration.rst | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/docker/compose/docker-compose.env b/docker/compose/docker-compose.env index 34e694b92..c4dbb4cce 100644 --- a/docker/compose/docker-compose.env +++ b/docker/compose/docker-compose.env @@ -36,3 +36,7 @@ # The default language to use for OCR. Set this to the language most of your # documents are written in. #PAPERLESS_OCR_LANGUAGE=eng + +# Set if accessing paperless via a domain subpath e.g. https://domain.com/PATHPREFIX and using a reverse-proxy like traefik or nginx +#PAPERLESS_FORCE_SCRIPT_NAME=/PATHPREFIX +#PAPERLESS_STATIC_URL=/PATHPREFIX/static/ # trailing slash required diff --git a/docs/configuration.rst b/docs/configuration.rst index 94c7c2e64..7eac9440f 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -215,9 +215,16 @@ PAPERLESS_FORCE_SCRIPT_NAME= PAPERLESS_STATIC_URL= Override the STATIC_URL here. Unless you're hosting Paperless off a subdomain like /paperless/, you probably don't need to change this. + If you do change it, be sure to include the trailing slash. Defaults to "/static/". + .. note:: + + When hosting paperless behind a reverse proxy like Traefik or Nginx at a subpath e.g. + example.com/paperlessngx you will also need to set ``PAPERLESS_FORCE_SCRIPT_NAME`` + (see above). + PAPERLESS_AUTO_LOGIN_USERNAME= Specify a username here so that paperless will automatically perform login with the selected user. From 03559454f62210783d3acbf828dd271d81c48b46 Mon Sep 17 00:00:00 2001 From: Erik Arvstedt Date: Sun, 4 Sep 2022 15:21:36 +0200 Subject: [PATCH 18/18] docs/configuration: Fix binary variable defaults --- docs/configuration.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 7eac9440f..4d0231933 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -799,10 +799,10 @@ the program doesn't automatically execute it (ie. the program isn't in your $PATH), then you'll need to specify the literal path for that program. PAPERLESS_CONVERT_BINARY= - Defaults to "/usr/bin/convert". + Defaults to "convert". PAPERLESS_GS_BINARY= - Defaults to "/usr/bin/gs". + Defaults to "gs". .. _configuration-docker: