diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 16538820d..029eae464 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: @@ -15,9 +26,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' @@ -25,11 +42,12 @@ include-labels: - 'deployment' - 'translation' - 'dependencies' -replacers: # Changes "Feature: Update checker" to "Update checker" - - search: '/Feature:|Feat:|\[feature\]/gi' - replace: '' + - 'documentation' + - 'frontend' + - 'backend' + - 'ci-cd' 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 bdb98741d..ddf23e253 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -452,7 +452,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 }} @@ -492,6 +492,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 diff --git a/.github/workflows/project-actions.yml b/.github/workflows/project-actions.yml index d52f6d06a..0ec168a7a 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 @@ -24,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.3.0 with: gh_token: ${{ secrets.GH_TOKEN }} @@ -35,13 +38,20 @@ jobs: pr_opened_or_reopened: name: pr_opened_or_reopened runs-on: ubuntu-latest - if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') + 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' 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.3.0 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: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 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 5b71bad99..99c037ec8 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -27,6 +27,12 @@ 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. PAPERLESS_DBENGINE= @@ -215,9 +221,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. @@ -805,10 +818,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: diff --git a/docs/scanners.rst b/docs/scanners.rst index 1100516a9..68b0b335f 100644 --- a/docs/scanners.rst +++ b/docs/scanners.rst @@ -1,142 +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 | `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 -.. _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 -.. _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/ - -.. _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 - -.. [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 | | -+=============================+================+=====+=====+=====+=======+========+==================+ -| `Office Lens`_ | Android | ? | ? | ? | ? | ? | `jonaswinkler`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `Genius Scan`_ | Android | yes | no | yes | yes | yes | `hannahswain`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `OpenScan`_ | Android | no | no | no | no | no | `benjaminfrank`_ | -+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ -| `OCR Scanner - 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. - -.. _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 -.. _OpenScan: https://github.com/Ethereal-Developers-Inc/OpenScan - -.. _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 `_. diff --git a/docs/setup.rst b/docs/setup.rst index 9312e70d4..ca07c1032 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