From 3c8d7f2dee2a5a81720b2770122d99198d1f12a5 Mon Sep 17 00:00:00 2001 From: Stefan Date: Sat, 31 Dec 2022 00:33:18 +0100 Subject: [PATCH 01/15] Update bare metall install documentation Added some info to the baremetal installation and changed it up a bit for easier installation Co-Authored-By: shamoon <4887959+shamoon@users.noreply.github.com> --- docs/setup.md | 68 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 52 insertions(+), 16 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 8dcaeae8b..2923d06ce 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -64,8 +64,7 @@ steps described in [Docker setup](#docker_hub) automatically. 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` + version **1.17.0**. To check do: `docker-compose -v` or `docker -v` See the [Docker installation guide](https://docs.docker.com/engine/install/) on how to install the current version of Docker for your operating system or Linux distribution of @@ -314,14 +313,34 @@ supported. extension](https://code.djangoproject.com/wiki/JSON1Extension) is enabled. This is usually the case, but not always. -4. Get the release archive from - . Extract the - archive to a place from where you wish to execute it, such as - `/opt/paperless`. If you clone the git repo as it is, you also have to +4. Create a system user with a new home folder under which you wish + to run paperless. + + ```shell-session + adduser paperless --system --home /opt/paperless --group + ``` + +5. Get the release archive from + for example with + + ```shell-session + curl -O -L https://github.com/paperless-ngx/paperless-ngx/releases/download/v1.10.2/paperless-ngx-v1.10.2.tar.xz + ``` + + Extract the archive with + + ```shell-session + tar -xf paperless-ngx-v1.10.2.tar.xz + ``` + + and copy the contents to the + home folder of the user you created before (`/opt/paperless`). + + Optional: If you cloned the git repo, you will have to compile the frontend yourself, see [here](/development#front-end-development) and use the `build` step, not `serve`. -5. Configure paperless. See [configuration](/configuration) for details. +6. Configure paperless. See [configuration](/configuration) for details. Edit the included `paperless.conf` and adjust the settings to your needs. Required settings for getting paperless running are: @@ -354,20 +373,27 @@ supported. documents are written in. - Set `PAPERLESS_TIME_ZONE` to your local time zone. -6. Create a system user under which you wish to run paperless. - - ```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: +7. Create the following directories if they are missing: - `/opt/paperless/media` - `/opt/paperless/data` - `/opt/paperless/consume` Adjust as necessary if you configured different folders. + Ensure that the paperless user has write permissions for every one + of these folders with + + ```shell-session + ls -l -d /opt/paperless/media + ``` + + If needed, change the owner with + + ```shell-session + sudo chown paperless:paperless /opt/paperless/media + sudo chown paperless:paperless /opt/paperless/data + sudo chown paperless:paperless /opt/paperless/consume + ``` 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 @@ -401,7 +427,9 @@ supported. sudo -Hu paperless python3 manage.py runserver ``` - and pointing your browser to . + and pointing your browser to http://localhost:8000 if + accessing from the same devices on which paperless is installed. + If accessing from another machine, set up systemd services. !!! warning @@ -452,6 +480,14 @@ supported. For instructions on how to use nginx for that, [see the instructions below](/setup#nginx). + !!! warning + + If celery won't start (check with + `sudo systemctl status paperless-task-queue.service` for + paperless-task-queue.service and paperless-scheduler.service + ) you need to change the path in the files. Example: + `ExecStart=/opt/paperless/.local/bin/celery --app paperless worker --loglevel INFO` + 12. Optional: Install a samba server and make the consumption folder available as a network share. From 31e4a0a88bd2fa44f3bcf3c1912c04b30fa8f583 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 2 Jan 2023 08:47:44 -0800 Subject: [PATCH 02/15] Add note that PAPERLESS_URL cant contain a path --- docs/configuration.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 7e47f2178..0b92538a1 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -217,6 +217,11 @@ not include a trailing slash. E.g. Defaults to empty string, leaving the other settings unaffected. + !!! note + + This value cannot contain a path (e.g. domain.com/path), even if + you are installing paperless-ngx at a subpath. + `PAPERLESS_CSRF_TRUSTED_ORIGINS=` : A list of trusted origins for unsafe requests (e.g. POST). As of From 76acf2b01d8e4dd5e6eb159b5aa758a1bcc00765 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 3 Jan 2023 08:17:12 -0800 Subject: [PATCH 03/15] Updated build instructions to remove --prod --- docs/development.md | 2 +- src-ui/README.md | 2 +- src-ui/src/environments/environment.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/development.md b/docs/development.md index d36cd12ed..7515406f4 100644 --- a/docs/development.md +++ b/docs/development.md @@ -248,7 +248,7 @@ Testing and code style: In order to build the front end and serve it as part of django, execute ```shell-session -$ ng build --prod +$ ng build --configuration production ``` This will build the front end and put it in a location from which the diff --git a/src-ui/README.md b/src-ui/README.md index 568ba0874..0eb379956 100644 --- a/src-ui/README.md +++ b/src-ui/README.md @@ -12,7 +12,7 @@ Run `ng generate component component-name` to generate a new component. You can ## Build -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. +Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--configuration production` flag for a production build. ## Running unit tests diff --git a/src-ui/src/environments/environment.ts b/src-ui/src/environments/environment.ts index 4386bef1e..b4af67c25 100644 --- a/src-ui/src/environments/environment.ts +++ b/src-ui/src/environments/environment.ts @@ -1,5 +1,5 @@ // This file can be replaced during build by using the `fileReplacements` array. -// `ng build --prod` replaces `environment.ts` with `environment.prod.ts`. +// `ng build --configuration production` replaces `environment.ts` with `environment.prod.ts`. // The list of file replacements can be found in `angular.json`. export const environment = { From 3625e5080c7350605873e2ef45d1c7e01ef54617 Mon Sep 17 00:00:00 2001 From: Patrick Veverka Date: Sat, 7 Jan 2023 11:38:32 -0500 Subject: [PATCH 04/15] Tiny spelling change --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 0b92538a1..477fedb2d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -716,7 +716,7 @@ for details on how to set it. : Enables or disables the advanced natural language processing used during automatic classification. If disabled, paperless will -still preform some basic text pre-processing before matching. +still perform some basic text pre-processing before matching. See also `PAPERLESS_NLTK_DIR`. From d4af7aa411edd879f3883765037a5c1e397dde69 Mon Sep 17 00:00:00 2001 From: Anton Stubenbord <79228196+astubenbord@users.noreply.github.com> Date: Sun, 8 Jan 2023 17:30:32 +0100 Subject: [PATCH 05/15] Add Paperless Mobile app to docs (#2378) * Update usage.md Adds [Paperless Mobile](https://github.com/astubenbord/paperless-mobile) to the list of possible mobile upload options. * Update docs/usage.md Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> * lint Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> --- docs/usage.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index db5af042b..0f1c5b88f 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -108,6 +108,8 @@ Furthermore, there is the [Paperless App](https://github.com/bauerj/paperless_app) as well, which not only has document upload, but also document browsing and download features. +Another option is [Paperless Mobile](https://github.com/astubenbord/paperless-mobile), an Android app that supports document upload, scanning, management of labels and more. + ### IMAP (Email) {#usage-email} You can tell paperless-ngx to consume documents from your email From e96e8472d90bb0351e45ae6db65109d11181a88e Mon Sep 17 00:00:00 2001 From: PascalSenn Date: Sun, 8 Jan 2023 21:55:48 +0100 Subject: [PATCH 06/15] Fixed endpoint count in Docs "The REST API" --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index bd615ab86..2c200dea7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -6,7 +6,7 @@ provides a browsable API for most of its endpoints, which you can inspect at `http://:/api/`. This also documents most of the available filters and ordering fields. -The API provides 5 main endpoints: +The API provides 7 main endpoints: - `/api/documents/`: Full CRUD support, except POSTing new documents. See below. From 7b87511e88807ab5f3749b809fb8af2ef0ca5e2c Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 8 Jan 2023 13:41:23 -0800 Subject: [PATCH 07/15] Add note re `PAPERLESS_DEBUG` for dev server --- docs/setup.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/setup.md b/docs/setup.md index 2923d06ce..c0f1ec114 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -429,7 +429,9 @@ supported. and pointing your browser to http://localhost:8000 if accessing from the same devices on which paperless is installed. - If accessing from another machine, set up systemd services. + If accessing from another machine, set up systemd services. You may need + to set `PAPERLESS_DEBUG=true` in order for the development server to work + normally in your browser. !!! warning From f8f0915a325ca22be49ef5bac37106e7fabe148a Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 8 Jan 2023 13:50:48 -0800 Subject: [PATCH 08/15] Reverts commit a8f3c4be5494303ed16b04ff0b4a78325302f558 --- .github/workflows/release-chart.yml | 31 --- .pre-commit-config.yaml | 5 +- charts/paperless-ngx/.helmignore | 26 --- charts/paperless-ngx/Chart.yaml | 35 ---- charts/paperless-ngx/LICENSE | 201 ------------------- charts/paperless-ngx/README.md | 50 ----- charts/paperless-ngx/README_CONFIG.md.gotmpl | 8 - charts/paperless-ngx/ci/ct-values.yaml | 26 --- charts/paperless-ngx/templates/NOTES.txt | 4 - charts/paperless-ngx/templates/common.yaml | 11 - charts/paperless-ngx/values.yaml | 107 ---------- 11 files changed, 2 insertions(+), 502 deletions(-) delete mode 100644 .github/workflows/release-chart.yml delete mode 100644 charts/paperless-ngx/.helmignore delete mode 100644 charts/paperless-ngx/Chart.yaml delete mode 100644 charts/paperless-ngx/LICENSE delete mode 100644 charts/paperless-ngx/README.md delete mode 100644 charts/paperless-ngx/README_CONFIG.md.gotmpl delete mode 100644 charts/paperless-ngx/ci/ct-values.yaml delete mode 100644 charts/paperless-ngx/templates/NOTES.txt delete mode 100644 charts/paperless-ngx/templates/common.yaml delete mode 100644 charts/paperless-ngx/values.yaml diff --git a/.github/workflows/release-chart.yml b/.github/workflows/release-chart.yml deleted file mode 100644 index a82ac4ed8..000000000 --- a/.github/workflows/release-chart.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Release Charts - -on: - push: - tags: - - v* - -jobs: - release_chart: - name: "Release Chart" - runs-on: ubuntu-22.04 - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Configure Git - run: | - git config user.name "$GITHUB_ACTOR" - git config user.email "$GITHUB_ACTOR@users.noreply.github.com" - - name: Install Helm - uses: azure/setup-helm@v3 - with: - version: v3.10.0 - - - name: Run chart-releaser - uses: helm/chart-releaser-action@v1.4.1 - env: - CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 76380aea9..5660371f8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,14 +11,13 @@ repos: - id: check-json exclude: "tsconfig.*json" - id: check-yaml - exclude: "charts/paperless-ngx/templates/common.yaml" - id: check-toml - id: check-executables-have-shebangs - id: end-of-file-fixer exclude_types: - svg - pofile - exclude: "^(LICENSE|charts/paperless-ngx/README.md)$" + exclude: "(^LICENSE$)" - id: mixed-line-ending args: - "--fix=lf" @@ -35,7 +34,7 @@ repos: - javascript - ts - markdown - exclude: "(^Pipfile\\.lock$)|(^charts/paperless-ngx/README.md$)" + exclude: "(^Pipfile\\.lock$)" # Python hooks - repo: https://github.com/asottile/reorder_python_imports rev: v3.9.0 diff --git a/charts/paperless-ngx/.helmignore b/charts/paperless-ngx/.helmignore deleted file mode 100644 index 4379e2b30..000000000 --- a/charts/paperless-ngx/.helmignore +++ /dev/null @@ -1,26 +0,0 @@ -# Patterns to ignore when building packages. -# This supports shell glob matching, relative path matching, and -# negation (prefixed with !). Only one pattern per line. -.DS_Store -# Common VCS dirs -.git/ -.gitignore -.bzr/ -.bzrignore -.hg/ -.hgignore -.svn/ -# Common backup files -*.swp -*.bak -*.tmp -*~ -# Various IDEs -.project -.idea/ -*.tmproj -.vscode/ -# OWNERS file for Kubernetes -OWNERS -# helm-docs templates -*.gotmpl diff --git a/charts/paperless-ngx/Chart.yaml b/charts/paperless-ngx/Chart.yaml deleted file mode 100644 index e91796bab..000000000 --- a/charts/paperless-ngx/Chart.yaml +++ /dev/null @@ -1,35 +0,0 @@ ---- -apiVersion: v2 -appVersion: "1.9.2" -description: Paperless-ngx - Index and archive all of your scanned paper documents -name: paperless -version: 10.0.1 -kubeVersion: ">=1.16.0-0" -keywords: - - paperless - - paperless-ngx - - dms - - document -home: https://github.com/paperless-ngx/paperless-ngx/tree/main/charts/paperless-ngx -icon: https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/svg/square.svg -sources: - - https://github.com/paperless-ngx/paperless-ngx -maintainers: - - name: Paperless-ngx maintainers -dependencies: - - name: common - repository: https://library-charts.k8s-at-home.com - version: 4.5.2 - - name: postgresql - version: 11.6.12 - repository: https://charts.bitnami.com/bitnami - condition: postgresql.enabled - - name: redis - version: 16.13.1 - repository: https://charts.bitnami.com/bitnami - condition: redis.enabled -deprecated: false -annotations: - artifacthub.io/changes: | - - kind: changed - description: Moved to Paperless-ngx ownership diff --git a/charts/paperless-ngx/LICENSE b/charts/paperless-ngx/LICENSE deleted file mode 100644 index 056d3dab3..000000000 --- a/charts/paperless-ngx/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2020 k8s@Home - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/charts/paperless-ngx/README.md b/charts/paperless-ngx/README.md deleted file mode 100644 index be49a25d0..000000000 --- a/charts/paperless-ngx/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# paperless - -![Version: 10.0.0](https://img.shields.io/badge/Version-10.0.0-informational?style=flat-square) ![AppVersion: 1.9.2](https://img.shields.io/badge/AppVersion-1.9.2-informational?style=flat-square) - -Paperless-ngx - Index and archive all of your scanned paper documents - -**Homepage:** - -## Maintainers - -| Name | Email | Url | -| ---- | ------ | --- | -| Paperless-ngx maintainers | | | - -## Source Code - -* - -## Requirements - -Kubernetes: `>=1.16.0-0` - -| Repository | Name | Version | -|------------|------|---------| -| https://charts.bitnami.com/bitnami | postgresql | 11.6.12 | -| https://charts.bitnami.com/bitnami | redis | 16.13.1 | -| https://library-charts.k8s-at-home.com | common | 4.5.2 | - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| env | object | See below | See the following files for additional environment variables: https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose/ https://github.com/paperless-ngx/paperless-ngx/blob/main/paperless.conf.example | -| env.COMPOSE_PROJECT_NAME | string | `"paperless"` | Project name | -| env.PAPERLESS_DBHOST | string | `nil` | Database host to use | -| env.PAPERLESS_OCR_LANGUAGE | string | `"eng"` | OCR languages to install | -| env.PAPERLESS_PORT | int | `8000` | Port to use | -| env.PAPERLESS_REDIS | string | `nil` | Redis to use | -| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | -| image.repository | string | `"ghcr.io/paperless-ngx/paperless-ngx"` | image repository | -| image.tag | string | chart.appVersion | image tag | -| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | -| persistence.consume | object | See values.yaml | Configure volume to monitor for new documents. | -| persistence.data | object | See values.yaml | Configure persistence for data. | -| persistence.export | object | See values.yaml | Configure export volume. | -| persistence.media | object | See values.yaml | Configure persistence for media. | -| postgresql | object | See values.yaml | Enable and configure postgresql database subchart under this key. For more options see [postgresql chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) | -| redis | object | See values.yaml | Enable and configure redis subchart under this key. For more options see [redis chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/redis) | -| service | object | See values.yaml | Configures service settings for the chart. | - diff --git a/charts/paperless-ngx/README_CONFIG.md.gotmpl b/charts/paperless-ngx/README_CONFIG.md.gotmpl deleted file mode 100644 index ba63bd5f6..000000000 --- a/charts/paperless-ngx/README_CONFIG.md.gotmpl +++ /dev/null @@ -1,8 +0,0 @@ -{{- define "custom.custom.configuration.header" -}} -## Custom configuration -{{- end -}} - -{{- define "custom.custom.configuration" -}} -{{ template "custom.custom.configuration.header" . }} -N/A -{{- end -}} diff --git a/charts/paperless-ngx/ci/ct-values.yaml b/charts/paperless-ngx/ci/ct-values.yaml deleted file mode 100644 index 3af930887..000000000 --- a/charts/paperless-ngx/ci/ct-values.yaml +++ /dev/null @@ -1,26 +0,0 @@ -env: - PAPERLESS_REDIS: redis://paperless-redis-headless:6379 - -persistence: - data: - enabled: true - type: emptyDir - media: - enabled: true - type: emptyDir - consume: - enabled: true - type: emptyDir - export: - enabled: true - type: emptyDir - -redis: - enabled: true - architecture: standalone - auth: - enabled: false - master: - persistence: - enabled: false - fullnameOverride: paperless-redis diff --git a/charts/paperless-ngx/templates/NOTES.txt b/charts/paperless-ngx/templates/NOTES.txt deleted file mode 100644 index d16476cad..000000000 --- a/charts/paperless-ngx/templates/NOTES.txt +++ /dev/null @@ -1,4 +0,0 @@ -{{- include "common.notes.defaultNotes" . }} -2. Create a super user by running the command: - export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "common.names.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - kubectl exec -it --namespace {{ .Release.Namespace }} $POD_NAME -- bash -c "python manage.py createsuperuser" diff --git a/charts/paperless-ngx/templates/common.yaml b/charts/paperless-ngx/templates/common.yaml deleted file mode 100644 index 13801ed4f..000000000 --- a/charts/paperless-ngx/templates/common.yaml +++ /dev/null @@ -1,11 +0,0 @@ -{{/* Make sure all variables are set properly */}} -{{- include "common.values.setup" . }} - -{{/* Append the hardcoded settings */}} -{{- define "paperless.harcodedValues" -}} -env: - PAPERLESS_URL: http{{if ne ( len .Values.ingress.main.tls ) 0 }}s{{end}}://{{ (first .Values.ingress.main.hosts).host }} -{{- end -}} -{{- $_ := merge .Values (include "paperless.harcodedValues" . | fromYaml) -}} - -{{ include "common.all" . }} diff --git a/charts/paperless-ngx/values.yaml b/charts/paperless-ngx/values.yaml deleted file mode 100644 index cde42deed..000000000 --- a/charts/paperless-ngx/values.yaml +++ /dev/null @@ -1,107 +0,0 @@ -# -# IMPORTANT NOTE -# -# This chart inherits from our common library chart. You can check the default values/options here: -# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml -# - -image: - # -- image repository - repository: ghcr.io/paperless-ngx/paperless-ngx - # -- image pull policy - pullPolicy: IfNotPresent - # -- image tag - # @default -- chart.appVersion - tag: - -# -- See the following files for additional environment variables: -# https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose/ -# https://github.com/paperless-ngx/paperless-ngx/blob/main/paperless.conf.example -# @default -- See below -env: - # -- Project name - COMPOSE_PROJECT_NAME: paperless - # -- Redis to use - PAPERLESS_REDIS: - # -- OCR languages to install - PAPERLESS_OCR_LANGUAGE: eng - # USERMAP_UID: 1000 - # USERMAP_GID: 1000 - # PAPERLESS_TIME_ZONE: Europe/London - # -- Database host to use - PAPERLESS_DBHOST: - # -- Port to use - PAPERLESS_PORT: 8000 - # -- Username for the root user - # PAPERLESS_ADMIN_USER: admin - # -- Password for the root user - # PAPERLESS_ADMIN_PASSWORD: admin - # PAPERLESS_URL: - -# -- Configures service settings for the chart. -# @default -- See values.yaml -service: - main: - ports: - http: - port: 8000 - -ingress: - # -- Enable and configure ingress settings for the chart under this key. - # @default -- See values.yaml - main: - enabled: false - -persistence: - # -- Configure persistence for data. - # @default -- See values.yaml - data: - enabled: false - mountPath: /usr/src/paperless/data - accessMode: ReadWriteOnce - emptyDir: - enabled: false - # -- Configure persistence for media. - # @default -- See values.yaml - media: - enabled: false - mountPath: /usr/src/paperless/media - accessMode: ReadWriteOnce - emptyDir: - enabled: false - # -- Configure volume to monitor for new documents. - # @default -- See values.yaml - consume: - enabled: false - mountPath: /usr/src/paperless/consume - accessMode: ReadWriteOnce - emptyDir: - enabled: false - # -- Configure export volume. - # @default -- See values.yaml - export: - enabled: false - mountPath: /usr/src/paperless/export - accessMode: ReadWriteOnce - emptyDir: - enabled: false - -# -- Enable and configure postgresql database subchart under this key. -# For more options see [postgresql chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) -# @default -- See values.yaml -postgresql: - enabled: false - postgresqlUsername: paperless - postgresqlPassword: paperless - postgresqlDatabase: paperless - persistence: - enabled: false - # storageClass: "" - -# -- Enable and configure redis subchart under this key. -# For more options see [redis chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/redis) -# @default -- See values.yaml -redis: - enabled: false - auth: - enabled: false From 150c7f26a5a3710de985e3cba5fcfdbeab27bd8c Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 13 Jan 2023 11:30:47 -0800 Subject: [PATCH 09/15] Fix comment re bare metal runserver command --- docs/setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.md b/docs/setup.md index c0f1ec114..8bffbd48d 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -423,7 +423,7 @@ supported. 10. Optional: Test that paperless is working by executing ```bash - # This collects static files from paperless and django. + # Manually starts the webserver sudo -Hu paperless python3 manage.py runserver ``` From 62ba4b973054fcf9cab1202f8c7a144e27332fc8 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 13 Jan 2023 20:33:01 -0800 Subject: [PATCH 10/15] Remove abandoned projects --- README.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/README.md b/README.md index 4dc09d787..a94fbac30 100644 --- a/README.md +++ b/README.md @@ -108,15 +108,6 @@ Paperless has been around a while now, and people are starting to build stuff on - [Scan to Paperless](https://github.com/sbrunner/scan-to-paperless): Scan and prepare (crop, deskew, OCR, ...) your documents for Paperless. - [Paperless Mobile](https://github.com/astubenbord/paperless-mobile): A modern, feature rich mobile application for Paperless. -These projects also exist, but their status and compatibility with paperless-ngx is unknown. - -- [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 compatible with paperless-ngx. - -- [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. 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. From 412d9f5cd2e777bd662cc2703879379522a4e6e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan-Jonas=20S=C3=A4mann?= Date: Mon, 16 Jan 2023 04:02:44 +0100 Subject: [PATCH 11/15] Update docs nginx reverse proxy example (#2443) * Update docs nginx reverse proxy example According to #817 P3P header is mandatory. Otherwise django CSRF breaks login * Note P3P header optional Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> --- docs/setup.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/setup.md b/docs/setup.md index c0f1ec114..642da4213 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -881,6 +881,7 @@ http { 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; + add_header P3P 'CP=""'; # may not be required in all setups } } } From e6cd3c1970765beb71c1b051e83e039ae0b20023 Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Tue, 17 Jan 2023 20:00:24 +0100 Subject: [PATCH 12/15] fix link --- docs/setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.md b/docs/setup.md index 9b2f2de50..cd738d239 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -143,7 +143,7 @@ steps described in [Docker setup](#docker_hub) automatically. !!! note You can copy any setting from the file `paperless.conf.example` and - paste it here. Have a look at [configuration](/configuration] to see what's available. + paste it here. Have a look at [configuration](/configuration) to see what's available. !!! note From 151573a26e9c29b99fe996e35e4f93746beeacb6 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 18 Jan 2023 06:28:38 -0800 Subject: [PATCH 13/15] Note optional sudo command in bare metal docs --- docs/administration.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/administration.md b/docs/administration.md index 320ad7a9c..44199e2fb 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -152,9 +152,11 @@ following: ```shell-session $ cd src - $ python3 manage.py migrate + $ python3 manage.py migrate # (1) ``` + 1. Including `sudo -Hu ` may be required + This might not actually do anything. Not every new paperless version comes with new database migrations. @@ -210,9 +212,11 @@ Bare metal: ```shell-session $ cd /path/to/paperless/src -$ python3 manage.py +$ python3 manage.py # (1) ``` +1. Including `sudo -Hu ` may be required + All commands have built-in help, which can be accessed by executing them with the argument `--help`. From 3c7eacf9235257e3f020146b4c6f3bacbc8daae9 Mon Sep 17 00:00:00 2001 From: Muli Dayan Date: Fri, 20 Jan 2023 12:10:25 -0500 Subject: [PATCH 14/15] Fix docker-compose.yml file name --- docs/setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.md b/docs/setup.md index cd738d239..afca4147f 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -46,7 +46,7 @@ steps described in [Docker setup](#docker_hub) automatically. page](https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose) and download one of the `docker-compose.*.yml` files, depending on which database backend you want to use. Rename this - file to `docker-compose.*.yml`. If you want to enable + file to `docker-compose.yml`. If you want to enable optional support for Office documents, download a file with `-tika` in the file name. Download the `docker-compose.env` file and the `.env` file as well and store them From e74af5c73cc67059493a06efd014619af062e422 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 24 Jan 2023 10:15:52 -0800 Subject: [PATCH 15/15] Note rollback need for regenerating thumbnails [skip ci] --- docs/setup.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index afca4147f..a04fc24de 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -784,7 +784,9 @@ with a few simple steps. Paperless-ngx modified the database schema slightly, however, these changes can be reverted while keeping your current data, so that your -current data will be compatible with original Paperless. +current data will be compatible with original Paperless. Thumbnails +were also changed from PNG to WEBP format and will need to be +re-generated. Execute this: @@ -800,9 +802,9 @@ $ cd /path/to/paperless/src $ python3 manage.py migrate documents 0023 ``` -After that, you need to clear your cookies (Paperless-ngx comes with -updated dependencies that do cookie-processing differently) and probably -your cache as well. +After regenerating thumbnails, you'll need to clear your cookies +(Paperless-ngx comes with updated dependencies that do cookie-processing +differently) and probably your cache as well. # Considerations for less powerful devices {#less-powerful-devices}