Fixes #172

Introduce some creative code around setting of ALLOWED_HOSTS that defaults to ['*'].  Also added PAPERLESS_ALLOWED_HOSTS to paperless.conf.example with an explanation as to what it's for

.codecov.yml

@@ -1,33 +0,0 @@
-codecov:
-  require_ci_to_pass: true
-# https://docs.codecov.com/docs/flags#recommended-automatic-flag-management
-# Require each flag to have 1 upload before notification
-flag_management:
-  default_rules:
-    after_n_builds: 1
-  individual_flags:
-    - name: backend
-      paths:
-        - src/
-    - name: frontend
-      paths:
-        - src-ui/
-# https://docs.codecov.com/docs/pull-request-comments
-# codecov will only comment if coverage changes
-comment:
-  require_changes: true
-coverage:
-  status:
-    project:
-      default:
-        # https://docs.codecov.com/docs/commit-status#threshold
-        threshold: 1%
-        # https://docs.codecov.com/docs/commit-status#only_pulls
-        only_pulls: true
-    patch:
-      default:
-        # For the changed lines only, target 75% covered, but
-        # allow as low as 50%
-        target: 75%
-        threshold: 25%
-        only_pulls: true

.dockerignore

@@ -1,21 +0,0 @@
-**/__pycache__
-/src-ui/.vscode
-/src-ui/node_modules
-/src-ui/dist
-.git
-/export
-/consume
-/media
-/data
-/docs
-.pytest_cache
-/dist
-/scripts
-/resources
-**/tests
-**/*.spec.ts
-**/htmlcov
-/src/.pytest_cache
-.idea
-.venv/
-.vscode/

.editorconfig

@@ -1,40 +0,0 @@
-# EditorConfig: http://EditorConfig.org
-
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-insert_final_newline = true
-trim_trailing_whitespace = true
-end_of_line = lf
-charset = utf-8
-max_line_length = 79
-
-[{*.html,*.css,*.js}]
-max_line_length = off
-
-[*.py]
-indent_size = 4
-indent_style = space
-
-[*.{yml,yaml}]
-indent_style = space
-
-[*.rst]
-indent_style = space
-
-[*.md]
-indent_style = space
-
-[Pipfile.lock]
-indent_style = space
-
-# Tests don't get a line width restriction.  It's still a good idea to follow
-# the 79 character rule, but in the interests of clarity, tests often need to
-# violate it.
-[**/test_*.py]
-max_line_length = off
-
-[Dockerfile*]
-indent_style = space

.env

@@ -1,2 +0,0 @@
-COMPOSE_PROJECT_NAME=paperless
-export PROMPT="(pipenv-projectname)$P$G"

.github/DISCUSSION_TEMPLATE/feature-requests.yml

@@ -1,14 +0,0 @@
-title: "[Feature Request] "
-body:
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: A clear and concise description of what you would like to see.
-    validations:
-      required: true
-  - type: textarea
-    id: other
-    attributes:
-      label: Other
-      description: Add any other context or information about the feature request here.

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,97 +0,0 @@
-name: Bug report
-description: Something is not working
-title: "[BUG] Concise description of the issue"
-labels: ["bug", "unconfirmed"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Have a question? 👉 [Start a new discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/new) or [ask in chat](https://matrix.to/#/#paperlessngx:matrix.org).
-
-        Before opening an issue, please double check:
-
-        - [The troubleshooting documentation](https://docs.paperless-ngx.com/troubleshooting/).
-        - [The installation instructions](https://docs.paperless-ngx.com/setup/#installation).
-        - [Existing issues and discussions](https://github.com/paperless-ngx/paperless-ngx/search?q=&type=issues).
-        - Disable any customer container initialization scripts, if using any
-
-        If you encounter issues while installing or configuring Paperless-ngx, please post in the ["Support" section of the discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=support).
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.
-      placeholder: |
-        Currently Paperless does not work when...
-
-        [Screenshot if applicable]
-    validations:
-      required: true
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Steps to reproduce
-      description: Steps to reproduce the behavior.
-      placeholder: |
-        1. Go to '...'
-        2. Click on '....'
-        3. See error
-    validations:
-      required: true
-  - type: textarea
-    id: logs
-    attributes:
-      label: Webserver logs
-      description: Logs from the web server related to your issue.
-      render: bash
-    validations:
-      required: true
-  - type: textarea
-    id: logs_browser
-    attributes:
-      label: Browser logs
-      description: Logs from the web browser related to your issue, if needed
-      render: bash
-  - type: input
-    id: version
-    attributes:
-      label: Paperless-ngx version
-      placeholder: e.g. 1.6.0
-    validations:
-      required: true
-  - type: input
-    id: host-os
-    attributes:
-      label: Host OS
-      description: Host OS of the machine running paperless-ngx. Please add the architecture (uname -m) if applicable.
-      placeholder: e.g. Archlinux / Ubuntu 20.04 / Raspberry Pi `arm64`
-    validations:
-      required: true
-  - type: dropdown
-    id: install-method
-    attributes:
-      label: Installation method
-      options:
-        - Docker - official image
-        - Docker - linuxserver.io image
-        - Bare metal
-        - Other (please describe above)
-      description: Note there are significant differences from the official image and linuxserver.io, please check if your issue is specific to the third-party image.
-    validations:
-      required: true
-  - type: input
-    id: browser
-    attributes:
-      label: Browser
-      description: Which browser you are using, if relevant.
-      placeholder: e.g. Chrome, Safari
-  - type: input
-    id: config-changes
-    attributes:
-      label: Configuration changes
-      description: Any configuration changes you made in `docker-compose.yml`, `docker-compose.env` or `paperless.conf`.
-  - type: input
-    id: other
-    attributes:
-      label: Other
-      description: Any other relevant details.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: 🤔 Questions and Help
-    url: https://github.com/paperless-ngx/paperless-ngx/discussions
-    about: This issue tracker is not for support questions. Please refer to our Discussions.
-  - name: 💬 Chat
-    url: https://matrix.to/#/#paperlessngx:matrix.org
-    about: Want to discuss Paperless-ngx with others? Check out our chat.
-  - name: 🚀 Feature Request
-    url: https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=feature-requests
-    about: Remember to search for existing feature requests and "up-vote" any you like

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,37 +0,0 @@
-<!--
-Note: All PRs with code changes should be targeted to the `dev` branch, pure documentation changes can target `main`
--->
-
-## Proposed change
-
-<!--
-Please include a summary of the change and which issue is fixed (if any) and any relevant motivation / context. List any dependencies that are required for this change. If appropriate, please include an explanation of how your proposed change can be tested. Screenshots and / or videos can also be helpful if appropriate.
--->
-
-Fixes # (issue)
-
-## Type of change
-
-<!--
-What type of change does your PR introduce to Paperless-ngx?
-NOTE: Please check only one box!
--->
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Other (please explain):
-
-## Checklist:
-
-<!--
-NOTE: PRs that do not address the following will not be merged, please do not skip any relevant items.
--->
-
-- [ ] I have read & agree with the [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md).
-- [ ] If applicable, I have included testing coverage for new code in this PR, for [backend](https://docs.paperless-ngx.com/development/#testing) and / or [front-end](https://docs.paperless-ngx.com/development/#testing-and-code-style) changes.
-- [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
-- [ ] If applicable, I have checked that all tests pass, see [documentation](https://docs.paperless-ngx.com/development/#back-end-development).
-- [ ] I have run all `pre-commit` hooks, see [documentation](https://docs.paperless-ngx.com/development/#code-formatting-with-pre-commit-hooks).
-- [ ] I have made corresponding changes to the documentation as needed.
-- [ ] I have checked my modifications for any breaking changes.

.github/dependabot.yml

@@ -1,48 +0,0 @@
-# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#package-ecosystem
-
-version: 2
-updates:
-
-  # Enable version updates for npm
-  - package-ecosystem: "npm"
-    target-branch: "dev"
-    # Look for `package.json` and `lock` files in the `/src-ui` directory
-    directory: "/src-ui"
-    # Check the npm registry for updates every month
-    schedule:
-      interval: "monthly"
-    labels:
-      - "frontend"
-      - "dependencies"
-    # Add reviewers
-    reviewers:
-      - "paperless-ngx/frontend"
-
-  # Enable version updates for Python
-  - package-ecosystem: "pip"
-    target-branch: "dev"
-    # Look for a `Pipfile` in the `root` directory
-    directory: "/"
-    # Check for updates once a week
-    schedule:
-      interval: "weekly"
-    labels:
-      - "backend"
-      - "dependencies"
-    # Add reviewers
-    reviewers:
-      - "paperless-ngx/backend"
-
-  # Enable updates for Github Actions
-  - package-ecosystem: "github-actions"
-    target-branch: "dev"
-    directory: "/"
-    schedule:
-      # Check for updates to GitHub Actions every month
-      interval: "monthly"
-    labels:
-      - "ci-cd"
-      - "dependencies"
-    # Add reviewers
-    reviewers:
-      - "paperless-ngx/ci-cd"

.github/release-drafter.yml

@@ -1,65 +0,0 @@
-autolabeler:
-  - label: "bug"
-    branch:
-      - '/^fix/'
-    title:
-      - "/^fix/i"
-      - "/^Bugfix/i"
-  - label: "enhancement"
-    branch:
-      - '/^feature/'
-    title:
-      - "/^feature/i"
-categories:
-  - title: 'Breaking Changes'
-    labels:
-      - 'breaking-change'
-  - title: 'Notable Changes'
-    labels:
-      - 'notable'
-  - title: 'Features'
-    labels:
-      - 'enhancement'
-  - title: 'Bug Fixes'
-    labels:
-      - 'bug'
-  - title: 'Documentation'
-    labels:
-      - 'documentation'
-  - title: 'Maintenance'
-    labels:
-      - 'chore'
-      - 'deployment'
-      - 'translation'
-      - 'ci-cd'
-  - title: 'Dependencies'
-    collapse-after: 3
-    labels:
-      - 'dependencies'
-  - title: 'All App Changes'
-    labels:
-      - 'frontend'
-      - 'backend'
-    collapse-after: 1
-include-labels:
-  - 'enhancement'
-  - 'bug'
-  - 'chore'
-  - 'deployment'
-  - 'translation'
-  - 'dependencies'
-  - 'documentation'
-  - 'frontend'
-  - 'backend'
-  - 'ci-cd'
-  - 'breaking-change'
-  - 'notable'
-exclude-labels:
-  - 'skip-changelog'
-category-template: '### $TITLE'
-change-template: '- $TITLE @$AUTHOR ([#$NUMBER]($URL))'
-change-title-escapes: '\<*_&#@'
-template: |
-  ## paperless-ngx $RESOLVED_VERSION
-
-  $CHANGES

.github/workflows/ci.yml

@@ -1,572 +0,0 @@
-name: ci
-
-on:
-  push:
-    tags:
-      # https://semver.org/#spec-item-2
-      - 'v[0-9]+.[0-9]+.[0-9]+'
-      # https://semver.org/#spec-item-9
-      - 'v[0-9]+.[0-9]+.[0-9]+-beta.rc[0-9]+'
-    branches-ignore:
-      - 'translations**'
-  pull_request:
-    branches-ignore:
-      - 'translations**'
-
-env:
-  # This is the version of pipenv all the steps will use
-  # If changing this, change Dockerfile
-  DEFAULT_PIP_ENV_VERSION: "2023.6.12"
-  # This is the default version of Python to use in most steps
-  # If changing this, change Dockerfile
-  DEFAULT_PYTHON_VERSION: "3.9"
-
-jobs:
-  pre-commit:
-    name: Linting Checks
-    runs-on: ubuntu-22.04
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v3
-      -
-        name: Install python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
-      -
-        name: Check files
-        uses: pre-commit/action@v3.0.0
-
-  documentation:
-    name: "Build Documentation"
-    runs-on: ubuntu-22.04
-    needs:
-      - pre-commit
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-      -
-        name: Set up Python
-        id: setup-python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
-          cache: "pipenv"
-          cache-dependency-path: 'Pipfile.lock'
-      -
-        name: Install pipenv
-        run: |
-          pip install --user pipenv==${DEFAULT_PIP_ENV_VERSION}
-      -
-        name: Install dependencies
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} sync --dev
-      -
-        name: List installed Python dependencies
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run pip list
-      -
-        name: Make documentation
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run mkdocs build --config-file ./mkdocs.yml
-      -
-        name: Upload artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: documentation
-          path: site/
-          retention-days: 7
-
-  documentation-deploy:
-    name: "Deploy Documentation"
-    runs-on: ubuntu-22.04
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    needs:
-      - documentation
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-      -
-        name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CUSTOM_DOMAIN: docs.paperless-ngx.com
-          CONFIG_FILE: mkdocs.yml
-          EXTRA_PACKAGES: build-base
-
-  tests-backend:
-    name: "Tests (${{ matrix.python-version }})"
-    runs-on: ubuntu-22.04
-    needs:
-      - pre-commit
-    strategy:
-      matrix:
-        python-version: ['3.8', '3.9', '3.10']
-      fail-fast: false
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-      -
-        name: Start containers
-        run: |
-          docker compose --file ${GITHUB_WORKSPACE}/docker/compose/docker-compose.ci-test.yml pull --quiet
-          docker compose --file ${GITHUB_WORKSPACE}/docker/compose/docker-compose.ci-test.yml up --detach
-      -
-        name: Set up Python
-        id: setup-python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "${{ matrix.python-version }}"
-          cache: "pipenv"
-          cache-dependency-path: 'Pipfile.lock'
-      -
-        name: Install pipenv
-        run: |
-          pip install --user pipenv==${DEFAULT_PIP_ENV_VERSION}
-      -
-        name: Install system dependencies
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends unpaper tesseract-ocr imagemagick ghostscript libzbar0 poppler-utils
-      -
-        name: Configure ImageMagick
-        run: |
-          sudo cp docker/imagemagick-policy.xml /etc/ImageMagick-6/policy.xml
-      -
-        name: Install Python dependencies
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run python --version
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} sync --dev
-      -
-        name: List installed Python dependencies
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run pip list
-      -
-        name: Tests
-        env:
-          PAPERLESS_CI_TEST: 1
-          # Enable paperless_mail testing against real server
-          PAPERLESS_MAIL_TEST_HOST: ${{ secrets.TEST_MAIL_HOST }}
-          PAPERLESS_MAIL_TEST_USER: ${{ secrets.TEST_MAIL_USER }}
-          PAPERLESS_MAIL_TEST_PASSWD: ${{ secrets.TEST_MAIL_PASSWD }}
-        run: |
-          cd src/
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run pytest -ra
-      -
-        name: Upload coverage to Codecov
-        if: ${{ matrix.python-version == env.DEFAULT_PYTHON_VERSION }}
-        uses: codecov/codecov-action@v3
-        with:
-          # not required for public repos, but intermittently fails otherwise
-          token: ${{ secrets.CODECOV_TOKEN }}
-          # future expansion
-          flags: backend
-      -
-        name: Stop containers
-        if: always()
-        run: |
-          docker compose --file ${GITHUB_WORKSPACE}/docker/compose/docker-compose.ci-test.yml logs
-          docker compose --file ${GITHUB_WORKSPACE}/docker/compose/docker-compose.ci-test.yml down
-
-  tests-frontend:
-    name: "Tests Frontend"
-    runs-on: ubuntu-22.04
-    needs:
-      - pre-commit
-    strategy:
-      matrix:
-        node-version: [16.x]
-    steps:
-      - uses: actions/checkout@v3
-      -
-        name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-          cache-dependency-path: 'src-ui/package-lock.json'
-      -
-        name: Install dependencies
-        run: cd src-ui && npm ci
-      -
-        name: Install Playwright
-        run: npx playwright install --with-deps
-      -
-        name: Linting checks
-        run: cd src-ui && npm run lint
-      -
-        name: Run Jest unit tests
-        run: cd src-ui && npm run test
-      -
-        name: Upload Jest coverage
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: jest-coverage-report
-          path: src-ui/coverage
-          retention-days: 7
-      -
-        name: Upload frontend coverage to Codecov
-        if: always()
-        uses: codecov/codecov-action@v3
-        with:
-          # not required for public repos, but intermittently fails otherwise
-          token: ${{ secrets.CODECOV_TOKEN }}
-          # future expansion
-          flags: frontend
-      -
-        name: Run Playwright e2e tests
-        run: cd src-ui && npx playwright test
-      -
-        name: Upload Playwright test results
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: playwright-report
-          path: src-ui/playwright-report
-          retention-days: 7
-
-  build-docker-image:
-    name: Build Docker image for ${{ github.ref_name }}
-    runs-on: ubuntu-22.04
-    if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || contains(github.ref, 'beta.rc') || startsWith(github.ref, 'refs/tags/v'))
-    concurrency:
-      group: ${{ github.workflow }}-build-docker-image-${{ github.ref_name }}
-      cancel-in-progress: true
-    needs:
-      - tests-backend
-      - tests-frontend
-    steps:
-      -
-        name: Check pushing to Docker Hub
-        id: push-other-places
-        # Only push to Dockerhub from the main repo AND the ref is either:
-        #  main
-        #  dev
-        #  beta
-        #  a tag
-        # Otherwise forks would require a Docker Hub account and secrets setup
-        run: |
-          if [[ ${{ github.repository_owner }} == "paperless-ngx" && ( ${{ github.ref_name }} == "main" || ${{ github.ref_name }} == "dev" || ${{ github.ref_name }} == "beta" || ${{ startsWith(github.ref, 'refs/tags/v') }} == "true" ) ]] ; then
-            echo "Enabling DockerHub image push"
-            echo "enable=true" >> $GITHUB_OUTPUT
-          else
-            echo "Not pushing to DockerHub"
-            echo "enable=false" >> $GITHUB_OUTPUT
-          fi
-      -
-        name: Set ghcr repository name
-        id: set-ghcr-repository
-        run: |
-          ghcr_name=$(echo "${{ github.repository }}" | awk '{ print tolower($0) }')
-          echo "Name is ${ghcr_name}"
-          echo "ghcr-repository=${ghcr_name}" >> $GITHUB_OUTPUT
-      -
-        name: Gather Docker metadata
-        id: docker-meta
-        uses: docker/metadata-action@v4
-        with:
-          images: |
-            ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}
-            name=paperlessngx/paperless-ngx,enable=${{ steps.push-other-places.outputs.enable }}
-            name=quay.io/paperlessngx/paperless-ngx,enable=${{ steps.push-other-places.outputs.enable }}
-          tags: |
-            # Tag branches with branch name
-            type=ref,event=branch
-            # Process semver tags
-            # For a tag x.y.z or vX.Y.Z, output an x.y.z and x.y image tag
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-      # If https://github.com/docker/buildx/issues/1044 is resolved,
-      # the append input with a native arm64 arch could be used to
-      # significantly speed up building
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-      -
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      -
-        name: Login to Github Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      -
-        name: Login to Docker Hub
-        uses: docker/login-action@v2
-        # Don't attempt to login is not pushing to Docker Hub
-        if: steps.push-other-places.outputs.enable == 'true'
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Login to Quay.io
-        uses: docker/login-action@v2
-        # Don't attempt to login is not pushing to Quay.io
-        if: steps.push-other-places.outputs.enable == 'true'
-        with:
-          registry: quay.io
-          username: ${{ secrets.QUAY_USERNAME }}
-          password: ${{ secrets.QUAY_ROBOT_TOKEN }}
-      -
-        name: Build and push
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          file: ./Dockerfile
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.docker-meta.outputs.tags }}
-          labels: ${{ steps.docker-meta.outputs.labels }}
-          # Get cache layers from this branch, then dev
-          # This allows new branches to get at least some cache benefits, generally from dev
-          cache-from: |
-            type=registry,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:${{ github.ref_name }}
-            type=registry,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:dev
-          cache-to: |
-            type=registry,mode=max,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:${{ github.ref_name }}
-      -
-        name: Inspect image
-        run: |
-          docker buildx imagetools inspect ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
-      -
-        name: Export frontend artifact from docker
-        run: |
-          docker create --name frontend-extract ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
-          docker cp frontend-extract:/usr/src/paperless/src/documents/static/frontend src/documents/static/frontend/
-      -
-        name: Upload frontend artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: frontend-compiled
-          path: src/documents/static/frontend/
-          retention-days: 7
-
-  build-release:
-    needs:
-      - build-docker-image
-    runs-on: ubuntu-22.04
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-      -
-        name: Set up Python
-        id: setup-python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
-          cache: "pipenv"
-          cache-dependency-path: 'Pipfile.lock'
-      -
-        name: Install pipenv + tools
-        run: |
-          pip install --upgrade --user pipenv==${DEFAULT_PIP_ENV_VERSION} setuptools wheel
-      -
-        name: Install Python dependencies
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} sync --dev
-      -
-        name: Install system dependencies
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends gettext liblept5
-      -
-        name: Download frontend artifact
-        uses: actions/download-artifact@v3
-        with:
-          name: frontend-compiled
-          path: src/documents/static/frontend/
-      -
-        name: Download documentation artifact
-        uses: actions/download-artifact@v3
-        with:
-          name: documentation
-          path: docs/_build/html/
-      -
-        name: Generate requirements file
-        run: |
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} requirements > requirements.txt
-      -
-        name: Compile messages
-        run: |
-          cd src/
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run python3 manage.py compilemessages
-      -
-        name: Collect static files
-        run: |
-          cd src/
-          pipenv --python ${{ steps.setup-python.outputs.python-version }} run python3 manage.py collectstatic --no-input
-      -
-        name: Move files
-        run: |
-          echo "Making dist folders"
-          for directory in dist \
-                          dist/paperless-ngx \
-                          dist/paperless-ngx/scripts;
-          do
-            mkdir --verbose --parents ${directory}
-          done
-
-          echo "Copying basic files"
-          for file_name in .dockerignore \
-                          .env \
-                          Dockerfile \
-                          Pipfile \
-                          Pipfile.lock \
-                          requirements.txt \
-                          LICENSE \
-                          README.md \
-                          paperless.conf.example \
-                          gunicorn.conf.py
-          do
-            cp --verbose ${file_name} dist/paperless-ngx/
-          done
-          mv --verbose dist/paperless-ngx/paperless.conf.example dist/paperless-ngx/paperless.conf
-
-          echo "Copying Docker related files"
-          cp --recursive docker/ dist/paperless-ngx/docker
-
-          echo "Copying startup scripts"
-          cp --verbose scripts/*.service scripts/*.sh scripts/*.socket dist/paperless-ngx/scripts/
-
-          echo "Copying source files"
-          cp --recursive src/ dist/paperless-ngx/src
-          echo "Copying documentation"
-          cp --recursive docs/_build/html/ dist/paperless-ngx/docs
-
-          mv --verbose static dist/paperless-ngx
-      -
-        name: Make release package
-        run: |
-          echo "Creating release archive"
-          cd dist
-          sudo chown -R 1000:1000 paperless-ngx/
-          tar -cJf paperless-ngx.tar.xz paperless-ngx/
-      -
-        name: Upload release artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: release
-          path: dist/paperless-ngx.tar.xz
-          retention-days: 7
-
-  publish-release:
-    runs-on: ubuntu-22.04
-    outputs:
-      prerelease: ${{ steps.get_version.outputs.prerelease }}
-      changelog: ${{ steps.create-release.outputs.body }}
-      version: ${{ steps.get_version.outputs.version }}
-    needs:
-      - build-release
-    if: github.ref_type == 'tag' && (startsWith(github.ref_name, 'v') || contains(github.ref_name, '-beta.rc'))
-    steps:
-      -
-        name: Download release artifact
-        uses: actions/download-artifact@v3
-        with:
-          name: release
-          path: ./
-      -
-        name: Get version
-        id: get_version
-        run: |
-          echo "version=${{ github.ref_name }}" >> $GITHUB_OUTPUT
-          if [[ ${{ contains(github.ref_name, '-beta.rc') }} == 'true' ]]; then
-            echo "prerelease=true" >> $GITHUB_OUTPUT
-          else
-            echo "prerelease=false" >> $GITHUB_OUTPUT
-          fi
-      -
-        name: Create Release and Changelog
-        id: create-release
-        uses: release-drafter/release-drafter@v5
-        with:
-          name: Paperless-ngx ${{ steps.get_version.outputs.version }}
-          tag: ${{ steps.get_version.outputs.version }}
-          version: ${{ steps.get_version.outputs.version }}
-          prerelease: ${{ steps.get_version.outputs.prerelease }}
-          publish: true # ensures release is not marked as draft
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      -
-        name: Upload release archive
-        id: upload-release-asset
-        uses: shogo82148/actions-upload-release-asset@v1
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          upload_url: ${{ steps.create-release.outputs.upload_url }}
-          asset_path: ./paperless-ngx.tar.xz
-          asset_name: paperless-ngx-${{ steps.get_version.outputs.version }}.tar.xz
-          asset_content_type: application/x-xz
-
-  append-changelog:
-    runs-on: ubuntu-22.04
-    needs:
-      - publish-release
-    if: needs.publish-release.outputs.prerelease == 'false'
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: main
-      -
-        name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
-          cache: "pipenv"
-          cache-dependency-path: 'Pipfile.lock'
-      -
-        name: Install pipenv + tools
-        run: |
-          pip install --upgrade --user pipenv==${DEFAULT_PIP_ENV_VERSION} setuptools wheel
-      -
-        name: Append Changelog to docs
-        id: append-Changelog
-        working-directory: docs
-        run: |
-          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
-          pipenv run pre-commit run --files changelog.md || true
-          git config --global user.name "github-actions"
-          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git commit -am "Changelog ${{ needs.publish-release.outputs.version }} - GHA"
-          git push origin ${{ needs.publish-release.outputs.version }}-changelog
-      -
-        name: Create Pull Request
-        uses: actions/github-script@v6
-        with:
-          script: |
-            const { repo, owner } = context.repo;
-            const result = await github.rest.pulls.create({
-              title: '[Documentation] Add ${{ needs.publish-release.outputs.version }} changelog',
-              owner,
-              repo,
-              head: '${{ needs.publish-release.outputs.version }}-changelog',
-              base: 'main',
-              body: 'This PR is auto-generated by CI.'
-            });
-            github.rest.issues.addLabels({
-              owner,
-              repo,
-              issue_number: result.data.number,
-              labels: ['documentation', 'skip-changelog']
-            });

.github/workflows/cleanup-tags.yml

@@ -1,77 +0,0 @@
-# This workflow runs on certain conditions to check for and potentially
-# delete container images from the GHCR which no longer have an associated
-# code branch.
-# Requires a PAT with the correct scope set in the secrets.
-#
-# This workflow will not trigger runs on forked repos.
-
-name: Cleanup Image Tags
-
-on:
-  delete:
-  push:
-    paths:
-      - ".github/workflows/cleanup-tags.yml"
-
-concurrency:
-  group: registry-tags-cleanup
-  cancel-in-progress: false
-
-jobs:
-  cleanup-images:
-    name: Cleanup Image Tags for paperless-ngx
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-22.04
-    env:
-      # Requires a personal access token with the OAuth scope delete:packages
-      TOKEN: ${{ secrets.GHA_CONTAINER_DELETE_TOKEN }}
-    steps:
-      -
-        name: Clean temporary images
-        if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.1.0
-        with:
-          token: "${{ env.TOKEN }}"
-          owner: "${{ github.repository_owner }}"
-          is_org: "true"
-          package_name: "paperless-ngx"
-          scheme: "branch"
-          repo_name: "paperless-ngx"
-          match_regex: "feature-"
-          do_delete: "true"
-
-  cleanup-untagged-images:
-    name: Cleanup Untagged Images Tags for ${{ matrix.primary-name }}
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-22.04
-    needs:
-      - cleanup-images
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - primary-name: "paperless-ngx"
-          - primary-name: "paperless-ngx/builder/cache/app"
-          # TODO: Remove the above and replace with the below
-          # - primary-name: "builder/qpdf"
-          # - primary-name: "builder/cache/qpdf"
-          # - primary-name: "builder/pikepdf"
-          # - primary-name: "builder/cache/pikepdf"
-          # - primary-name: "builder/jbig2enc"
-          # - primary-name: "builder/cache/jbig2enc"
-          # - primary-name: "builder/psycopg2"
-          # - primary-name: "builder/cache/psycopg2"
-    env:
-      # Requires a personal access token with the OAuth scope delete:packages
-      TOKEN: ${{ secrets.GHA_CONTAINER_DELETE_TOKEN }}
-    steps:
-      -
-        name: Clean untagged images
-        if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.1.0
-        with:
-          token: "${{ env.TOKEN }}"
-          owner: "${{ github.repository_owner }}"
-          is_org: "true"
-          package_name: "${{ matrix.primary-name }}"
-          do_delete: "true"

.github/workflows/codeql-analysis.yml

@@ -1,54 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ main, dev ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ dev ]
-  schedule:
-    - cron: '28 13 * * 5'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-22.04
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript', 'python' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2

.github/workflows/project-actions.yml

@@ -1,57 +0,0 @@
-name: Project Automations
-
-on:
-  issues:
-    types:
-      - opened
-      - reopened
-  pull_request_target: #_target allows access to secrets
-    types:
-      - opened
-      - reopened
-    branches:
-      - main
-      - dev
-
-permissions:
-  contents: read
-
-env:
-  todo: Todo
-  done: Done
-  in_progress: In Progress
-
-jobs:
-  issue_opened_or_reopened:
-    name: issue_opened_or_reopened
-    runs-on: ubuntu-22.04
-    if: github.event_name == 'issues' && (github.event.action == 'opened' || github.event.action == 'reopened')
-    steps:
-      - name: Add issue to project and set status to ${{ env.todo }}
-        uses: leonsteinhaeuser/project-beta-automations@v2.1.0
-        with:
-          gh_token: ${{ secrets.GH_TOKEN }}
-          organization: paperless-ngx
-          project_id: 2
-          resource_node_id: ${{ github.event.issue.node_id }}
-          status_value: ${{ env.todo }} # Target status
-  pr_opened_or_reopened:
-    name: pr_opened_or_reopened
-    runs-on: ubuntu-22.04
-    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: Add PR to project and set status to "Needs Review"
-        uses: leonsteinhaeuser/project-beta-automations@v2.1.0
-        with:
-          gh_token: ${{ secrets.GH_TOKEN }}
-          organization: paperless-ngx
-          project_id: 2
-          resource_node_id: ${{ github.event.pull_request.node_id }}
-          status_value: "Needs Review" # Target status
-      - name: Label PR with release-drafter
-        uses: release-drafter/release-drafter@v5
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/repo-maintenance.yml

@@ -1,47 +0,0 @@
-name: 'Repository Maintenance'
-
-on:
-  schedule:
-    - cron: '0 3 * * *'
-  workflow_dispatch:
-
-permissions:
-  issues: write
-  pull-requests: write
-
-concurrency:
-  group: lock
-
-jobs:
-  stale:
-    name: 'Stale'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v8
-        with:
-          days-before-stale: 7
-          days-before-close: 14
-          any-of-labels: 'cant-reproduce,not a bug'
-          stale-issue-label: stale
-          stale-pr-label: stale
-          stale-issue-message: >
-            This issue has been automatically marked as stale because it has not had
-            recent activity. It will be closed if no further activity occurs. Thank you
-            for your contributions.
-  lock-threads:
-    name: 'Lock Old Threads'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: dessant/lock-threads@v4
-        with:
-          issue-inactive-days: '30'
-          pr-inactive-days: '30'
-          log-output: true
-          issue-comment: >
-            This issue has been automatically locked since there
-            has not been any recent activity after it was closed.
-            Please open a new discussion or issue for related concerns.
-          pr-comment: >
-            This pull request has been automatically locked since there
-            has not been any recent activity after it was closed.
-            Please open a new discussion or issue for related concerns.

.gitignore

@@ -42,7 +42,6 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *,cover
-.pytest_cache
 
 # Translations
 *.mo
@@ -51,49 +50,30 @@ coverage.xml
 # Django stuff:
 *.log
 
-# MkDocs documentation
-site/
+# Sphinx documentation
+docs/_build/
 
 # PyBuilder
 target/
 
+# Stored PDFs
+media/documents/*.gpg
+media/documents/thumbnails/*.gpg
+media/documents/originals/*.gpg
+
+# Sqlite database
+db.sqlite3
 
 # PyCharm
 .idea
 
-# VS Code
-.vscode
-/src-ui/.vscode
-/docs/.vscode
-
 # Other stuff that doesn't belong
-.virtualenv
 virtualenv
-/venv
-.venv/
-/docker-compose.env
-/docker-compose.yml
-.ruff_cache/
+.vagrant
+docker-compose.yml
+docker-compose.env
 
 # Used for development
 scripts/import-for-development
 scripts/nuke
 
-# Static files collected by the collectstatic command
-/static/
-
-# Stored PDFs
-/media/
-/data/
-/paperless.conf
-/consume/
-/export/
-
-# this is where the compiled frontend is moved to.
-/src/documents/static/frontend/
-
-# mac os
-.DS_Store
-
-# celery schedule file
-celerybeat-schedule*

.hadolint.yml

@@ -1,8 +0,0 @@
-failure-threshold: warning
-ignored:
-  # https://github.com/hadolint/hadolint/wiki/DL3008
-  - DL3008
-  # https://github.com/hadolint/hadolint/wiki/DL3013
-  - DL3013
-  # https://github.com/hadolint/hadolint/wiki/DL3003
-  - DL3003

.pre-commit-config.yaml

@@ -1,62 +0,0 @@
-# This file configures pre-commit hooks.
-# See https://pre-commit.com/ for general information
-# See https://pre-commit.com/hooks.html for a listing of possible hooks
-
-repos:
-  # General hooks
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-      - id: check-docstring-first
-      - id: check-json
-        exclude: "tsconfig.*json"
-      - id: check-yaml
-      - id: check-toml
-      - id: check-executables-have-shebangs
-      - id: end-of-file-fixer
-        exclude_types:
-          - svg
-          - pofile
-        exclude: "(^LICENSE$)"
-      - id: mixed-line-ending
-        args:
-          - "--fix=lf"
-      - id: trailing-whitespace
-        exclude_types:
-          - svg
-      - id: check-case-conflict
-      - id: detect-private-key
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: 'v2.7.1'
-    hooks:
-      - id: prettier
-        types_or:
-          - javascript
-          - ts
-          - markdown
-        exclude: "(^Pipfile\\.lock$)"
-  # Python hooks
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.272'
-    hooks:
-      - id: ruff
-  - repo: https://github.com/psf/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  # Dockerfile hooks
-  - repo: https://github.com/AleksaC/hadolint-py
-    rev: v2.12.0.2
-    hooks:
-      - id: hadolint
-  # Shell script hooks
-  - repo: https://github.com/lovesegfault/beautysh
-    rev: v6.2.1
-    hooks:
-      - id: beautysh
-        args:
-          - "--tab"
-  - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: "v0.9.0.5"
-    hooks:
-      - id: shellcheck

.prettierrc

@@ -1,4 +0,0 @@
-# https://prettier.io/docs/en/options.html#semicolons
-semi: false
-# https://prettier.io/docs/en/options.html#quotes
-singleQuote: true

.python-version

@@ -1 +0,0 @@
-3.8.16

.ruff.toml

@@ -1,23 +0,0 @@
-# https://beta.ruff.rs/docs/settings/
-# https://beta.ruff.rs/docs/rules/
-extend-select = ["I", "W", "UP", "COM", "DJ", "EXE", "ISC", "ICN", "G201", "INP", "PIE", "RSE", "SIM", "TID", "PLC", "PLE", "RUF"]
-# TODO PTH
-ignore = ["DJ001", "SIM105"]
-fix = true
-line-length = 88
-respect-gitignore = true
-src = ["src"]
-target-version = "py38"
-format = "grouped"
-show-fixes = true
-
-[per-file-ignores]
-".github/scripts/*.py" = ["E501", "INP001", "SIM117"]
-"docker/wait-for-redis.py" = ["INP001"]
-"*/tests/*.py" = ["E501", "SIM117"]
-"*/migrations/*.py" = ["E501", "SIM"]
-"src/paperless_tesseract/tests/test_parser.py" = ["RUF001"]
-"src/documents/models.py" = ["SIM115"]
-
-[isort]
-force-single-line = true

.travis.yml

@@ -0,0 +1,18 @@
+language: python
+
+sudo: false
+
+matrix:
+    include:
+        - python: 3.4
+          env: TOXENV=py34
+        - python: 3.5
+          env: TOXENV=py35
+        - python: 3.5
+          env: TOXENV=pep8
+
+install:
+    - pip install --requirement requirements.txt
+    - pip install tox
+
+script: tox -c src/tox.ini

CODEOWNERS

@@ -1,9 +0,0 @@
-/.github/workflows/ @paperless-ngx/ci-cd
-/docker/ @paperless-ngx/ci-cd
-/scripts/ @paperless-ngx/ci-cd
-
-/src-ui/ @paperless-ngx/frontend
-
-/src/ @paperless-ngx/backend
-Pipfile* @paperless-ngx/backend
-*.py @paperless-ngx/backend

CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-hello@paperless-ngx.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -1,132 +0,0 @@
-# Contributing
-
-If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome.
-
-If you want to implement something big:
-
-- Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together.
-- When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project.
-- Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change.
-- Please see the [paperless-ngx merge process](#merging-prs) below.
-
-## Python
-
-Paperless supports python 3.8 and 3.9. We format Python code with [Black](https://github.com/psf/black).
-
-## Branches
-
-`main` always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases.
-
-`dev` contains all changes that will be part of the next release. Use this branch to start making your changes.
-
-`feature-X` branches are for experimental stuff that will eventually be merged into dev.
-
-## Testing:
-
-Please format and test your code! I know it's a hassle, but it makes sure that your code works now and will allow us to detect regressions easily.
-
-To test your code, execute `pytest` in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing.
-
-Before you can run `pytest`, ensure to [properly set up your local environment](https://docs.paperless-ngx.com/development/#initial-setup-and-first-start).
-
-## More info:
-
-... is available [in the documentation](https://docs.paperless-ngx.com/development).
-
-# Merging PRs
-
-Once you have submitted a **P**ull **R**equest it will be reviewed, approved, and merged by one or more community members of any team. Automated code tests and formatting checks must be passed.
-
-## Non-Trivial Requests
-
-PRs deemed `non-trivial` will go through a stricter review process before being merged into `dev`. This is to ensure code quality and complete functionality (free of side effects).
-
-Examples of `non-trivial` PRs might include:
-
-- Additional features
-- Large changes to many distinct files
-- Breaking or depreciation of existing features
-
-Our community review process for `non-trivial` PRs is the following:
-
-1. Must pass usual automated code tests and formatting checks.
-2. The PR will be assigned and pinged to the appropriately experienced team (i.e. @paperless-ngx/backend for backend changes).
-3. Development team will check and test code manually (possibly over several days).
-   - You may be asked to make changes or rebase.
-   - The team may ask for additional testing done by @paperless-ngx/test
-4. **At least two** members of the team will approve and finally merge the request into `dev` 🎉.
-
-This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler.
-
-# Translating Paperless-ngx
-
-Some notes about translation:
-
-- There are two resources:
-  - `src-ui/messages.xlf` contains the translation strings for the front end. This is the most important.
-  - `django.po` contains strings for the administration section of paperless, which is nice to have translated.
-- Most of the front-end strings are used on buttons, menu items, etc., so ideally the translated string should not be much longer than the English original.
-- Translation units may contain placeholders. These usually mean that there's a name of a tag or document or something in the string. You can click on the placeholders to copy them.
-- Translation units may contain plural expressions such as `{PLURAL_VAR, plural, =1 {one result} =0 {no results} other {<placeholder> results}}`. Copy these verbatim and translate only the content in the inner `{}` brackets. Example: `{PLURAL_VAR, plural, =1 {Ein Ergebnis} =0 {Keine Ergebnisse} other {<placeholder> Ergebnisse}}`
-- Changes to translations on Crowdin will get pushed into the repository automatically.
-
-## Adding new languages to the codebase
-
-If a language has already been added, and you would like to contribute new translations or change existing translations, please read the "Translation" section in the README.md file for further details on that.
-
-If you would like the project to be translated to another language, first head over to https://crwd.in/paperless-ngx to check if that language has already been enabled for translation.
-If not, please request the language to be added by creating an issue on GitHub. The issue should contain:
-
-- English name of the language (the localized name can be added on Crowdin).
-- ISO language code. A list of those can be found here: https://support.crowdin.com/enterprise/language-codes/
-- Date format commonly used for the language, e.g. dd/mm/yyyy, mm/dd/yyyy, etc.
-
-After the language has been added and some translations have been made on Crowdin, the language needs to be enabled in the code.
-Note that there is no need to manually add a .po of .xlf file as those will be automatically generated and imported from Crowdin.
-The following files need to be changed:
-
-- src-ui/angular.json (under the _projects/paperless-ui/i18n/locales_ JSON key)
-- src/paperless/settings.py (in the _LANGUAGES_ array)
-- src-ui/src/app/services/settings.service.ts (inside the _getLanguageOptions_ method)
-- src-ui/src/app/app.module.ts (import locale from _angular/common/locales_ and call _registerLocaleData_)
-
-Please add the language in the correct order, alphabetically by locale.
-Note that _en-us_ needs to stay on top of the list, as it is the default project language
-
-If you are familiar with Git, feel free to send a Pull Request with those changes.
-If not, let us know in the issue you created for the language, so that another developer can make these changes.
-
-# Organization Structure & Membership
-
-Paperless-ngx is a community project. We do our best to delegate permission and responsibility among a team of people to ensure the longevity of the project.
-
-## Structure
-
-As of writing, there are 21 members in paperless-ngx. 4 of these people have complete administrative privileges to the repo:
-
-- [@shamoon](https://github.com/shamoon)
-- [@bauerj](https://github.com/bauerj)
-- [@qcasey](https://github.com/qcasey)
-- [@FrankStrieter](https://github.com/FrankStrieter)
-
-There are 5 teams collaborating on specific tasks within paperless-ngx:
-
-- @paperless-ngx/backend (Python / django)
-- @paperless-ngx/frontend (JavaScript / Typescript)
-- @paperless-ngx/ci-cd (GitHub Actions / Deployment)
-- @paperless-ngx/issues (Issue triage)
-- @paperless-ngx/test (General testing for larger PRs)
-
-## Permissions
-
-All team members are notified when mentioned or assigned to a relevant issue or pull request. Additionally, each team has slightly different access to paperless-ngx:
-
-- The **test** team has no special permissions.
-- The **issues** team has `triage` access. This means they can organize issues and pull requests.
-- The **backend**, **frontend**, and **ci-cd** teams have `write` access. This means they can approve PRs and push code, containers, releases, and more.
-
-## Joining
-
-We are not overly strict with inviting people to the organization. If you have read the [team permissions](#permissions) and think having additional access would enhance your contributions, please reach out to an [admin](#structure) of the team.
-
-The admins occasionally invite contributors directly if we believe having them on a team will accelerate their work.

Dockerfile

@@ -1,266 +1,46 @@
-# syntax=docker/dockerfile:1
-# https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/reference.md
+FROM python:3.5
+MAINTAINER Pit Kleyersburg <pitkley@googlemail.com>
 
-# Stage: compile-frontend
-# Purpose: Compiles the frontend
-# Notes:
-#  - Does NPM stuff with Typescript and such
-FROM --platform=$BUILDPLATFORM docker.io/node:16-bookworm-slim AS compile-frontend
+# Install dependencies
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        sudo \
+        tesseract-ocr tesseract-ocr-eng imagemagick ghostscript unpaper \
+    && rm -rf /var/lib/apt/lists/*
 
-COPY ./src-ui /src/src-ui
+# Install python dependencies
+RUN mkdir -p /usr/src/paperless
+WORKDIR /usr/src/paperless
+COPY requirements.txt /usr/src/paperless/
+RUN pip install --no-cache-dir -r requirements.txt
 
-WORKDIR /src/src-ui
-RUN set -eux \
-  && npm update npm -g \
-  && npm ci --omit=optional
-RUN set -eux \
-  && ./node_modules/.bin/ng build --configuration production
+# Copy application
+RUN mkdir -p /usr/src/paperless/src
+RUN mkdir -p /usr/src/paperless/data
+RUN mkdir -p /usr/src/paperless/media
+COPY src/ /usr/src/paperless/src/
+COPY data/ /usr/src/paperless/data/
+COPY media/ /usr/src/paperless/media/
 
-# Stage: pipenv-base
-# Purpose: Generates a requirements.txt file for building
-# Comments:
-#  - pipenv dependencies are not left in the final image
-#  - pipenv can't touch the final image somehow
-FROM --platform=$BUILDPLATFORM docker.io/python:3.9-alpine as pipenv-base
+# Set consumption directory
+ENV PAPERLESS_CONSUMPTION_DIR /consume
+RUN mkdir -p $PAPERLESS_CONSUMPTION_DIR
 
-WORKDIR /usr/src/pipenv
+# Migrate database
+WORKDIR /usr/src/paperless/src
+RUN ./manage.py migrate
 
-COPY Pipfile* ./
+# Create user
+RUN groupadd -g 1000 paperless \
+    && useradd -u 1000 -g 1000 -d /usr/src/paperless paperless \
+    && chown -Rh paperless:paperless /usr/src/paperless
 
-RUN set -eux \
-  && echo "Installing pipenv" \
-    && python3 -m pip install --no-cache-dir --upgrade pipenv==2023.6.12 \
-  && echo "Generating requirement.txt" \
-    && pipenv requirements > requirements.txt
+# Setup entrypoint
+COPY scripts/docker-entrypoint.sh /sbin/docker-entrypoint.sh
+RUN chmod 755 /sbin/docker-entrypoint.sh
 
-# Stage: main-app
-# Purpose: The final image
-# Comments:
-#  - Don't leave anything extra in here
-FROM docker.io/python:3.9-slim-bookworm as main-app
-
-LABEL org.opencontainers.image.authors="paperless-ngx team <hello@paperless-ngx.com>"
-LABEL org.opencontainers.image.documentation="https://docs.paperless-ngx.com/"
-LABEL org.opencontainers.image.source="https://github.com/paperless-ngx/paperless-ngx"
-LABEL org.opencontainers.image.url="https://github.com/paperless-ngx/paperless-ngx"
-LABEL org.opencontainers.image.licenses="GPL-3.0-only"
-
-ARG DEBIAN_FRONTEND=noninteractive
-
-#
-# Begin installation and configuration
-# Order the steps below from least often changed to most
-#
-
-# Packages need for running
-ARG RUNTIME_PACKAGES="\
-  # General utils
-  curl \
-  # Docker specific
-  gosu \
-  # Timezones support
-  tzdata \
-  # fonts for text file thumbnail generation
-  fonts-liberation \
-  gettext \
-  ghostscript \
-  gnupg \
-  icc-profiles-free \
-  imagemagick \
-  # Image processing
-  liblept5 \
-  liblcms2-2 \
-  libtiff6 \
-  libfreetype6 \
-  libwebp7 \
-  libopenjp2-7 \
-  libimagequant0 \
-  libraqm0 \
-  libjpeg62-turbo \
-  # PostgreSQL
-  libpq5 \
-  postgresql-client \
-  # MySQL / MariaDB
-  mariadb-client \
-  # For Numpy
-  libatlas3-base \
-  # OCRmyPDF dependencies
-  tesseract-ocr \
-  tesseract-ocr-eng \
-  tesseract-ocr-deu \
-  tesseract-ocr-fra \
-  tesseract-ocr-ita \
-  tesseract-ocr-spa \
-  unpaper \
-  pngquant \
-  # pikepdf / qpdf
-  jbig2dec \
-  libxml2 \
-  libxslt1.1 \
-  libgnutls30 \
-  libqpdf29 \
-  qpdf \
-  # Mime type detection
-  file \
-  libmagic1 \
-  media-types \
-  zlib1g \
-  # Barcode splitter
-  libzbar0 \
-  poppler-utils \
-  # RapidFuzz on armv7
-  libatomic1"
-
-# Install basic runtime packages.
-# These change very infrequently
-RUN set -eux \
-  echo "Installing system packages" \
-    && apt-get update \
-    && apt-get install --yes --quiet --no-install-recommends ${RUNTIME_PACKAGES} \
-    && rm -rf /var/lib/apt/lists/* \
-  && echo "Installing supervisor" \
-    && python3 -m pip install --default-timeout=1000 --upgrade --no-cache-dir supervisor==4.2.5
-
-# Copy gunicorn config
-# Changes very infrequently
-WORKDIR /usr/src/paperless/
-
-COPY gunicorn.conf.py .
-
-# setup docker-specific things
-# These change sometimes, but rarely
-WORKDIR /usr/src/paperless/src/docker/
-
-COPY [ \
-  "docker/imagemagick-policy.xml", \
-  "docker/supervisord.conf", \
-  "docker/docker-entrypoint.sh", \
-  "docker/docker-prepare.sh", \
-  "docker/paperless_cmd.sh", \
-  "docker/wait-for-redis.py", \
-  "docker/env-from-file.sh", \
-  "docker/management_script.sh", \
-  "docker/flower-conditional.sh", \
-  "docker/install_management_commands.sh", \
-  "/usr/src/paperless/src/docker/" \
-]
-
-RUN set -eux \
-  && echo "Configuring ImageMagick" \
-    && mv imagemagick-policy.xml /etc/ImageMagick-6/policy.xml \
-  && echo "Configuring supervisord" \
-    && mkdir /var/log/supervisord /var/run/supervisord \
-    && mv supervisord.conf /etc/supervisord.conf \
-  && echo "Setting up Docker scripts" \
-    && mv docker-entrypoint.sh /sbin/docker-entrypoint.sh \
-    && chmod 755 /sbin/docker-entrypoint.sh \
-    && mv docker-prepare.sh /sbin/docker-prepare.sh \
-    && chmod 755 /sbin/docker-prepare.sh \
-    && mv wait-for-redis.py /sbin/wait-for-redis.py \
-    && chmod 755 /sbin/wait-for-redis.py \
-    && mv env-from-file.sh /sbin/env-from-file.sh \
-    && chmod 755 /sbin/env-from-file.sh \
-    && mv paperless_cmd.sh /usr/local/bin/paperless_cmd.sh \
-    && chmod 755 /usr/local/bin/paperless_cmd.sh \
-    && mv flower-conditional.sh /usr/local/bin/flower-conditional.sh \
-    && chmod 755 /usr/local/bin/flower-conditional.sh \
-  && echo "Installing managment commands" \
-    && chmod +x install_management_commands.sh \
-    && ./install_management_commands.sh
-
-# Buildx provided, must be defined to use though
-ARG TARGETARCH
-ARG TARGETVARIANT
-
-# Can be workflow provided, defaults set for manual building
-ARG JBIG2ENC_VERSION=0.29
-ARG QPDF_VERSION=11.3.0
-ARG PIKEPDF_VERSION=7.2.0
-ARG PSYCOPG2_VERSION=2.9.6
-
-# Install the built packages from the installer library images
-# These change sometimes
-RUN set -eux \
-  && echo "Getting binaries" \
-    && mkdir paperless-ngx \
-    && curl --fail --silent --show-error --output paperless-ngx.tar.gz --location https://github.com/paperless-ngx/builder/archive/58bb061b9b3b63009852d6d875f9a305d9ae6ac9.tar.gz \
-    && tar -xf paperless-ngx.tar.gz --directory paperless-ngx --strip-components=1 \
-    && cd paperless-ngx \
-    # Setting a specific revision ensures we know what this installed
-    # and ensures cache breaking on changes
-  && echo "Installing jbig2enc" \
-    && cp ./jbig2enc/${JBIG2ENC_VERSION}/${TARGETARCH}${TARGETVARIANT}/jbig2 /usr/local/bin/ \
-    && cp ./jbig2enc/${JBIG2ENC_VERSION}/${TARGETARCH}${TARGETVARIANT}/libjbig2enc* /usr/local/lib/ \
-    && chmod a+x /usr/local/bin/jbig2 \
-  && echo "Installing pikepdf and dependencies" \
-    && python3 -m pip install --no-cache-dir ./pikepdf/${PIKEPDF_VERSION}/${TARGETARCH}${TARGETVARIANT}/*.whl \
-    && python3 -m pip list \
-  && echo "Installing psycopg2" \
-    && python3 -m pip install --no-cache-dir ./psycopg2/${PSYCOPG2_VERSION}/${TARGETARCH}${TARGETVARIANT}/psycopg2*.whl \
-    && python3 -m pip list \
-  && echo "Cleaning up image layer" \
-    && cd ../ \
-    && rm -rf paperless-ngx \
-    && rm paperless-ngx.tar.gz
-
-WORKDIR /usr/src/paperless/src/
-
-# Python dependencies
-# Change pretty frequently
-COPY --from=pipenv-base /usr/src/pipenv/requirements.txt ./
-
-# Packages needed only for building a few quick Python
-# dependencies
-ARG BUILD_PACKAGES="\
-  build-essential \
-  git \
-  default-libmysqlclient-dev"
-
-# hadolint ignore=DL3042
-RUN --mount=type=cache,target=/root/.cache/pip/,id=pip-cache \
-  set -eux \
-  && echo "Installing build system packages" \
-    && apt-get update \
-    && apt-get install --yes --quiet --no-install-recommends ${BUILD_PACKAGES} \
-    && python3 -m pip install --no-cache-dir --upgrade wheel \
-  && echo "Installing Python requirements" \
-    && python3 -m pip install --default-timeout=1000 --requirement requirements.txt \
-  && echo "Installing NLTK data" \
-    && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" snowball_data \
-    && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" stopwords \
-    && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" punkt \
-  && echo "Cleaning up image" \
-    && apt-get -y purge ${BUILD_PACKAGES} \
-    && apt-get -y autoremove --purge \
-    && apt-get clean --yes \
-    && rm -rf /var/lib/apt/lists/* \
-    && rm -rf /tmp/* \
-    && rm -rf /var/tmp/* \
-    && rm -rf /var/cache/apt/archives/* \
-    && truncate -s 0 /var/log/*log
-
-# copy backend
-COPY ./src ./
-
-# copy frontend
-COPY --from=compile-frontend /src/src/documents/static/frontend/ ./documents/static/frontend/
-
-# add users, setup scripts
-# Mount the compiled frontend to expected location
-RUN set -eux \
-  && addgroup --gid 1000 paperless \
-  && useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
-  && chown -R paperless:paperless /usr/src/paperless \
-  && gosu paperless python3 manage.py collectstatic --clear --no-input --link \
-  && gosu paperless python3 manage.py compilemessages
-
-VOLUME ["/usr/src/paperless/data", \
-        "/usr/src/paperless/media", \
-        "/usr/src/paperless/consume", \
-        "/usr/src/paperless/export"]
+# Mount volumes
+VOLUME ["/usr/src/paperless/data", "/usr/src/paperless/media", "/consume"]
 
 ENTRYPOINT ["/sbin/docker-entrypoint.sh"]
-
-EXPOSE 8000
-
-CMD ["/usr/local/bin/paperless_cmd.sh"]
+CMD ["--help"]

Pipfile

@@ -1,109 +0,0 @@
-[[source]]
-url = "https://pypi.python.org/simple"
-verify_ssl = true
-name = "pypi"
-
-[[source]]
-url = "https://www.piwheels.org/simple"
-verify_ssl = true
-name = "piwheels"
-
-[packages]
-dateparser = "~=1.1"
-# WARNING: django does not use semver.
-#          Only patch versions are guaranteed to not introduce breaking changes.
-django = "~=4.1.9"
-django-cors-headers = "*"
-django-celery-results = "*"
-django-compression-middleware = "*"
-django-guardian = "*"
-django-extensions = "*"
-django-filter = "~=22.1"
-djangorestframework = "~=3.14"
-djangorestframework-guardian = "*"
-filelock = "*"
-gunicorn = "*"
-imap-tools = "*"
-langdetect = "*"
-pathvalidate = "*"
-pillow = "*"
-pikepdf = "*"
-python-gnupg = "*"
-python-dotenv = "*"
-python-dateutil = "*"
-python-magic = "*"
-python-ipware = "*"
-psycopg2 = "*"
-rapidfuzz = "*"
-redis = {extras = ["hiredis"], version = "*"}
-scikit-learn = "~=1.2"
-whitenoise = "~=6.3"
-watchdog = "~=2.2"
-whoosh="~=2.7"
-inotifyrecursive = "~=0.3"
-ocrmypdf = "~=14.0"
-tqdm = "*"
-tika-client = "*"
-channels = "~=4.0"
-channels-redis = "*"
-uvicorn = {extras = ["standard"], version = "*"}
-concurrent-log-handler = "*"
-pyzbar = "*"
-mysqlclient = "*"
-celery = {extras = ["redis"], version = "*"}
-setproctitle = "*"
-nltk = "*"
-pdf2image = "*"
-flower = "*"
-bleach = "*"
-zxing-cpp = {version = "*", platform_machine = "== 'x86_64'"}
-#
-# Packages locked due to issues (try to check if these are fixed in a release every so often)
-#
-# Pin this until piwheels is building 1.9 (see https://www.piwheels.org/project/scipy/)
-scipy = "==1.8.1"
-# v4 brings in extra dependencies for features not used here
-reportlab = "==3.6.12"
-# Pin this until piwheels is building a newer version (see https://www.piwheels.org/project/cryptography/)
-cryptography = "==40.0.1"
-httpx = "*"
-
-[dev-packages]
-# Linting
-black = "*"
-pre-commit = "*"
-ruff = "*"
-# Testing
-factory-boy = "*"
-pytest = "*"
-pytest-cov = "*"
-pytest-django = "*"
-pytest-httpx = "*"
-pytest-env = "*"
-pytest-sugar = "*"
-pytest-xdist = "*"
-"pdfminer.six" = "*"
-imagehash = "*"
-daphne = "*"
-# Documentation
-mkdocs-material = "*"
-
-[typing-dev]
-mypy = "*"
-types-Pillow = "*"
-django-filter-stubs = "*"
-types-python-dateutil = "*"
-djangorestframework-stubs = {extras= ["compatible-mypy"], version="*"}
-celery-types = "*"
-django-stubs = {extras= ["compatible-mypy"], version="*"}
-types-dateparser = "*"
-types-bleach = "*"
-types-humanfriendly = "*"
-types-redis = "*"
-types-tqdm = "*"
-types-Markdown = "*"
-types-Pygments = "*"
-types-backports = "*"
-types-colorama = "*"
-types-psycopg2 = "*"
-types-setuptools = "*"

README.md

@@ -1,109 +0,0 @@
-[![ci](https://github.com/paperless-ngx/paperless-ngx/workflows/ci/badge.svg)](https://github.com/paperless-ngx/paperless-ngx/actions)
-[![Crowdin](https://badges.crowdin.net/paperless-ngx/localized.svg)](https://crowdin.com/project/paperless-ngx)
-[![Documentation Status](https://img.shields.io/github/deployments/paperless-ngx/paperless-ngx/github-pages?label=docs)](https://docs.paperless-ngx.com)
-[![codecov](https://codecov.io/gh/paperless-ngx/paperless-ngx/branch/main/graph/badge.svg?token=VK6OUPJ3TY)](https://codecov.io/gh/paperless-ngx/paperless-ngx)
-[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/%23paperlessngx%3Amatrix.org)
-[![demo](https://cronitor.io/badges/ve7ItY/production/W5E_B9jkelG9ZbDiNHUPQEVH3MY.svg)](https://demo.paperless-ngx.com)
-
-<p align="center">
-<img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/Black%20logo%20-%20no%20background.png#gh-light-mode-only" width="50%" />
-<img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/White%20logo%20-%20no%20background.png#gh-dark-mode-only" width="50%" />
-</p>
-
-<!-- omit in toc -->
-
-# Paperless-ngx
-
-Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, _less paper_.
-
-Paperless-ngx forked from [paperless-ng](https://github.com/jonaswinkler/paperless-ng) to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support) Discussion of this transition can be found in issues
-[#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
-
-A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com) using login `demo` / `demo`. _Note: demo content is reset frequently and confidential information should not be uploaded._
-
-- [Features](#features)
-- [Getting started](#getting-started)
-- [Contributing](#contributing)
-  - [Community Support](#community-support)
-  - [Translation](#translation)
-  - [Feature Requests](#feature-requests)
-  - [Bugs](#bugs)
-- [Affiliated Projects](#affiliated-projects)
-- [Important Note](#important-note)
-
-# Features
-
-![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/assets/screenshots/documents-smallcards.png#gh-light-mode-only)
-![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/assets/screenshots/documents-smallcards-dark.png#gh-dark-mode-only)
-
-- Organize and index your scanned documents with tags, correspondents, types, and more.
-- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
-- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
-  - Office document support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
-- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
-- Single page application front end.
-  - Includes a dashboard that shows basic statistics and has document upload.
-  - Filtering by tags, correspondents, types, and more.
-  - Customizable views can be saved and displayed on the dashboard.
-- Full text search helps you find what you need.
-  - Auto completion suggests relevant words from your documents.
-  - Results are sorted by relevance to your search query.
-  - Highlighting shows you which parts of the document matched the query.
-  - Searching for similar documents ("More like this")
-- Email processing: Paperless adds documents from your email accounts.
-  - Configure multiple accounts and filters for each account.
-  - When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
-- Machine learning powered document matching.
-  - Paperless-ngx learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
-- Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel.
-- The integrated sanity checker makes sure that your document archive is in good health.
-- [More screenshots are available in the documentation](https://docs.paperless-ngx.com/#screenshots).
-
-# Getting started
-
-The easiest way to deploy paperless is docker-compose. The files in the [`/docker/compose` directory](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) are configured to pull the image from Github Packages.
-
-If you'd like to jump right in, you can configure a docker-compose environment with our install script:
-
-```bash
-bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
-```
-
-Alternatively, you can install the dependencies and setup apache and a database server yourself. The [documentation](https://docs.paperless-ngx.com/setup/#installation) has a step by step guide on how to do it.
-
-Migrating from Paperless-ng is easy, just drop in the new docker image! See the [documentation on migrating](https://docs.paperless-ngx.com/setup/#migrating-to-paperless-ngx) for more details.
-
-<!-- omit in toc -->
-
-### Documentation
-
-The documentation for Paperless-ngx is available at [https://docs.paperless-ngx.com](https://docs.paperless-ngx.com/).
-
-# Contributing
-
-If you feel like contributing to the project, please do! Bug fixes, enhancements, visual fixes etc. are always welcome. If you want to implement something big: Please start a discussion about that! The [documentation](https://docs.paperless-ngx.com/development/) has some basic information on how to get started.
-
-## Community Support
-
-People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the [Matrix Room](https://matrix.to/#/#paperless:adnidor.de). If you would like to contribute to the project on an ongoing basis there are multiple [teams](https://github.com/orgs/paperless-ngx/people) (frontend, ci/cd, etc) that could use your help so please reach out!
-
-## Translation
-
-Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you! More details can be found in [CONTRIBUTING.md](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md#translating-paperless-ngx).
-
-## Feature Requests
-
-Feature requests can be submitted via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests), you can search for existing ideas, add your own and vote for the ones you care about.
-
-## Bugs
-
-For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/issues) or [start a discussion](https://github.com/paperless-ngx/paperless-ngx/discussions) if you have questions.
-
-# Affiliated Projects
-
-Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and software that is compatible with Paperless-ngx.
-
-# Important Note
-
-> Document scanners are typically used to scan sensitive documents like your social insurance number, tax records, invoices, etc. **Paperless-ngx should never be run on an untrusted host** because information is stored in clear text without encryption. No guarantees are made regarding security (but we do try!) and you use the app at your own risk.
-> **The safest way to run Paperless-ngx is on a local server in your own home with backups in place**.

README.rst

@@ -0,0 +1,140 @@
+Paperless
+#########
+
+|Documentation|
+|Chat|
+|Travis|
+|Dependencies|
+
+Scan, index, and archive all of your paper documents
+
+I hate paper.  Environmental issues aside, it's a tech person's nightmare:
+
+* There's no search feature
+* It takes up physical space
+* Backups mean more paper
+
+In the past few months I've been bitten more than a few times by the problem
+of not having the right document around.  Sometimes I recycled a document I
+needed (who keeps water bills for two years?) and other times I just lost
+it... because paper.  I wrote this to make my life easier.
+
+
+How it Works
+============
+
+1. Buy a document scanner like `this one`_.
+2. Set it up to "scan to FTP" or something similar. It should be able to push
+   scanned images to a server without you having to do anything.  If your
+   scanner doesn't know how to automatically upload the file somewhere, you can
+   always do that manually.  Paperless doesn't care how the documents get into
+   its local consumption directory.
+3. Have the target server run the Paperless consumption script to OCR the PDF
+   and index it into a local database.
+4. Use the web frontend to sift through the database and find what you want.
+5. Download the PDF you need/want via the web interface and do whatever you
+   like with it.  You can even print it and send it as if it's the original.
+   In most cases, no one will care or notice.
+
+Here's what you get:
+
+.. image:: docs/_static/screenshot.png
+   :alt: The before and after
+   :target: docs/_static/screenshot.png
+
+
+Stability
+=========
+
+Paperless is still under active development (just look at the git commit
+history) so don't expect it to be 100% stable.  I'm using it for my own
+documents, but I'm crazy like that.  If you use this and it breaks something,
+you get to keep all the shiny pieces.
+
+
+Requirements
+============
+
+This is all really a quite simple, shiny, user-friendly wrapper around some very
+powerful tools.
+
+* `ImageMagick`_ converts the images between colour and greyscale.
+* `Tesseract`_ does the character recognition.
+* `Unpaper`_ despeckles and deskews the scanned image.
+* `GNU Privacy Guard`_ is used as the encryption backend.
+* `Python 3`_ is the language of the project.
+
+  * `Pillow`_ loads the image data as a python object to be used with PyOCR.
+  * `PyOCR`_ is a slick programmatic wrapper around tesseract.
+  * `Django`_ is the framework this project is written against.
+  * `Python-GNUPG`_ decrypts the PDFs on-the-fly to allow you to download
+    unencrypted files, leaving the encrypted ones on-disk.
+
+
+Documentation
+=============
+
+It's all available on `ReadTheDocs`_.
+
+
+Similar Projects
+================
+
+There's another project out there called `Mayan EDMS`_ that has a surprising
+amount of technical overlap with Paperless.  Also based on Django and using
+a consumer model with Tesseract and unpaper, Mayan EDMS is *much* more
+featureful and comes with a slick UI as well.  It may be that Paperless is
+better suited for low-resource environments (like a Rasberry Pi), but to be
+honest, this is just a guess as I haven't tested this myself.  One thing's
+for certain though, *Paperless* is a **much** better name.
+
+
+Important Note
+==============
+
+Document scanners are typically used to scan sensitive documents.  Things like
+your social insurance number, tax records, invoices, etc.  While paperless
+encrypts the original PDFs via the consumption script, the OCR'd text is *not*
+encrypted and is therefore stored in the clear (it needs to be searchable, so
+if someone has ideas on how to do that on encrypted data, I'm all ears).  This
+means that paperless should never be run on an untrusted host.  Instead, I
+recommend that if you do want to use it, run it locally on a server in your own
+home.
+
+
+Donations
+=========
+
+As with all Free software, the power is less in the finances and more in the
+collective efforts.  I really appreciate every pull request and bug report
+offered up by Paperless' users, so please keep that stuff coming.  If however,
+you're not one for coding/design/documentation, and would like to contribute
+financially, I won't say no ;-)
+
+The thing is, I'm doing ok for money, so I would instead ask you to donate to
+the `United Nations High Commissioner for Refugees`_.  They're doing important
+work and they need the money a lot more than I do.
+
+.. _this one: http://www.brother.ca/en-CA/Scanners/11/ProductDetail/ADS1500W?ProductDetail=productdetail
+.. _ImageMagick: http://imagemagick.org/
+.. _Tesseract: https://github.com/tesseract-ocr
+.. _Unpaper: https://www.flameeyes.eu/projects/unpaper
+.. _GNU Privacy Guard: https://gnupg.org/
+.. _Python 3: https://python.org/
+.. _Pillow: https://pypi.python.org/pypi/pillowfight/
+.. _PyOCR: https://github.com/jflesch/pyocr
+.. _Django: https://www.djangoproject.com/
+.. _Python-GNUPG: http://pythonhosted.org/python-gnupg/
+.. _ReadTheDocs: https://paperless.readthedocs.org/
+.. _Mayan EDMS: https://mayan.readthedocs.org/en/latest/
+.. _United Nations High Commissioner for Refugees: https://donate.unhcr.org/int-en/general
+.. |Documentation| image:: https://readthedocs.org/projects/paperless/badge/?version=latest
+   :alt: Read the documentation at https://paperless.readthedocs.org/
+   :target: https://paperless.readthedocs.org/
+.. |Chat| image:: https://badges.gitter.im/danielquinn/paperless.svg
+   :alt: Join the chat at https://gitter.im/danielquinn/paperless
+   :target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+.. |Travis| image:: https://travis-ci.org/danielquinn/paperless.svg?branch=master
+   :target: https://travis-ci.org/danielquinn/paperless
+.. |Dependencies| image:: https://www.versioneye.com/user/projects/57b33b81d9f1b00016faa500/badge.svg?style=flat-square
+   :target: https://www.versioneye.com/user/projects/57b33b81d9f1b00016faa500

Vagrantfile

@@ -0,0 +1,15 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+VAGRANT_API_VERSION = "2"
+Vagrant.configure(VAGRANT_API_VERSION) do |config|
+  config.vm.box = "ubuntu/trusty64"
+
+  # Provision using shell
+  config.vm.host_name = "dev.paperless"
+  config.vm.synced_folder ".", "/opt/paperless"
+  config.vm.provision "shell", path: "scripts/vagrant-provision"
+
+  # Networking details
+  config.vm.network "private_network", ip: "172.28.128.4"
+end

crowdin.yml

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

docker-compose.env.example

@@ -0,0 +1,15 @@
+# Environment variables to set for Paperless
+# Commented out variables will be replaced by a default within Paperless.
+
+# Passphrase Paperless uses to encrypt and decrypt your documents
+PAPERLESS_PASSPHRASE=CHANGE_ME
+
+# The amount of threads to use for text recognition
+# PAPERLESS_OCR_THREADS=4
+
+# Additional languages to install for text recognition
+# PAPERLESS_OCR_LANGUAGES=deu ita
+
+# You can change the default user and group id to a custom one
+# USERMAP_UID=1000
+# USERMAP_GID=1000

docker-compose.yml.example

@@ -0,0 +1,41 @@
+version: '2'
+
+services:
+    webserver:
+        image: pitkley/paperless
+        ports:
+            # You can adapt the port you want Paperless to listen on by
+            # modifying the part before the `:`.
+            - "8000:8000"
+        volumes:
+            - data:/usr/src/paperless/data
+            - media:/usr/src/paperless/media
+        env_file: docker-compose.env
+        # The reason the line is here is so that the webserver that doesn't do
+        # any text recognition and doesn't have to install unnecessary
+        # languages the user might have set in the env-file by overwriting the
+        # value with nothing.
+        environment:
+            - PAPERLESS_OCR_LANGUAGES=
+        command: ["runserver", "0.0.0.0:8000"]
+
+    consumer:
+        image: pitkley/paperless
+        volumes:
+            - data:/usr/src/paperless/data
+            - media:/usr/src/paperless/media
+            # You have to adapt the local path you want the consumption
+            # directory to mount to by modifying the part before the ':'.
+            - /path/to/arbitrary/place:/consume
+            # Likewise, you can add a local path to mount a directory for
+            # exporting. This is not strictly needed for paperless to
+            # function, only if you're exporting your files: uncomment
+            # it and fill in a local path if you know you're going to
+            # want to export your documents.
+            # - /path/to/another/arbitrary/place:/export
+        env_file: docker-compose.env
+        command: ["document_consumer"]
+
+volumes:
+    data:
+    media:

docker/compose/.env

@@ -1 +0,0 @@
-COMPOSE_PROJECT_NAME=paperless

docker/compose/docker-compose.ci-test.yml

@@ -1,25 +0,0 @@
-# docker-compose file for running paperless testing with actual gotenberg
-# and Tika containers for a more end to end test of the Tika related functionality
-# Can be used locally or by the CI to start the nessecary containers with the
-# correct networking for the tests
-
-version: "3.7"
-services:
-  gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.8
-    hostname: gotenberg
-    container_name: gotenberg
-    network_mode: host
-    restart: unless-stopped
-    # The gotenberg chromium route is used to convert .eml files. We do not
-    # want to allow external content like tracking pixels or even javascript.
-    command:
-      - "gotenberg"
-      - "--chromium-disable-javascript=true"
-      - "--chromium-allow-list=file:///tmp/.*"
-  tika:
-    image: ghcr.io/paperless-ngx/tika:latest
-    hostname: tika
-    container_name: tika
-    network_mode: host
-    restart: unless-stopped

docker/compose/docker-compose.env

@@ -1,42 +0,0 @@
-# The UID and GID of the user used to run paperless in the container. Set this
-# to your UID and GID on the host so that you have write access to the
-# consumption directory.
-#USERMAP_UID=1000
-#USERMAP_GID=1000
-
-# Additional languages to install for text recognition, separated by a
-# whitespace. Note that this is
-# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
-# language used for OCR.
-# The container installs English, German, Italian, Spanish and French by
-# default.
-# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
-# for available languages.
-#PAPERLESS_OCR_LANGUAGES=tur ces
-
-###############################################################################
-# Paperless-specific settings                                                 #
-###############################################################################
-
-# All settings defined in the paperless.conf.example can be used here. The
-# Docker setup does not use the configuration file.
-# A few commonly adjusted settings are provided below.
-
-# This is required if you will be exposing Paperless-ngx on a public domain
-# (if doing so please consider security measures such as reverse proxy)
-#PAPERLESS_URL=https://paperless.example.com
-
-# Adjust this key if you plan to make paperless available publicly. It should
-# be a very long sequence of random characters. You don't need to remember it.
-#PAPERLESS_SECRET_KEY=change-me
-
-# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
-#PAPERLESS_TIME_ZONE=America/Los_Angeles
-
-# The default language to use for OCR. Set this to the language most of your
-# documents are written in.
-#PAPERLESS_OCR_LANGUAGE=eng
-
-# 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

docker/compose/docker-compose.mariadb-tika.yml

@@ -1,103 +0,0 @@
-# docker-compose file for running paperless from the Docker Hub.
-# This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
-#
-# All compose files of paperless configure paperless in the following way:
-#
-# - Paperless is (re)started on system boot, if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# In addition to that, this docker-compose file adds the following optional
-# configurations:
-#
-# - Instead of SQLite (default), MariaDB is used as the database server.
-# - Apache Tika and Gotenberg servers are started with paperless and paperless
-#   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
-#   parts.
-#
-# To install and update paperless with this file, do the following:
-#
-# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
-#   and '.env' into a folder.
-# - Run 'docker-compose pull'.
-# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
-# - Run 'docker-compose up -d'.
-#
-# For more extensive installation and update instructions, refer to the
-# documentation.
-
-version: "3.4"
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - redisdata:/data
-
-  db:
-    image: docker.io/library/mariadb:10
-    restart: unless-stopped
-    volumes:
-      - dbdata:/var/lib/mysql
-    environment:
-      MARIADB_HOST: paperless
-      MARIADB_DATABASE: paperless
-      MARIADB_USER: paperless
-      MARIADB_PASSWORD: paperless
-      MARIADB_ROOT_PASSWORD: paperless
-
-  webserver:
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    restart: unless-stopped
-    depends_on:
-      - db
-      - broker
-      - gotenberg
-      - tika
-    ports:
-      - "8000:8000"
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:8000"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - data:/usr/src/paperless/data
-      - media:/usr/src/paperless/media
-      - ./export:/usr/src/paperless/export
-      - ./consume:/usr/src/paperless/consume
-    env_file: docker-compose.env
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-      PAPERLESS_DBENGINE: mariadb
-      PAPERLESS_DBHOST: db
-      PAPERLESS_DBUSER: paperless # only needed if non-default username
-      PAPERLESS_DBPASS: paperless # only needed if non-default password
-      PAPERLESS_DBPORT: 3306
-      PAPERLESS_TIKA_ENABLED: 1
-      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
-      PAPERLESS_TIKA_ENDPOINT: http://tika:9998
-
-  gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.8
-    restart: unless-stopped
-    # The gotenberg chromium route is used to convert .eml files. We do not
-    # want to allow external content like tracking pixels or even javascript.
-    command:
-      - "gotenberg"
-      - "--chromium-disable-javascript=true"
-      - "--chromium-allow-list=file:///tmp/.*"
-
-  tika:
-    image: ghcr.io/paperless-ngx/tika:latest
-    restart: unless-stopped
-
-volumes:
-  data:
-  media:
-  dbdata:
-  redisdata:

docker/compose/docker-compose.mariadb.yml

@@ -1,81 +0,0 @@
-# docker-compose file for running paperless from the Docker Hub.
-# This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
-#
-# All compose files of paperless configure paperless in the following way:
-#
-# - Paperless is (re)started on system boot, if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# In addition to that, this docker-compose file adds the following optional
-# configurations:
-#
-# - Instead of SQLite (default), MariaDB is used as the database server.
-#
-# To install and update paperless with this file, do the following:
-#
-# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
-#   and '.env' into a folder.
-# - Run 'docker-compose pull'.
-# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
-# - Run 'docker-compose up -d'.
-#
-# For more extensive installation and update instructions, refer to the
-# documentation.
-
-version: "3.4"
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - redisdata:/data
-
-  db:
-    image: docker.io/library/mariadb:10
-    restart: unless-stopped
-    volumes:
-      - dbdata:/var/lib/mysql
-    environment:
-      MARIADB_HOST: paperless
-      MARIADB_DATABASE: paperless
-      MARIADB_USER: paperless
-      MARIADB_PASSWORD: paperless
-      MARIADB_ROOT_PASSWORD: paperless
-
-  webserver:
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    restart: unless-stopped
-    depends_on:
-      - db
-      - broker
-    ports:
-      - "8000:8000"
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:8000"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - data:/usr/src/paperless/data
-      - media:/usr/src/paperless/media
-      - ./export:/usr/src/paperless/export
-      - ./consume:/usr/src/paperless/consume
-    env_file: docker-compose.env
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-      PAPERLESS_DBENGINE: mariadb
-      PAPERLESS_DBHOST: db
-      PAPERLESS_DBUSER: paperless # only needed if non-default username
-      PAPERLESS_DBPASS: paperless # only needed if non-default password
-      PAPERLESS_DBPORT: 3306
-
-
-volumes:
-  data:
-  media:
-  dbdata:
-  redisdata:

docker/compose/docker-compose.portainer.yml

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

docker/compose/docker-compose.postgres-tika.yml

@@ -1,98 +0,0 @@
-# docker-compose file for running paperless from the docker container registry.
-# This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
-#
-# All compose files of paperless configure paperless in the following way:
-#
-# - Paperless is (re)started on system boot, if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# In addition to that, this docker-compose file adds the following optional
-# configurations:
-#
-# - Instead of SQLite (default), PostgreSQL is used as the database server.
-# - Apache Tika and Gotenberg servers are started with paperless and paperless
-#   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
-#   parts.
-#
-# To install and update paperless with this file, do the following:
-#
-# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
-#   and '.env' into a folder.
-# - Run 'docker-compose pull'.
-# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
-# - Run 'docker-compose up -d'.
-#
-# For more extensive installation and update instructions, refer to the
-# documentation.
-
-version: "3.4"
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - redisdata:/data
-
-  db:
-    image: docker.io/library/postgres:15
-    restart: unless-stopped
-    volumes:
-      - pgdata:/var/lib/postgresql/data
-    environment:
-      POSTGRES_DB: paperless
-      POSTGRES_USER: paperless
-      POSTGRES_PASSWORD: paperless
-
-  webserver:
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    restart: unless-stopped
-    depends_on:
-      - db
-      - broker
-      - gotenberg
-      - tika
-    ports:
-      - "8000:8000"
-    healthcheck:
-      test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - data:/usr/src/paperless/data
-      - media:/usr/src/paperless/media
-      - ./export:/usr/src/paperless/export
-      - ./consume:/usr/src/paperless/consume
-    env_file: docker-compose.env
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-      PAPERLESS_DBHOST: db
-      PAPERLESS_TIKA_ENABLED: 1
-      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
-      PAPERLESS_TIKA_ENDPOINT: http://tika:9998
-
-  gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.8
-    restart: unless-stopped
-
-    # The gotenberg chromium route is used to convert .eml files. We do not
-    # want to allow external content like tracking pixels or even javascript.
-    command:
-      - "gotenberg"
-      - "--chromium-disable-javascript=true"
-      - "--chromium-allow-list=file:///tmp/.*"
-
-  tika:
-    image: ghcr.io/paperless-ngx/tika:latest
-    restart: unless-stopped
-
-volumes:
-  data:
-  media:
-  pgdata:
-  redisdata:

docker/compose/docker-compose.postgres.yml

@@ -1,75 +0,0 @@
-# docker-compose file for running paperless from the Docker Hub.
-# This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
-#
-# All compose files of paperless configure paperless in the following way:
-#
-# - Paperless is (re)started on system boot, if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# In addition to that, this docker-compose file adds the following optional
-# configurations:
-#
-# - Instead of SQLite (default), PostgreSQL is used as the database server.
-#
-# To install and update paperless with this file, do the following:
-#
-# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
-#   and '.env' into a folder.
-# - Run 'docker-compose pull'.
-# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
-# - Run 'docker-compose up -d'.
-#
-# For more extensive installation and update instructions, refer to the
-# documentation.
-
-version: "3.4"
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - redisdata:/data
-
-  db:
-    image: docker.io/library/postgres:15
-    restart: unless-stopped
-    volumes:
-      - pgdata:/var/lib/postgresql/data
-    environment:
-      POSTGRES_DB: paperless
-      POSTGRES_USER: paperless
-      POSTGRES_PASSWORD: paperless
-
-  webserver:
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    restart: unless-stopped
-    depends_on:
-      - db
-      - broker
-    ports:
-      - "8000:8000"
-    healthcheck:
-      test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - data:/usr/src/paperless/data
-      - media:/usr/src/paperless/media
-      - ./export:/usr/src/paperless/export
-      - ./consume:/usr/src/paperless/consume
-    env_file: docker-compose.env
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-      PAPERLESS_DBHOST: db
-
-
-volumes:
-  data:
-  media:
-  pgdata:
-  redisdata:

docker/compose/docker-compose.sqlite-tika.yml

@@ -1,85 +0,0 @@
-# docker-compose file for running paperless from the docker container registry.
-# This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
-# All compose files of paperless configure paperless in the following way:
-#
-# - Paperless is (re)started on system boot, if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# SQLite is used as the database. The SQLite file is stored in the data volume.
-#
-# In addition to that, this docker-compose file adds the following optional
-# configurations:
-#
-# - Apache Tika and Gotenberg servers are started with paperless and paperless
-#   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
-#   parts.
-#
-# To install and update paperless with this file, do the following:
-#
-# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
-#   and '.env' into a folder.
-# - Run 'docker-compose pull'.
-# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
-# - Run 'docker-compose up -d'.
-#
-# For more extensive installation and update instructions, refer to the
-# documentation.
-
-version: "3.4"
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - redisdata:/data
-
-  webserver:
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    restart: unless-stopped
-    depends_on:
-      - broker
-      - gotenberg
-      - tika
-    ports:
-      - "8000:8000"
-    healthcheck:
-      test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - data:/usr/src/paperless/data
-      - media:/usr/src/paperless/media
-      - ./export:/usr/src/paperless/export
-      - ./consume:/usr/src/paperless/consume
-    env_file: docker-compose.env
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-      PAPERLESS_TIKA_ENABLED: 1
-      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
-      PAPERLESS_TIKA_ENDPOINT: http://tika:9998
-
-  gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.8
-    restart: unless-stopped
-
-    # The gotenberg chromium route is used to convert .eml files. We do not
-    # want to allow external content like tracking pixels or even javascript.
-    command:
-      - "gotenberg"
-      - "--chromium-disable-javascript=true"
-      - "--chromium-allow-list=file:///tmp/.*"
-
-  tika:
-    image: ghcr.io/paperless-ngx/tika:latest
-    restart: unless-stopped
-
-volumes:
-  data:
-  media:
-  redisdata:

docker/compose/docker-compose.sqlite.yml

@@ -1,59 +0,0 @@
-# docker-compose file for running paperless from the Docker Hub.
-# This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
-#
-# All compose files of paperless configure paperless in the following way:
-#
-# - Paperless is (re)started on system boot, if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# SQLite is used as the database. The SQLite file is stored in the data volume.
-#
-# To install and update paperless with this file, do the following:
-#
-# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
-#   and '.env' into a folder.
-# - Run 'docker-compose pull'.
-# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
-# - Run 'docker-compose up -d'.
-#
-# For more extensive installation and update instructions, refer to the
-# documentation.
-
-version: "3.4"
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - redisdata:/data
-
-  webserver:
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    restart: unless-stopped
-    depends_on:
-      - broker
-    ports:
-      - "8000:8000"
-    healthcheck:
-      test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
-      interval: 30s
-      timeout: 10s
-      retries: 5
-    volumes:
-      - data:/usr/src/paperless/data
-      - media:/usr/src/paperless/media
-      - ./export:/usr/src/paperless/export
-      - ./consume:/usr/src/paperless/consume
-    env_file: docker-compose.env
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-
-
-volumes:
-  data:
-  media:
-  redisdata:

docker/docker-entrypoint.sh

@@ -1,168 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-# Source: https://github.com/sameersbn/docker-gitlab/
-map_uidgid() {
-	local -r usermap_original_uid=$(id -u paperless)
-	local -r usermap_original_gid=$(id -g paperless)
-	local -r usermap_new_uid=${USERMAP_UID:-$usermap_original_uid}
-	local -r usermap_new_gid=${USERMAP_GID:-${usermap_original_gid:-$usermap_new_uid}}
-	if [[ ${usermap_new_uid} != "${usermap_original_uid}" || ${usermap_new_gid} != "${usermap_original_gid}" ]]; then
-		echo "Mapping UID and GID for paperless:paperless to $usermap_new_uid:$usermap_new_gid"
-		usermod -o -u "${usermap_new_uid}" paperless
-		groupmod -o -g "${usermap_new_gid}" paperless
-	fi
-}
-
-map_folders() {
-	# Export these so they can be used in docker-prepare.sh
-	export DATA_DIR="${PAPERLESS_DATA_DIR:-/usr/src/paperless/data}"
-	export MEDIA_ROOT_DIR="${PAPERLESS_MEDIA_ROOT:-/usr/src/paperless/media}"
-	export CONSUME_DIR="${PAPERLESS_CONSUMPTION_DIR:-/usr/src/paperless/consume}"
-}
-
-custom_container_init() {
-	# Mostly borrowed from the LinuxServer.io base image
-	# https://github.com/linuxserver/docker-baseimage-ubuntu/tree/bionic/root/etc/cont-init.d
-	local -r custom_script_dir="/custom-cont-init.d"
-	# Tamper checking.
-	# Don't run files which are owned by anyone except root
-	# Don't run files which are writeable by others
-	if [ -d "${custom_script_dir}" ]; then
-		if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 ! -user root)" ]; then
-			echo "**** Potential tampering with custom scripts detected ****"
-			echo "**** The folder '${custom_script_dir}' must be owned by root ****"
-			return 0
-		fi
-		if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 -perm -o+w)" ]; then
-			echo "**** The folder '${custom_script_dir}' or some of contents have write permissions for others, which is a security risk. ****"
-			echo "**** Please review the permissions and their contents to make sure they are owned by root, and can only be modified by root. ****"
-			return 0
-		fi
-
-		# Make sure custom init directory has files in it
-		if [ -n "$(/bin/ls -A "${custom_script_dir}" 2>/dev/null)" ]; then
-			echo "[custom-init] files found in ${custom_script_dir} executing"
-			# Loop over files in the directory
-			for SCRIPT in "${custom_script_dir}"/*; do
-				NAME="$(basename "${SCRIPT}")"
-				if [ -f "${SCRIPT}" ]; then
-					echo "[custom-init] ${NAME}: executing..."
-					/bin/bash "${SCRIPT}"
-					echo "[custom-init] ${NAME}: exited $?"
-				elif [ ! -f "${SCRIPT}" ]; then
-					echo "[custom-init] ${NAME}: is not a file"
-				fi
-			done
-		else
-			echo "[custom-init] no custom files found exiting..."
-		fi
-
-	fi
-}
-
-initialize() {
-
-	# Setup environment from secrets before anything else
-	# Check for a version of this var with _FILE appended
-	# and convert the contents to the env var value
-	# Source it so export is persistent
-	# shellcheck disable=SC1091
-	source /sbin/env-from-file.sh
-
-	# Change the user and group IDs if needed
-	map_uidgid
-
-	# Check for overrides of certain folders
-	map_folders
-
-	local -r export_dir="/usr/src/paperless/export"
-
-	for dir in \
-		"${export_dir}" \
-		"${DATA_DIR}" "${DATA_DIR}/index" \
-		"${MEDIA_ROOT_DIR}" "${MEDIA_ROOT_DIR}/documents" "${MEDIA_ROOT_DIR}/documents/originals" "${MEDIA_ROOT_DIR}/documents/thumbnails" \
-		"${CONSUME_DIR}"; do
-		if [[ ! -d "${dir}" ]]; then
-			echo "Creating directory ${dir}"
-			mkdir "${dir}"
-		fi
-	done
-
-	local -r tmp_dir="/tmp/paperless"
-	echo "Creating directory ${tmp_dir}"
-	mkdir -p "${tmp_dir}"
-
-	set +e
-	echo "Adjusting permissions of paperless files. This may take a while."
-	chown -R paperless:paperless ${tmp_dir}
-	for dir in \
-		"${export_dir}" \
-		"${DATA_DIR}" \
-		"${MEDIA_ROOT_DIR}" \
-		"${CONSUME_DIR}"; do
-		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown paperless:paperless {} +
-	done
-	set -e
-
-	"${gosu_cmd[@]}" /sbin/docker-prepare.sh
-
-	# Leave this last thing
-	custom_container_init
-
-}
-
-install_languages() {
-	echo "Installing languages..."
-
-	read -ra langs <<<"$1"
-
-	# Check that it is not empty
-	if [ ${#langs[@]} -eq 0 ]; then
-		return
-	fi
-	apt-get update
-
-	for lang in "${langs[@]}"; do
-		pkg="tesseract-ocr-$lang"
-
-		if dpkg -s "$pkg" &>/dev/null; then
-			echo "Package $pkg already installed!"
-			continue
-		fi
-
-		if ! apt-cache show "$pkg" &>/dev/null; then
-			echo "Package $pkg not found! :("
-			continue
-		fi
-
-		echo "Installing package $pkg..."
-		if ! apt-get -y install "$pkg" &>/dev/null; then
-			echo "Could not install $pkg"
-			exit 1
-		fi
-	done
-}
-
-echo "Paperless-ngx docker container starting..."
-
-gosu_cmd=(gosu paperless)
-if [ "$(id -u)" == "$(id -u paperless)" ]; then
-	gosu_cmd=()
-fi
-
-# Install additional languages if specified
-if [[ -n "$PAPERLESS_OCR_LANGUAGES" ]]; then
-	install_languages "$PAPERLESS_OCR_LANGUAGES"
-fi
-
-initialize
-
-if [[ "$1" != "/"* ]]; then
-	echo Executing management command "$@"
-	exec "${gosu_cmd[@]}" python3 manage.py "$@"
-else
-	echo Executing "$@"
-	exec "$@"
-fi

docker/docker-prepare.sh

@@ -1,118 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-wait_for_postgres() {
-	local attempt_num=1
-	local -r max_attempts=5
-
-	echo "Waiting for PostgreSQL to start..."
-
-	local -r host="${PAPERLESS_DBHOST:-localhost}"
-	local -r port="${PAPERLESS_DBPORT:-5432}"
-
-	# Disable warning, host and port can't have spaces
-	# shellcheck disable=SC2086
-	while [ ! "$(pg_isready -h ${host} -p ${port})" ]; do
-
-		if [ $attempt_num -eq $max_attempts ]; then
-			echo "Unable to connect to database."
-			exit 1
-		else
-			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
-		fi
-
-		attempt_num=$(("$attempt_num" + 1))
-		sleep 5
-	done
-}
-
-wait_for_mariadb() {
-	echo "Waiting for MariaDB to start..."
-
-	local -r host="${PAPERLESS_DBHOST:=localhost}"
-	local -r port="${PAPERLESS_DBPORT:=3306}"
-
-	local attempt_num=1
-	local -r max_attempts=5
-
-	# Disable warning, host and port can't have spaces
-	# shellcheck disable=SC2086
-	while ! true > /dev/tcp/$host/$port; do
-
-		if [ $attempt_num -eq $max_attempts ]; then
-			echo "Unable to connect to database."
-			exit 1
-		else
-			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
-
-		fi
-
-		attempt_num=$(("$attempt_num" + 1))
-		sleep 5
-	done
-}
-
-wait_for_redis() {
-	# We use a Python script to send the Redis ping
-	# instead of installing redis-tools just for 1 thing
-	if ! python3 /sbin/wait-for-redis.py; then
-		exit 1
-	fi
-}
-
-migrations() {
-	(
-		# flock is in place to prevent multiple containers from doing migrations
-		# simultaneously. This also ensures that the db is ready when the command
-		# of the current container starts.
-		flock 200
-		echo "Apply database migrations..."
-		python3 manage.py migrate --skip-checks --no-input
-	) 200>"${DATA_DIR}/migration_lock"
-}
-
-django_checks() {
-	# Explicitly run the Django system checks
-	echo "Running Django checks"
-	python3 manage.py check
-}
-
-search_index() {
-
-	local -r index_version=6
-	local -r index_version_file=${DATA_DIR}/.index_version
-
-	if [[ (! -f "${index_version_file}") || $(<"${index_version_file}") != "$index_version" ]]; then
-		echo "Search index out of date. Updating..."
-		python3 manage.py document_index reindex --no-progress-bar
-		echo ${index_version} | tee "${index_version_file}" >/dev/null
-	fi
-}
-
-superuser() {
-	if [[ -n "${PAPERLESS_ADMIN_USER}" ]]; then
-		python3 manage.py manage_superuser
-	fi
-}
-
-do_work() {
-	if [[ "${PAPERLESS_DBENGINE}" == "mariadb" ]]; then
-		wait_for_mariadb
-	elif [[ -n "${PAPERLESS_DBHOST}" ]]; then
-		wait_for_postgres
-	fi
-
-	wait_for_redis
-
-	migrations
-
-	django_checks
-
-	search_index
-
-	superuser
-
-}
-
-do_work

docker/env-from-file.sh

@@ -1,42 +0,0 @@
-#!/usr/bin/env bash
-
-# Scans the environment variables for those with the suffix _FILE
-# When located, checks the file exists, and exports the contents
-# of the file as the same name, minus the suffix
-# This allows the use of Docker secrets or mounted files
-# to fill in any of the settings configurable via environment
-# variables
-
-set -eu
-
-for line in $(printenv)
-do
-	# Extract the name of the environment variable
-	env_name=${line%%=*}
-	# Check if it starts with "PAPERLESS_" and ends in "_FILE"
-	if [[ ${env_name} == PAPERLESS_*_FILE ]]; then
-		# This should have been named different..
-		if [[ ${env_name} == "PAPERLESS_OCR_SKIP_ARCHIVE_FILE" ]]; then
-			continue
-		fi
-		# Extract the value of the environment
-		env_value=${line#*=}
-
-		# Check the file exists
-		if [[ -f ${env_value} ]]; then
-
-			# Trim off the _FILE suffix
-			non_file_env_name=${env_name%"_FILE"}
-			echo "Setting ${non_file_env_name} from file"
-
-			# Reads the value from th file
-			val="$(< "${!env_name}")"
-
-			# Sets the normal name to the read file contents
-			export "${non_file_env_name}"="${val}"
-
-		else
-			echo "File ${env_value} referenced by ${env_name} doesn't exist"
-		fi
-	fi
-done

docker/flower-conditional.sh

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash
-
-echo "Checking if we should start flower..."
-
-if [[ -n  "${PAPERLESS_ENABLE_FLOWER}" ]]; then
-	# Small delay to allow celery to be up first
-	echo "Starting flower in 5s"
-	sleep 5
-	celery --app paperless flower --conf=/usr/src/paperless/src/paperless/flowerconfig.py
-else
-	echo "Not starting flower"
-fi

docker/imagemagick-policy.xml

@@ -1,96 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE policymap [
-  <!ELEMENT policymap (policy)+>
-  <!ATTLIST policymap xmlns CDATA #FIXED ''>
-  <!ELEMENT policy EMPTY>
-  <!ATTLIST policy xmlns CDATA #FIXED '' domain NMTOKEN #REQUIRED
-    name NMTOKEN #IMPLIED pattern CDATA #IMPLIED rights NMTOKEN #IMPLIED
-    stealth NMTOKEN #IMPLIED value CDATA #IMPLIED>
-]>
-<!--
-  Configure ImageMagick policies.
-
-  Domains include system, delegate, coder, filter, path, or resource.
-
-  Rights include none, read, write, execute and all.  Use | to combine them,
-  for example: "read | write" to permit read from, or write to, a path.
-
-  Use a glob expression as a pattern.
-
-  Suppose we do not want users to process MPEG video images:
-
-    <policy domain="delegate" rights="none" pattern="mpeg:decode" />
-
-  Here we do not want users reading images from HTTP:
-
-    <policy domain="coder" rights="none" pattern="HTTP" />
-
-  The /repository file system is restricted to read only.  We use a glob
-  expression to match all paths that start with /repository:
-
-    <policy domain="path" rights="read" pattern="/repository/*" />
-
-  Lets prevent users from executing any image filters:
-
-    <policy domain="filter" rights="none" pattern="*" />
-
-  Any large image is cached to disk rather than memory:
-
-    <policy domain="resource" name="area" value="1GP"/>
-
-  Define arguments for the memory, map, area, width, height and disk resources
-  with SI prefixes (.e.g 100MB).  In addition, resource policies are maximums
-  for each instance of ImageMagick (e.g. policy memory limit 1GB, -limit 2GB
-  exceeds policy maximum so memory limit is 1GB).
-
-  Rules are processed in order.  Here we want to restrict ImageMagick to only
-  read or write a small subset of proven web-safe image types:
-
-    <policy domain="delegate" rights="none" pattern="*" />
-    <policy domain="filter" rights="none" pattern="*" />
-    <policy domain="coder" rights="none" pattern="*" />
-    <policy domain="coder" rights="read|write" pattern="{GIF,JPEG,PNG,WEBP}" />
--->
-<policymap>
-  <!-- <policy domain="system" name="shred" value="2"/> -->
-  <!-- <policy domain="system" name="precision" value="6"/> -->
-  <!-- <policy domain="system" name="memory-map" value="anonymous"/> -->
-  <!-- <policy domain="system" name="max-memory-request" value="256MiB"/> -->
-  <!-- <policy domain="resource" name="temporary-path" value="/tmp"/> -->
-  <policy domain="resource" name="memory" value="256MiB"/>
-  <policy domain="resource" name="map" value="512MiB"/>
-  <policy domain="resource" name="width" value="16KP"/>
-  <policy domain="resource" name="height" value="16KP"/>
-  <!-- <policy domain="resource" name="list-length" value="128"/> -->
-  <policy domain="resource" name="area" value="128MB"/>
-  <policy domain="resource" name="disk" value="1GiB"/>
-  <!-- <policy domain="resource" name="file" value="768"/> -->
-  <!-- <policy domain="resource" name="thread" value="4"/> -->
-  <!-- <policy domain="resource" name="throttle" value="0"/> -->
-  <!-- <policy domain="resource" name="time" value="3600"/> -->
-  <!-- <policy domain="coder" rights="none" pattern="MVG" /> -->
-  <!-- <policy domain="module" rights="none" pattern="{PS,PDF,XPS}" /> -->
-  <!-- <policy domain="delegate" rights="none" pattern="HTTPS" /> -->
-  <!-- <policy domain="path" rights="none" pattern="@*" /> -->
-  <!-- <policy domain="cache" name="memory-map" value="anonymous"/> -->
-  <!-- <policy domain="cache" name="synchronize" value="True"/> -->
-  <!-- <policy domain="cache" name="shared-secret" value="passphrase" stealth="true"/> -->
-  <!-- <policy domain="system" name="pixel-cache-memory" value="anonymous"/> -->
-  <!-- <policy domain="system" name="shred" value="2"/> -->
-  <!-- <policy domain="system" name="precision" value="6"/> -->
-  <!-- not needed due to the need to use explicitly by mvg: -->
-  <!-- <policy domain="delegate" rights="none" pattern="MVG" /> -->
-  <!-- use curl -->
-  <policy domain="delegate" rights="none" pattern="URL" />
-  <policy domain="delegate" rights="none" pattern="HTTPS" />
-  <policy domain="delegate" rights="none" pattern="HTTP" />
-  <!-- in order to avoid to get image with password text -->
-  <policy domain="path" rights="none" pattern="@*"/>
-  <!-- disable ghostscript format types -->
-  <policy domain="coder" rights="none" pattern="PS" />
-  <policy domain="coder" rights="none" pattern="PS2" />
-  <policy domain="coder" rights="none" pattern="PS3" />
-  <policy domain="coder" rights="none" pattern="EPS" />
-  <policy domain="coder" rights="read|write" pattern="PDF" />
-  <policy domain="coder" rights="none" pattern="XPS" />
-</policymap>

docker/install_management_commands.sh

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

docker/management_script.sh

@@ -1,18 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-cd /usr/src/paperless/src/
-# This ensures environment is setup
-# shellcheck disable=SC1091
-source /sbin/env-from-file.sh
-
-if [[ $(id -u) == 0 ]] ;
-then
-	gosu paperless python3 manage.py management_command "$@"
-elif [[ $(id -un) == "paperless" ]] ;
-then
-	python3 manage.py management_command "$@"
-else
-	echo "Unknown user."
-fi

docker/paperless_cmd.sh

@@ -1,15 +0,0 @@
-#!/usr/bin/env bash
-
-rootless_args=()
-if [ "$(id -u)" == "$(id -u paperless)" ]; then
-	rootless_args=(
-		--user
-		paperless
-		--logfile
-		supervisord.log
-		--pidfile
-		supervisord.pid
-	)
-fi
-
-exec /usr/local/bin/supervisord -c /etc/supervisord.conf "${rootless_args[@]}"

docker/supervisord.conf

@@ -1,65 +0,0 @@
-[supervisord]
-nodaemon=true               ; start in foreground if true; default false
-logfile=/var/log/supervisord/supervisord.log ; main log file; default $CWD/supervisord.log
-pidfile=/var/run/supervisord/supervisord.pid ; supervisord pidfile; default supervisord.pid
-logfile_maxbytes=50MB        ; max main logfile bytes b4 rotation; default 50MB
-logfile_backups=10           ; # of main logfile backups; 0 means none, default 10
-loglevel=info                ; log level; default info; others: debug,warn,trace
-user=root
-
-[program:gunicorn]
-command=gunicorn -c /usr/src/paperless/gunicorn.conf.py paperless.asgi:application
-user=paperless
-priority = 1
-stdout_logfile=/dev/stdout
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/stderr
-stderr_logfile_maxbytes=0
-environment = HOME="/usr/src/paperless",USER="paperless"
-
-[program:consumer]
-command=python3 manage.py document_consumer
-user=paperless
-stopsignal=INT
-priority = 20
-stdout_logfile=/dev/stdout
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/stderr
-stderr_logfile_maxbytes=0
-environment = HOME="/usr/src/paperless",USER="paperless"
-
-[program:celery]
-
-command = celery --app paperless worker --loglevel INFO --without-mingle --without-gossip
-user=paperless
-stopasgroup = true
-stopwaitsecs = 60
-priority = 5
-stdout_logfile=/dev/stdout
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/stderr
-stderr_logfile_maxbytes=0
-environment = HOME="/usr/src/paperless",USER="paperless"
-
-[program:celery-beat]
-
-command = celery --app paperless beat --loglevel INFO
-user=paperless
-stopasgroup = true
-priority = 10
-stdout_logfile=/dev/stdout
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/stderr
-stderr_logfile_maxbytes=0
-environment = HOME="/usr/src/paperless",USER="paperless"
-
-[program:celery-flower]
-command = /usr/local/bin/flower-conditional.sh
-user = paperless
-startsecs = 0
-priority = 40
-stdout_logfile=/dev/stdout
-stdout_logfile_maxbytes=0
-stderr_logfile=/dev/stderr
-stderr_logfile_maxbytes=0
-environment = HOME="/usr/src/paperless",USER="paperless"

docker/wait-for-redis.py

@@ -1,43 +0,0 @@
-#!/usr/bin/env python3
-"""
-Simple script which attempts to ping the Redis broker as set in the environment for
-a certain number of times, waiting a little bit in between
-
-"""
-import os
-import sys
-import time
-from typing import Final
-
-from redis import Redis
-
-if __name__ == "__main__":
-    MAX_RETRY_COUNT: Final[int] = 5
-    RETRY_SLEEP_SECONDS: Final[int] = 5
-
-    REDIS_URL: Final[str] = os.getenv("PAPERLESS_REDIS", "redis://localhost:6379")
-
-    print("Waiting for Redis...", flush=True)
-
-    attempt = 0
-    with Redis.from_url(url=REDIS_URL) as client:
-        while attempt < MAX_RETRY_COUNT:
-            try:
-                client.ping()
-                break
-            except Exception as e:
-                print(
-                    f"Redis ping #{attempt} failed.\n"
-                    f"Error: {e!s}.\n"
-                    f"Waiting {RETRY_SLEEP_SECONDS}s",
-                    flush=True,
-                )
-                time.sleep(RETRY_SLEEP_SECONDS)
-                attempt += 1
-
-    if attempt >= MAX_RETRY_COUNT:
-        print("Failed to connect to redis using environment variable PAPERLESS_REDIS.")
-        sys.exit(os.EX_UNAVAILABLE)
-    else:
-        print("Connected to Redis broker.")
-        sys.exit(os.EX_OK)

docs/Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.5.1
+MAINTAINER Pit Kleyersburg <pitkley@googlemail.com>
+
+# Install Sphinx and Pygments
+RUN pip install Sphinx Pygments
+
+# Setup directories, copy data
+RUN mkdir /build
+COPY . /build
+WORKDIR /build/docs
+
+# Build documentation
+RUN make html
+
+# Start webserver
+WORKDIR /build/docs/_build/html
+EXPOSE 8000/tcp
+CMD ["python3", "-m", "http.server"]

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RIPEAtlasToolsMagellan.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RIPEAtlasToolsMagellan.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/RIPEAtlasToolsMagellan"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RIPEAtlasToolsMagellan"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/_static/custom.css

@@ -0,0 +1,14 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+  .wy-table-responsive table td {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+  }
+
+  .wy-table-responsive {
+    overflow: visible !important;
+  }
+
+}

docs/administration.md

@@ -1,568 +0,0 @@
-# Administration
-
-## Making backups {#backup}
-
-Multiple options exist for making backups of your paperless instance,
-depending on how you installed paperless.
-
-Before making backups, make sure that paperless is not running.
-
-Options available to any installation of paperless:
-
-- Use the [document exporter](#exporter). The document exporter exports all your documents,
-  thumbnails and metadata to a specific folder. You may import your
-  documents into a fresh instance of paperless again or store your
-  documents in another DMS with this export.
-- The document exporter is also able to update an already existing
-  export. Therefore, incremental backups with `rsync` are entirely
-  possible.
-
-!!! caution
-
-    You cannot import the export generated with one version of paperless in
-    a different version of paperless. The export contains an exact image of
-    the database, and migrations may change the database layout.
-
-Options available to docker installations:
-
-- Backup the docker volumes. These usually reside within
-  `/var/lib/docker/volumes` on the host and you need to be root in
-  order to access them.
-
-  Paperless uses 4 volumes:
-
-  - `paperless_media`: This is where your documents are stored.
-  - `paperless_data`: This is where auxillary data is stored. This
-    folder also contains the SQLite database, if you use it.
-  - `paperless_pgdata`: Exists only if you use PostgreSQL and
-    contains the database.
-  - `paperless_dbdata`: Exists only if you use MariaDB and contains
-    the database.
-
-Options available to bare-metal and non-docker installations:
-
-- Backup the entire paperless folder. This ensures that if your
-  paperless instance crashes at some point or your disk fails, you can
-  simply copy the folder back into place and it works.
-
-  When using PostgreSQL or MariaDB, you'll also have to backup the
-  database.
-
-### Restoring {#migrating-restoring}
-
-## Updating Paperless {#updating}
-
-### Docker Route {#docker-updating}
-
-If a new release of paperless-ngx is available, upgrading depends on how
-you installed paperless-ngx in the first place. The releases are
-available at the [release
-page](https://github.com/paperless-ngx/paperless-ngx/releases).
-
-First of all, ensure that paperless is stopped.
-
-```shell-session
-$ cd /path/to/paperless
-$ docker-compose down
-```
-
-After that, [make a backup](#backup).
-
-1. If you pull the image from the docker hub, all you need to do is:
-
-   ```shell-session
-   $ docker-compose pull
-   $ docker-compose up
-   ```
-
-   The docker-compose files refer to the `latest` version, which is
-   always the latest stable release.
-
-2. If you built the image yourself, do the following:
-
-   ```shell-session
-   $ git pull
-   $ docker-compose build
-   $ docker-compose up
-   ```
-
-Running `docker-compose up` will also apply any new database migrations.
-If you see everything working, press CTRL+C once to gracefully stop
-paperless. Then you can start paperless-ngx with `-d` to have it run in
-the background.
-
-!!! note
-
-    In version 0.9.14, the update process was changed. In 0.9.13 and
-    earlier, the docker-compose files specified exact versions and pull
-    won't automatically update to newer versions. In order to enable
-    updates as described above, either get the new `docker-compose.yml`
-    file from
-    [here](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
-    or edit the `docker-compose.yml` file, find the line that says
-
-    ```
-    image: ghcr.io/paperless-ngx/paperless-ngx:0.9.x
-    ```
-
-    and replace the version with `latest`:
-
-    ```
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    ```
-
-!!! note
-
-    In version 1.7.1 and onwards, the Docker image can now be pinned to a
-    release series. This is often combined with automatic updaters such as
-    Watchtower to allow safer unattended upgrading to new bugfix releases
-    only. It is still recommended to always review release notes before
-    upgrading. To pin your install to a release series, edit the
-    `docker-compose.yml` find the line that says
-
-    ```
-    image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    ```
-
-    and replace the version with the series you want to track, for
-    example:
-
-    ```
-    image: ghcr.io/paperless-ngx/paperless-ngx:1.7
-    ```
-
-### Bare Metal Route {#bare-metal-updating}
-
-After grabbing the new release and unpacking the contents, do the
-following:
-
-1.  Update dependencies. New paperless version may require additional
-    dependencies. The dependencies required are listed in the section
-    about
-    [bare metal installations](/setup#bare_metal).
-
-2.  Update python requirements. Keep in mind to activate your virtual
-    environment before that, if you use one.
-
-    ```shell-session
-    $ pip install -r requirements.txt
-    ```
-
-    !!! note
-
-        At times, some dependencies will be removed from requirements.txt.
-        Comparing the versions and removing no longer needed dependencies
-        will keep your system or virtual environment clean and prevent
-        possible conflicts.
-
-3.  Migrate the database.
-
-    ```shell-session
-    $ cd src
-    $ python3 manage.py migrate # (1)
-    ```
-
-    1.  Including `sudo -Hu <paperless_user>` may be required
-
-    This might not actually do anything. Not every new paperless version
-    comes with new database migrations.
-
-### Database Upgrades
-
-In general, paperless does not require a specific version of PostgreSQL or MariaDB and it is
-safe to update them to newer versions. However, you should always take a backup and follow
-the instructions from your database's documentation for how to upgrade between major versions.
-
-For PostgreSQL, refer to [Upgrading a PostgreSQL Cluster](https://www.postgresql.org/docs/current/upgrading.html).
-
-For MariaDB, refer to [Upgrading MariaDB](https://mariadb.com/kb/en/upgrading/)
-
-## Downgrading Paperless {#downgrade-paperless}
-
-Downgrades are possible. However, some updates also contain database
-migrations (these change the layout of the database and may move data).
-In order to move back from a version that applied database migrations,
-you'll have to revert the database migration _before_ downgrading, and
-then downgrade paperless.
-
-This table lists the compatible versions for each database migration
-number.
-
-| Migration number | Version range   |
-| ---------------- | --------------- |
-| 1011             | 1.0.0           |
-| 1012             | 1.1.0 - 1.2.1   |
-| 1014             | 1.3.0 - 1.3.1   |
-| 1016             | 1.3.2 - current |
-
-Execute the following management command to migrate your database:
-
-```shell-session
-$ python3 manage.py migrate documents <migration number>
-```
-
-!!! note
-
-    Some migrations cannot be undone. The command will issue errors if that
-    happens.
-
-## Management utilities {#management-commands}
-
-Paperless comes with some management commands that perform various
-maintenance tasks on your paperless instance. You can invoke these
-commands in the following way:
-
-With docker-compose, while paperless is running:
-
-```shell-session
-$ cd /path/to/paperless
-$ docker-compose exec webserver <command> <arguments>
-```
-
-With docker, while paperless is running:
-
-```shell-session
-$ docker exec -it <container-name> <command> <arguments>
-```
-
-Bare metal:
-
-```shell-session
-$ cd /path/to/paperless/src
-$ python3 manage.py <command> <arguments> # (1)
-```
-
-1.  Including `sudo -Hu <paperless_user>` may be required
-
-All commands have built-in help, which can be accessed by executing them
-with the argument `--help`.
-
-### Document exporter {#exporter}
-
-The document exporter exports all your data from paperless into a folder
-for backup or migration to another DMS.
-
-If you use the document exporter within a cronjob to backup your data
-you might use the `-T` flag behind exec to suppress "The input device
-is not a TTY" errors. For example:
-`docker-compose exec -T webserver document_exporter ../export`
-
-```
-document_exporter target [-c] [-d] [-f] [-na] [-nt] [-p] [-sm] [-z]
-
-optional arguments:
--c, --compare-checksums
--d, --delete
--f, --use-filename-format
--na, --no-archive
--nt, --no-thumbnail
--p, --use-folder-prefix
--sm, --split-manifest
--z  --zip
-```
-
-`target` is a folder to which the data gets written. This includes
-documents, thumbnails and a `manifest.json` file. The manifest contains
-all metadata from the database (correspondents, tags, etc).
-
-When you use the provided docker compose script, specify `../export` as
-the target. This path inside the container is automatically mounted on
-your host on the folder `export`.
-
-If the target directory already exists and contains files, paperless
-will assume that the contents of the export directory are a previous
-export and will attempt to update the previous export. Paperless will
-only export changed and added files. Paperless determines whether a file
-has changed by inspecting the file attributes "date/time modified" and
-"size". If that does not work out for you, specify `-c` or
-`--compare-checksums` and paperless will attempt to compare file
-checksums instead. This is slower.
-
-Paperless will not remove any existing files in the export directory. If
-you want paperless to also remove files that do not belong to the
-current export such as files from deleted documents, specify `-d` or `--delete`.
-Be careful when pointing paperless to a directory that already contains
-other files.
-
-The filenames generated by this command follow the format
-`[date created] [correspondent] [title].[extension]`. If you want
-paperless to use `PAPERLESS_FILENAME_FORMAT` for exported filenames
-instead, specify `-f` or `--use-filename-format`.
-
-If `-na` or `--no-archive` is provided, no archive files will be exported,
-only the original files.
-
-If `-nt` or `--no-thumbnail` is provided, thumbnail files will not be exported.
-
-!!! note
-
-    When using the `-na`/`--no-archive` or `-nt`/`--no-thumbnail` options
-    the exporter will not output these files for backup.  After importing,
-    the [sanity checker](#sanity-checker) will warn about missing thumbnails and archive files
-    until they are regenerated with `document_thumbnails` or [`document_archiver`](#archiver).
-    It can make sense to omit these files from backup as their content and checksum
-    can change (new archiver algorithm) and may then cause additional used space in
-    a deduplicated backup.
-
-If `-p` or `--use-folder-prefix` is provided, files will be exported
-in dedicated folders according to their nature: `archive`, `originals`,
-`thumbnails` or `json`
-
-If `-sm` or `--split-manifest` is provided, information about document
-will be placed in individual json files, instead of a single JSON file. The main
-manifest.json will still contain application wide information (e.g. tags, correspondent,
-documenttype, etc)
-
-If `-z` or `--zip` is provided, the export will be a zip file
-in the target directory, named according to the current date.
-
-!!! warning
-
-    If exporting with the file name format, there may be errors due to
-    your operating system's maximum path lengths.  Try adjusting the export
-    target or consider not using the filename format.
-
-### Document importer {#importer}
-
-The document importer takes the export produced by the [Document
-exporter](#exporter) and imports it into paperless.
-
-The importer works just like the exporter. You point it at a directory,
-and the script does the rest of the work:
-
-```
-document_importer source
-```
-
-When you use the provided docker compose script, put the export inside
-the `export` folder in your paperless source directory. Specify
-`../export` as the `source`.
-
-!!! note
-
-    Importing from a previous version of Paperless may work, but for best
-    results it is suggested to match the versions.
-
-### Document retagger {#retagger}
-
-Say you've imported a few hundred documents and now want to introduce a
-tag or set up a new correspondent, and apply its matching to all of the
-currently-imported docs. This problem is common enough that there are
-tools for it.
-
-```
-document_retagger [-h] [-c] [-T] [-t] [-i] [--use-first] [-f]
-
-optional arguments:
--c, --correspondent
--T, --tags
--t, --document_type
--s, --storage_path
--i, --inbox-only
---use-first
--f, --overwrite
-```
-
-Run this after changing or adding matching rules. It'll loop over all
-of the documents in your database and attempt to match documents
-according to the new rules.
-
-Specify any combination of `-c`, `-T`, `-t` and `-s` to have the
-retagger perform matching of the specified metadata type. If you don't
-specify any of these options, the document retagger won't do anything.
-
-Specify `-i` to have the document retagger work on documents tagged with
-inbox tags only. This is useful when you don't want to mess with your
-already processed documents.
-
-When multiple document types or correspondents match a single document,
-the retagger won't assign these to the document. Specify `--use-first`
-to override this behavior and just use the first correspondent or type
-it finds. This option does not apply to tags, since any amount of tags
-can be applied to a document.
-
-Finally, `-f` specifies that you wish to overwrite already assigned
-correspondents, types and/or tags. The default behavior is to not assign
-correspondents and types to documents that have this data already
-assigned. `-f` works differently for tags: By default, only additional
-tags get added to documents, no tags will be removed. With `-f`, tags
-that don't match a document anymore get removed as well.
-
-### Managing the Automatic matching algorithm
-
-The _Auto_ matching algorithm requires a trained neural network to work.
-This network needs to be updated whenever somethings in your data
-changes. The docker image takes care of that automatically with the task
-scheduler. You can manually renew the classifier by invoking the
-following management command:
-
-```
-document_create_classifier
-```
-
-This command takes no arguments.
-
-### Document thumbnails {#thumbnails}
-
-Use this command to re-create document thumbnails. Optionally include the ` --document {id}` option to generate thumbnails for a specific document only.
-
-```
-document_thumbnails
-```
-
-### Managing the document search index {#index}
-
-The document search index is responsible for delivering search results
-for the website. The document index is automatically updated whenever
-documents get added to, changed, or removed from paperless. However, if
-the search yields non-existing documents or won't find anything, you
-may need to recreate the index manually.
-
-```
-document_index {reindex,optimize}
-```
-
-Specify `reindex` to have the index created from scratch. This may take
-some time.
-
-Specify `optimize` to optimize the index. This updates certain aspects
-of the index and usually makes queries faster and also ensures that the
-autocompletion works properly. This command is regularly invoked by the
-task scheduler.
-
-### Managing filenames {#renamer}
-
-If you use paperless' feature to
-[assign custom filenames to your documents](/advanced_usage#file-name-handling), you can use this command to move all your files after
-changing the naming scheme.
-
-!!! warning
-
-    Since this command moves your documents, it is advised to do a backup
-    beforehand. The renaming logic is robust and will never overwrite or
-    delete a file, but you can't ever be careful enough.
-
-```
-document_renamer
-```
-
-The command takes no arguments and processes all your documents at once.
-
-Learn how to use
-[Management Utilities](#management-commands).
-
-### Sanity checker {#sanity-checker}
-
-Paperless has a built-in sanity checker that inspects your document
-collection for issues.
-
-The issues detected by the sanity checker are as follows:
-
-- Missing original files.
-- Missing archive files.
-- Inaccessible original files due to improper permissions.
-- Inaccessible archive files due to improper permissions.
-- Corrupted original documents by comparing their checksum against
-  what is stored in the database.
-- Corrupted archive documents by comparing their checksum against what
-  is stored in the database.
-- Missing thumbnails.
-- Inaccessible thumbnails due to improper permissions.
-- Documents without any content (warning).
-- Orphaned files in the media directory (warning). These are files
-  that are not referenced by any document im paperless.
-
-```
-document_sanity_checker
-```
-
-The command takes no arguments. Depending on the size of your document
-archive, this may take some time.
-
-### Fetching e-mail
-
-Paperless automatically fetches your e-mail every 10 minutes by default.
-If you want to invoke the email consumer manually, call the following
-management command:
-
-```
-mail_fetcher
-```
-
-The command takes no arguments and processes all your mail accounts and
-rules.
-
-!!! tip
-
-    To use OAuth access tokens for mail fetching,
-    select the box to indicate the password is actually
-    a token when creating or editing a mail account. The
-    details for creating a token depend on your email
-    provider.
-
-### Creating archived documents {#archiver}
-
-Paperless stores archived PDF/A documents alongside your original
-documents. These archived documents will also contain selectable text
-for image-only originals. These documents are derived from the
-originals, which are always stored unmodified. If coming from an earlier
-version of paperless, your documents won't have archived versions.
-
-This command creates PDF/A documents for your documents.
-
-```
-document_archiver --overwrite --document <id>
-```
-
-This command will only attempt to create archived documents when no
-archived document exists yet, unless `--overwrite` is specified. If
-`--document <id>` is specified, the archiver will only process that
-document.
-
-!!! note
-
-    This command essentially performs OCR on all your documents again,
-    according to your settings. If you run this with
-    `PAPERLESS_OCR_MODE=redo`, it will potentially run for a very long time.
-    You can cancel the command at any time, since this command will skip
-    already archived versions the next time it is run.
-
-!!! note
-
-    Some documents will cause errors and cannot be converted into PDF/A
-    documents, such as encrypted PDF documents. The archiver will skip over
-    these documents each time it sees them.
-
-### Managing encryption {#encryption}
-
-Documents can be stored in Paperless using GnuPG encryption.
-
-!!! warning
-
-    Encryption is deprecated since [paperless-ng 0.9](/changelog#paperless-ng-090) and doesn't really
-    provide any additional security, since you have to store the passphrase
-    in a configuration file on the same system as the encrypted documents
-    for paperless to work. Furthermore, the entire text content of the
-    documents is stored plain in the database, even if your documents are
-    encrypted. Filenames are not encrypted as well.
-
-    Also, the web server provides transparent access to your encrypted
-    documents.
-
-    Consider running paperless on an encrypted filesystem instead, which
-    will then at least provide security against physical hardware theft.
-
-#### Enabling encryption
-
-Enabling encryption is no longer supported.
-
-#### Disabling encryption
-
-Basic usage to disable encryption of your document store:
-
-(Note: If `PAPERLESS_PASSPHRASE` isn't set already, you need to specify
-it here)
-
-```
-decrypt_documents [--passphrase SECR3TP4SSPHRA$E]
-```

docs/advanced_usage.md

@@ -1,545 +0,0 @@
-# Advanced Topics
-
-Paperless offers a couple features that automate certain tasks and make
-your life easier.
-
-## Matching tags, correspondents, document types, and storage paths {#matching}
-
-Paperless will compare the matching algorithms defined by every tag,
-correspondent, document type, and storage path in your database to see
-if they apply to the text in a document. In other words, if you define a
-tag called `Home Utility` that had a `match` property of `bc hydro` and
-a `matching_algorithm` of `Exact`, Paperless will automatically tag
-your newly-consumed document with your `Home Utility` tag so long as the
-text `bc hydro` appears in the body of the document somewhere.
-
-The matching logic is quite powerful. It supports searching the text of
-your document with different algorithms, and as such, some
-experimentation may be necessary to get things right.
-
-In order to have a tag, correspondent, document type, or storage path
-assigned automatically to newly consumed documents, assign a match and
-matching algorithm using the web interface. These settings define when
-to assign tags, correspondents, document types, and storage paths to
-documents.
-
-The following algorithms are available:
-
-- **None:** No matching will be performed.
-- **Any:** Looks for any occurrence of any word provided in match in
-  the PDF. If you define the match as `Bank1 Bank2`, it will match
-  documents containing either of these terms.
-- **All:** Requires that every word provided appears in the PDF,
-  albeit not in the order provided.
-- **Exact:** Matches only if the match appears exactly as provided
-  (i.e. preserve ordering) in the PDF.
-- **Regular expression:** Parses the match as a regular expression and
-  tries to find a match within the document.
-- **Fuzzy match:** I don't know. Look at the source.
-- **Auto:** Tries to automatically match new documents. This does not
-  require you to set a match. See the notes below.
-
-When using the _any_ or _all_ matching algorithms, you can search for
-terms that consist of multiple words by enclosing them in double quotes.
-For example, defining a match text of `"Bank of America" BofA` using the
-_any_ algorithm, will match documents that contain either "Bank of
-America" or "BofA", but will not match documents containing "Bank of
-South America".
-
-Then just save your tag, correspondent, document type, or storage path
-and run another document through the consumer. Once complete, you should
-see the newly-created document, automatically tagged with the
-appropriate data.
-
-### Automatic matching {#automatic-matching}
-
-Paperless-ngx comes with a new matching algorithm called _Auto_. This
-matching algorithm tries to assign tags, correspondents, document types,
-and storage paths to your documents based on how you have already
-assigned these on existing documents. It uses a neural network under the
-hood.
-
-If, for example, all your bank statements of your account 123 at the
-Bank of America are tagged with the tag "bofa123" and the matching
-algorithm of this tag is set to _Auto_, this neural network will examine
-your documents and automatically learn when to assign this tag.
-
-Paperless tries to hide much of the involved complexity with this
-approach. However, there are a couple caveats you need to keep in mind
-when using this feature:
-
-- Changes to your documents are not immediately reflected by the
-  matching algorithm. The neural network needs to be _trained_ on your
-  documents after changes. Paperless periodically (default: once each
-  hour) checks for changes and does this automatically for you.
-- The Auto matching algorithm only takes documents into account which
-  are NOT placed in your inbox (i.e. have any inbox tags assigned to
-  them). This ensures that the neural network only learns from
-  documents which you have correctly tagged before.
-- The matching algorithm can only work if there is a correlation
-  between the tag, correspondent, document type, or storage path and
-  the document itself. Your bank statements usually contain your bank
-  account number and the name of the bank, so this works reasonably
-  well, However, tags such as "TODO" cannot be automatically
-  assigned.
-- The matching algorithm needs a reasonable number of documents to
-  identify when to assign tags, correspondents, storage paths, and
-  types. If one out of a thousand documents has the correspondent
-  "Very obscure web shop I bought something five years ago", it will
-  probably not assign this correspondent automatically if you buy
-  something from them again. The more documents, the better.
-- Paperless also needs a reasonable amount of negative examples to
-  decide when not to assign a certain tag, correspondent, document
-  type, or storage path. This will usually be the case as you start
-  filling up paperless with documents. Example: If all your documents
-  are either from "Webshop" and "Bank", paperless will assign one
-  of these correspondents to ANY new document, if both are set to
-  automatic matching.
-
-## Hooking into the consumption process {#consume-hooks}
-
-Sometimes you may want to do something arbitrary whenever a document is
-consumed. Rather than try to predict what you may want to do, Paperless
-lets you execute scripts of your own choosing just before or after a
-document is consumed using a couple simple hooks.
-
-Just write a script, put it somewhere that Paperless can read & execute,
-and then put the path to that script in `paperless.conf` or
-`docker-compose.env` with the variable name of either
-`PAPERLESS_PRE_CONSUME_SCRIPT` or `PAPERLESS_POST_CONSUME_SCRIPT`.
-
-!!! info
-
-    These scripts are executed in a **blocking** process, which means that
-    if a script takes a long time to run, it can significantly slow down
-    your document consumption flow. If you want things to run
-    asynchronously, you'll have to fork the process in your script and
-    exit.
-
-### Pre-consumption script {#pre-consume-script}
-
-Executed after the consumer sees a new document in the consumption
-folder, but before any processing of the document is performed. This
-script can access the following relevant environment variables set:
-
-| Environment Variable    | Description                                                  |
-| ----------------------- | ------------------------------------------------------------ |
-| `DOCUMENT_SOURCE_PATH`  | Original path of the consumed document                       |
-| `DOCUMENT_WORKING_PATH` | Path to a copy of the original that consumption will work on |
-
-!!! note
-
-    Pre-consume scripts which modify the document should only change
-    the `DOCUMENT_WORKING_PATH` file or a second consume task may
-    be triggered, leading to failures as two tasks work on the
-    same document path
-
-A simple but common example for this would be creating a simple script
-like this:
-
-`/usr/local/bin/ocr-pdf`
-
-```bash
-#!/usr/bin/env bash
-pdf2pdfocr.py -i ${DOCUMENT_WORKING_PATH}
-```
-
-`/etc/paperless.conf`
-
-```bash
-...
-PAPERLESS_PRE_CONSUME_SCRIPT="/usr/local/bin/ocr-pdf"
-...
-```
-
-This will pass the path to the document about to be consumed to
-`/usr/local/bin/ocr-pdf`, which will in turn call
-[pdf2pdfocr.py](https://github.com/LeoFCardoso/pdf2pdfocr) on your
-document, which will then overwrite the file with an OCR'd version of
-the file and exit. At which point, the consumption process will begin
-with the newly modified file.
-
-The script's stdout and stderr will be logged line by line to the
-webserver log, along with the exit code of the script.
-
-### Post-consumption script {#post-consume-script}
-
-Executed after the consumer has successfully processed a document and
-has moved it into paperless. It receives the following environment
-variables:
-
-| Environment Variable         | Description                                   |
-| ---------------------------- | --------------------------------------------- |
-| `DOCUMENT_ID`                | Database primary key of the document          |
-| `DOCUMENT_FILE_NAME`         | Formatted filename, not including paths       |
-| `DOCUMENT_CREATED`           | Date & time when document created             |
-| `DOCUMENT_MODIFIED`          | Date & time when document was last modified   |
-| `DOCUMENT_ADDED`             | Date & time when document was added           |
-| `DOCUMENT_SOURCE_PATH`       | Path to the original document file            |
-| `DOCUMENT_ARCHIVE_PATH`      | Path to the generate archive file (if any)    |
-| `DOCUMENT_THUMBNAIL_PATH`    | Path to the generated thumbnail               |
-| `DOCUMENT_DOWNLOAD_URL`      | URL for document download                     |
-| `DOCUMENT_THUMBNAIL_URL`     | URL for the document thumbnail                |
-| `DOCUMENT_CORRESPONDENT`     | Assigned correspondent (if any)               |
-| `DOCUMENT_TAGS`              | Comma separated list of tags applied (if any) |
-| `DOCUMENT_ORIGINAL_FILENAME` | Filename of original document                 |
-
-The script can be in any language, A simple shell script example:
-
-```bash title="post-consumption-example"
---8<-- "./scripts/post-consumption-example.sh"
-```
-
-!!! note
-
-    The post consumption script cannot cancel the consumption process.
-
-!!! warning
-
-    The post consumption script should not modify the document files
-    directly
-
-The script's stdout and stderr will be logged line by line to the
-webserver log, along with the exit code of the script.
-
-### Docker {#docker-consume-hooks}
-
-To hook into the consumption process when using Docker, you
-will need to pass the scripts into the container via a host mount
-in your `docker-compose.yml`.
-
-Assuming you have
-`/home/paperless-ngx/scripts/post-consumption-example.sh` as a
-script which you'd like to run.
-
-You can pass that script into the consumer container via a host mount:
-
-```yaml
-...
-webserver:
-  ...
-  volumes:
-    ...
-    - /home/paperless-ngx/scripts:/path/in/container/scripts/ # (1)!
-  environment: # (3)!
-    ...
-    PAPERLESS_POST_CONSUME_SCRIPT: /path/in/container/scripts/post-consumption-example.sh # (2)!
-...
-```
-
-1. The external scripts directory is mounted to a location inside the container.
-2. The internal location of the script is used to set the script to run
-3. This can also be set in `docker-compose.env`
-
-Troubleshooting:
-
-- Monitor the docker-compose log
-  `cd ~/paperless-ngx; docker-compose logs -f`
-- Check your script's permission e.g. in case of permission error
-  `sudo chmod 755 post-consumption-example.sh`
-- Pipe your scripts's output to a log file e.g.
-  `echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log`
-
-## File name handling {#file-name-handling}
-
-By default, paperless stores your documents in the media directory and
-renames them using the identifier which it has assigned to each
-document. You will end up getting files like `0000123.pdf` in your media
-directory. This isn't necessarily a bad thing, because you normally
-don't have to access these files manually. However, if you wish to name
-your files differently, you can do that by adjusting the
-`PAPERLESS_FILENAME_FORMAT` configuration option. Paperless adds the
-correct file extension e.g. `.pdf`, `.jpg` automatically.
-
-This variable allows you to configure the filename (folders are allowed)
-using placeholders. For example, configuring this to
-
-```bash
-PAPERLESS_FILENAME_FORMAT={created_year}/{correspondent}/{title}
-```
-
-will create a directory structure as follows:
-
-```
-2019/
-  My bank/
-    Statement January.pdf
-    Statement February.pdf
-2020/
-  My bank/
-    Statement January.pdf
-    Letter.pdf
-    Letter_01.pdf
-  Shoe store/
-    My new shoes.pdf
-```
-
-!!! warning
-
-    Do not manually move your files in the media folder. Paperless remembers
-    the last filename a document was stored as. If you do rename a file,
-    paperless will report your files as missing and won't be able to find
-    them.
-
-Paperless provides the following placeholders within filenames:
-
-- `{asn}`: The archive serial number of the document, or "none".
-- `{correspondent}`: The name of the correspondent, or "none".
-- `{document_type}`: The name of the document type, or "none".
-- `{tag_list}`: A comma separated list of all tags assigned to the
-  document.
-- `{title}`: The title of the document.
-- `{created}`: The full date (ISO format) the document was created.
-- `{created_year}`: Year created only, formatted as the year with
-  century.
-- `{created_year_short}`: Year created only, formatted as the year
-  without century, zero padded.
-- `{created_month}`: Month created only (number 01-12).
-- `{created_month_name}`: Month created name, as per locale
-- `{created_month_name_short}`: Month created abbreviated name, as per
-  locale
-- `{created_day}`: Day created only (number 01-31).
-- `{added}`: The full date (ISO format) the document was added to
-  paperless.
-- `{added_year}`: Year added only.
-- `{added_year_short}`: Year added only, formatted as the year without
-  century, zero padded.
-- `{added_month}`: Month added only (number 01-12).
-- `{added_month_name}`: Month added name, as per locale
-- `{added_month_name_short}`: Month added abbreviated name, as per
-  locale
-- `{added_day}`: Day added only (number 01-31).
-- `{owner_username}`: Username of document owner, if any, or "none"
-- `{original_name}`: Document original filename, minus the extension, if any, or "none"
-
-Paperless will try to conserve the information from your database as
-much as possible. However, some characters that you can use in document
-titles and correspondent names (such as `: \ /` and a couple more) are
-not allowed in filenames and will be replaced with dashes.
-
-If paperless detects that two documents share the same filename,
-paperless will automatically append `_01`, `_02`, etc to the filename.
-This happens if all the placeholders in a filename evaluate to the same
-value.
-
-!!! tip
-
-    You can affect how empty placeholders are treated by changing the
-    following setting to `true`.
-
-    ```
-    PAPERLESS_FILENAME_FORMAT_REMOVE_NONE=True
-    ```
-
-    Doing this results in all empty placeholders resolving to "" instead
-    of "none" as stated above. Spaces before empty placeholders are
-    removed as well, empty directories are omitted.
-
-!!! tip
-
-    Paperless checks the filename of a document whenever it is saved.
-    Therefore, you need to update the filenames of your documents and move
-    them after altering this setting by invoking the
-    [`document renamer`](/administration#renamer).
-
-!!! warning
-
-    Make absolutely sure you get the spelling of the placeholders right, or
-    else paperless will use the default naming scheme instead.
-
-!!! caution
-
-    As of now, you could totally tell paperless to store your files anywhere
-    outside the media directory by setting
-
-    ```
-    PAPERLESS_FILENAME_FORMAT=../../my/custom/location/{title}
-    ```
-
-    However, keep in mind that inside docker, if files get stored outside of
-    the predefined volumes, they will be lost after a restart of paperless.
-
-!!! warning
-
-    When file naming handling, in particular when using `{tag_list}`,
-    you may run into the limits of your operating system's maximum
-    path lengths.  Files will retain the previous path instead and
-    the issue logged.
-
-## Storage paths
-
-One of the best things in Paperless is that you can not only access the
-documents via the web interface, but also via the file system.
-
-When a single storage layout is not sufficient for your use case,
-storage paths come to the rescue. Storage paths allow you to configure
-more precisely where each document is stored in the file system.
-
-- Each storage path is a `PAPERLESS_FILENAME_FORMAT` and
-  follows the rules described above
-- Each document is assigned a storage path using the matching
-  algorithms described above, but can be overwritten at any time
-
-For example, you could define the following two storage paths:
-
-1.  Normal communications are put into a folder structure sorted by
-    `year/correspondent`
-2.  Communications with insurance companies are stored in a flat
-    structure with longer file names, but containing the full date of
-    the correspondence.
-
-```
-By Year = {created_year}/{correspondent}/{title}
-Insurances = Insurances/{correspondent}/{created_year}-{created_month}-{created_day} {title}
-```
-
-If you then map these storage paths to the documents, you might get the
-following result. For simplicity, `By Year` defines the same
-structure as in the previous example above.
-
-```text
-2019/                                   # By Year
-   My bank/
-     Statement January.pdf
-     Statement February.pdf
-
-Insurances/                             # Insurances
-   Healthcare 123/
-     2022-01-01 Statement January.pdf
-     2022-02-02 Letter.pdf
-     2022-02-03 Letter.pdf
-   Dental 456/
-     2021-12-01 New Conditions.pdf
-```
-
-!!! tip
-
-    Defining a storage path is optional. If no storage path is defined for a
-    document, the global `PAPERLESS_FILENAME_FORMAT` is applied.
-
-## Celery Monitoring {#celery-monitoring}
-
-The monitoring tool
-[Flower](https://flower.readthedocs.io/en/latest/index.html) can be used
-to view more detailed information about the health of the celery workers
-used for asynchronous tasks. This includes details on currently running,
-queued and completed tasks, timing and more. Flower can also be used
-with Prometheus, as it exports metrics. For details on its capabilities,
-refer to the Flower documentation.
-
-To configure Flower further, create a `flowerconfig.py` and
-place it into the `src/paperless` directory. For a Docker
-installation, you can use volumes to accomplish this:
-
-```yaml
-services:
-  # ...
-  webserver:
-    ports:
-      - 5555:5555 # (2)!
-    # ...
-    volumes:
-      - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro # (1)!
-```
-
-1. Note the `:ro` tag means the file will be mounted as read only.
-2. `flower` runs by default on port 5555, but this can be configured
-
-## Custom Container Initialization
-
-The Docker image includes the ability to run custom user scripts during
-startup. This could be utilized for installing additional tools or
-Python packages, for example. Scripts are expected to be shell scripts.
-
-To utilize this, mount a folder containing your scripts to the custom
-initialization directory, `/custom-cont-init.d` and place
-scripts you wish to run inside. For security, the folder must be owned
-by `root` and should have permissions of `a=rx`. Additionally, scripts
-must only be writable by `root`.
-
-Your scripts will be run directly before the webserver completes
-startup. Scripts will be run by the `root` user.
-If you would like to switch users, the utility `gosu` is available and
-preferred over `sudo`.
-
-This is an advanced functionality with which you could break functionality
-or lose data. If you experience issues, please disable any custom scripts
-and try again before reporting an issue.
-
-For example, using Docker Compose:
-
-```yaml
-services:
-  # ...
-  webserver:
-    # ...
-    volumes:
-      - /path/to/my/scripts:/custom-cont-init.d:ro # (1)!
-```
-
-1. Note the `:ro` tag means the folder will be mounted as read only. This is for extra security against changes
-
-## MySQL Caveats {#mysql-caveats}
-
-### Case Sensitivity
-
-The database interface does not provide a method to configure a MySQL
-database to be case sensitive. This would prevent a user from creating a
-tag `Name` and `NAME` as they are considered the same.
-
-Per Django documentation, to enable this requires manual intervention.
-To enable case sensitive tables, you can execute the following command
-against each table:
-
-`ALTER TABLE <table_name> CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;`
-
-You can also set the default for new tables (this does NOT affect
-existing tables) with:
-
-`ALTER DATABASE <db_name> CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;`
-
-!!! warning
-
-    Using mariadb version 10.4+ is recommended. Using the `utf8mb3` character set on
-    an older system may fix issues that can arise while setting up Paperless-ngx but
-    `utf8mb3` can cause issues with consumption (where `utf8mb4` does not).
-
-## Barcodes {#barcodes}
-
-Paperless is able to utilize barcodes for automatically preforming some tasks.
-
-At this time, the library utilized for detection of barcodes supports the following types:
-
-- AN-13/UPC-A
-- UPC-E
-- EAN-8
-- Code 128
-- Code 93
-- Code 39
-- Codabar
-- Interleaved 2 of 5
-- QR Code
-- SQ Code
-
-You may check for updates on the [zbar library homepage](https://github.com/mchehab/zbar).
-For usage in Paperless, the type of barcode does not matter, only the contents of it.
-
-For how to enable barcode usage, see [the configuration](/configuration#barcodes).
-The two settings may be enabled independently, but do have interactions as explained
-below.
-
-### Document Splitting
-
-When enabled, Paperless will look for a barcode with the configured value and create a new document
-starting from the next page. The page with the barcode on it will _not_ be retained. It
-is expected to be a page existing only for triggering the split.
-
-### Archive Serial Number Assignment
-
-When enabled, the value of the barcode (as an integer) will be used to set the document's
-archive serial number, allowing quick reference back to the original, paper document.
-
-If document splitting via barcode is also enabled, documents will be split when an ASN
-barcode is located. However, differing from the splitting, the page with the
-barcode _will_ be retained. This allows application of a barcode to any page, including
-one which holds data to keep in the document.

docs/api.md

@@ -1,363 +0,0 @@
-# The REST API
-
-Paperless makes use of the [Django REST
-Framework](https://django-rest-framework.org/) standard API interface. It
-provides a browsable API for most of its endpoints, which you can
-inspect at `http://<paperless-host>:<port>/api/`. This also documents
-most of the available filters and ordering fields.
-
-The API provides 7 main endpoints:
-
-- `/api/documents/`: Full CRUD support, except POSTing new documents.
-  See below.
-- `/api/correspondents/`: Full CRUD support.
-- `/api/document_types/`: Full CRUD support.
-- `/api/logs/`: Read-Only.
-- `/api/tags/`: Full CRUD support.
-- `/api/tasks/`: Read-only.
-- `/api/mail_accounts/`: Full CRUD support.
-- `/api/mail_rules/`: Full CRUD support.
-- `/api/users/`: Full CRUD support.
-- `/api/groups/`: Full CRUD support.
-
-All of these endpoints except for the logging endpoint allow you to
-fetch (and edit and delete where appropriate) individual objects by
-appending their primary key to the path, e.g. `/api/documents/454/`.
-
-The objects served by the document endpoint contain the following
-fields:
-
-- `id`: ID of the document. Read-only.
-- `title`: Title of the document.
-- `content`: Plain text content of the document.
-- `tags`: List of IDs of tags assigned to this document, or empty
-  list.
-- `document_type`: Document type of this document, or null.
-- `correspondent`: Correspondent of this document or null.
-- `created`: The date time at which this document was created.
-- `created_date`: The date (YYYY-MM-DD) at which this document was
-  created. Optional. If also passed with created, this is ignored.
-- `modified`: The date at which this document was last edited in
-  paperless. Read-only.
-- `added`: The date at which this document was added to paperless.
-  Read-only.
-- `archive_serial_number`: The identifier of this document in a
-  physical document archive.
-- `original_file_name`: Verbose filename of the original document.
-  Read-only.
-- `archived_file_name`: Verbose filename of the archived document.
-  Read-only. Null if no archived document is available.
-- `set_permissions`: Allows setting document permissions. Optional,
-  write-only. See [below](#permissions).
-
-## Downloading documents
-
-In addition to that, the document endpoint offers these additional
-actions on individual documents:
-
-- `/api/documents/<pk>/download/`: Download the document.
-- `/api/documents/<pk>/preview/`: Display the document inline, without
-  downloading it.
-- `/api/documents/<pk>/thumb/`: Download the PNG thumbnail of a
-  document.
-
-Paperless generates archived PDF/A documents from consumed files and
-stores both the original files as well as the archived files. By
-default, the endpoints for previews and downloads serve the archived
-file, if it is available. Otherwise, the original file is served. Some
-document cannot be archived.
-
-The endpoints correctly serve the response header fields
-`Content-Disposition` and `Content-Type` to indicate the filename for
-download and the type of content of the document.
-
-In order to download or preview the original document when an archived
-document is available, supply the query parameter `original=true`.
-
-!!! tip
-
-    Paperless used to provide these functionality at `/fetch/<pk>/preview`,
-    `/fetch/<pk>/thumb` and `/fetch/<pk>/doc`. Redirects to the new URLs are
-    in place. However, if you use these old URLs to access documents, you
-    should update your app or script to use the new URLs.
-
-## Getting document metadata
-
-The api also has an endpoint to retrieve read-only metadata about
-specific documents. this information is not served along with the
-document objects, since it requires reading files and would therefore
-slow down document lists considerably.
-
-Access the metadata of a document with an ID `id` at
-`/api/documents/<id>/metadata/`.
-
-The endpoint reports the following data:
-
-- `original_checksum`: MD5 checksum of the original document.
-- `original_size`: Size of the original document, in bytes.
-- `original_mime_type`: Mime type of the original document.
-- `media_filename`: Current filename of the document, under which it
-  is stored inside the media directory.
-- `has_archive_version`: True, if this document is archived, false
-  otherwise.
-- `original_metadata`: A list of metadata associated with the original
-  document. See below.
-- `archive_checksum`: MD5 checksum of the archived document, or null.
-- `archive_size`: Size of the archived document in bytes, or null.
-- `archive_metadata`: Metadata associated with the archived document,
-  or null. See below.
-
-File metadata is reported as a list of objects in the following form:
-
-```json
-[
-  {
-    "namespace": "http://ns.adobe.com/pdf/1.3/",
-    "prefix": "pdf",
-    "key": "Producer",
-    "value": "SparklePDF, Fancy edition"
-  }
-]
-```
-
-`namespace` and `prefix` can be null. The actual metadata reported
-depends on the file type and the metadata available in that specific
-document. Paperless only reports PDF metadata at this point.
-
-## Authorization
-
-The REST api provides three different forms of authentication.
-
-1.  Basic authentication
-
-    Authorize by providing a HTTP header in the form
-
-    ```
-    Authorization: Basic <credentials>
-    ```
-
-    where `credentials` is a base64-encoded string of
-    `<username>:<password>`
-
-2.  Session authentication
-
-    When you're logged into paperless in your browser, you're
-    automatically logged into the API as well and don't need to provide
-    any authorization headers.
-
-3.  Token authentication
-
-    Paperless also offers an endpoint to acquire authentication tokens.
-
-    POST a username and password as a form or json string to
-    `/api/token/` and paperless will respond with a token, if the login
-    data is correct. This token can be used to authenticate other
-    requests with the following HTTP header:
-
-    ```
-    Authorization: Token <token>
-    ```
-
-    Tokens can be managed and revoked in the paperless admin.
-
-## Searching for documents
-
-Full text searching is available on the `/api/documents/` endpoint. Two
-specific query parameters cause the API to return full text search
-results:
-
-- `/api/documents/?query=your%20search%20query`: Search for a document
-  using a full text query. For details on the syntax, see [Basic Usage - Searching](/usage#basic-usage_searching).
-- `/api/documents/?more_like=1234`: Search for documents similar to
-  the document with id 1234.
-
-Pagination works exactly the same as it does for normal requests on this
-endpoint.
-
-Certain limitations apply to full text queries:
-
-- Results are always sorted by search score. The results matching the
-  query best will show up first.
-- Only a small subset of filtering parameters are supported.
-
-Furthermore, each returned document has an additional `__search_hit__`
-attribute with various information about the search results:
-
-```
-{
-    "count": 31,
-    "next": "http://localhost:8000/api/documents/?page=2&query=test",
-    "previous": null,
-    "results": [
-
-        ...
-
-        {
-            "id": 123,
-            "title": "title",
-            "content": "content",
-
-            ...
-
-            "__search_hit__": {
-                "score": 0.343,
-                "highlights": "text <span class="match">Test</span> text",
-                "rank": 23
-            }
-        },
-
-        ...
-
-    ]
-}
-```
-
-- `score` is an indication how well this document matches the query
-  relative to the other search results.
-- `highlights` is an excerpt from the document content and highlights
-  the search terms with `<span>` tags as shown above.
-- `rank` is the index of the search results. The first result will
-  have rank 0.
-
-### `/api/search/autocomplete/`
-
-Get auto completions for a partial search term.
-
-Query parameters:
-
-- `term`: The incomplete term.
-- `limit`: Amount of results. Defaults to 10.
-
-Results returned by the endpoint are ordered by importance of the term
-in the document index. The first result is the term that has the highest
-[Tf/Idf](https://en.wikipedia.org/wiki/Tf%E2%80%93idf) score in the index.
-
-```json
-["term1", "term3", "term6", "term4"]
-```
-
-## POSTing documents {#file-uploads}
-
-The API provides a special endpoint for file uploads:
-
-`/api/documents/post_document/`
-
-POST a multipart form to this endpoint, where the form field `document`
-contains the document that you want to upload to paperless. The filename
-is sanitized and then used to store the document in a temporary
-directory, and the consumer will be instructed to consume the document
-from there.
-
-The endpoint supports the following optional form fields:
-
-- `title`: Specify a title that the consumer should use for the
-  document.
-- `created`: Specify a DateTime where the document was created (e.g.
-  "2016-04-19" or "2016-04-19 06:15:00+02:00").
-- `correspondent`: Specify the ID of a correspondent that the consumer
-  should use for the document.
-- `document_type`: Similar to correspondent.
-- `tags`: Similar to correspondent. Specify this multiple times to
-  have multiple tags added to the document.
-- `archive_serial_number`: An optional archive serial number to set.
-
-The endpoint will immediately return HTTP 200 if the document consumption
-process was started successfully, with the UUID of the consumption task
-as the data. No additional status information about the consumption process
-itself is available immediately, since that happens in a different process.
-However, querying the tasks endpoint with the returned UUID e.g.
-`/api/tasks/?task_id={uuid}` will provide information on the state of the
-consumption including the ID of a created document if consumption succeeded.
-
-## Permissions
-
-All objects (documents, tags, etc.) allow setting object-level permissions
-with an optional `set_permissions` parameter which is of the form:
-
-```
-{
-  "owner": user_id,
-  "view": {
-      "users": [...],
-      "groups": [...],
-  },
-  "change": {
-      "users": [...],
-      "groups": [...],
-  },
-}
-```
-
-!!! note
-
-    Arrays should contain user or group ID numbers.
-
-If this parameter is supplied the object's permissions will be overwritten,
-assuming the authenticated user has permission to do so (the user must be
-the object owner or a superuser).
-
-### Retrieving full permissions
-
-By default, the API will return a truncated version of object-level
-permissions, returning `user_can_change` indicating whether the current user
-can edit the object (either because they are the object owner or have permissions
-granted). You can pass the parameter `full_perms=true` to API calls to view the
-full permissions of objects in a format that mirrors the `set_permissions`
-parameter above.
-
-## API Versioning
-
-The REST API is versioned since Paperless-ngx 1.3.0.
-
-- Versioning ensures that changes to the API don't break older
-  clients.
-- Clients specify the specific version of the API they wish to use
-  with every request and Paperless will handle the request using the
-  specified API version.
-- Even if the underlying data model changes, older API versions will
-  always serve compatible data.
-- If no version is specified, Paperless will serve version 1 to ensure
-  compatibility with older clients that do not request a specific API
-  version.
-
-API versions are specified by submitting an additional HTTP `Accept`
-header with every request:
-
-```
-Accept: application/json; version=6
-```
-
-If an invalid version is specified, Paperless 1.3.0 will respond with
-"406 Not Acceptable" and an error message in the body. Earlier
-versions of Paperless will serve API version 1 regardless of whether a
-version is specified via the `Accept` header.
-
-If a client wishes to verify whether it is compatible with any given
-server, the following procedure should be performed:
-
-1.  Perform an _authenticated_ request against any API endpoint. If the
-    server is on version 1.3.0 or newer, the server will add two custom
-    headers to the response:
-
-    ```
-    X-Api-Version: 2
-    X-Version: 1.3.0
-    ```
-
-2.  Determine whether the client is compatible with this server based on
-    the presence/absence of these headers and their values if present.
-
-### API Changelog
-
-#### Version 1
-
-Initial API version.
-
-#### Version 2
-
-- Added field `Tag.color`. This read/write string field contains a hex
-  color such as `#a6cee3`.
-- Added read-only field `Tag.text_color`. This field contains the text
-  color to use for a specific tag, which is either black or white
-  depending on the brightness of `Tag.color`.
-- Removed field `Tag.colour`.

docs/api.rst

@@ -0,0 +1,23 @@
+.. _api:
+
+The REST API
+############
+
+Paperless makes use of the `Django REST Framework`_ standard API interface
+because of its inherent awesomeness.  Conveniently, the system is also
+self-documenting, so to learn more about the access points, schema, what's
+accepted and what isn't, you need only visit ``/api`` on your local Paperless
+installation.
+
+.. _Django REST Framework: http://django-rest-framework.org/
+
+
+.. _api-uploading:
+
+Uploading
+---------
+
+File uploads in an API are hard and so far as I've been able to tell, there's
+no standard way of accepting them, so rather than crowbar file uploads into the
+REST API and endure that headache, I've left that process to a simple HTTP
+POST, documented on the :ref:`consumption page <consumption-http>`.

docs/assets/extra.css

@@ -1,36 +0,0 @@
-:root > * {
-    --md-primary-fg-color: #17541f;
-    --md-primary-fg-color--dark: #17541f;
-    --md-primary-fg-color--light: #17541f;
-    --md-accent-fg-color: #2b8a38;
-    --md-typeset-a-color: #21652a;
-}
-
-[data-md-color-scheme="slate"] {
-    --md-hue: 222;
-}
-
-@media (min-width: 400px) {
-    .grid-left {
-        width: 33%;
-        float: left;
-    }
-    .grid-right {
-        width: 62%;
-        margin-left: 4%;
-        float: left;
-    }
-}
-
-.grid-left > p {
-    margin-bottom: 2rem;
-}
-
-
-.grid-right p {
-    margin: 0;
-}
-
-.index-callout {
-    margin-right: .5rem;
-}

docs/assets/logo.svg

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 27.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 1000 1000" style="enable-background:new 0 0 1000 1000;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#FFFFFF;}
-</style>
-<path class="st0" d="M299,891.7c-4.2-19.8-12.5-59.6-13.6-59.6c-176.7-105.7-155.8-288.7-97.3-393.4
-	c12.5,131.8,245.8,222.8,109.8,383.9c-1.1,2,6.2,27.2,12.5,50.2c27.2-46,68-101.4,65.8-106.7C208.9,358.2,731.9,326.9,840.6,73.7
-	c49.1,244.8-25.1,623.5-445.5,719.7c-2,1.1-76.3,131.8-79.5,132.9c0-2-31.4-1.1-27.2-11.5C290.7,908.4,294.8,900.1,299,891.7
-	L299,891.7z M293.8,793.4c53.3-61.8-9.4-167.4-47.1-201.9C310.5,701.3,306.3,765.1,293.8,793.4L293.8,793.4z"/>
-</svg>

docs/assets/logo_full_black.svg

@@ -1,68 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 27.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 2962.2 860.2" style="enable-background:new 0 0 2962.2 860.2;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#17541F;stroke:#000000;stroke-miterlimit:10;}
-</style>
-<path d="M1055.6,639.7v-20.6c-18,20-43.1,30.1-75.4,30.1c-22.4,0-42.8-5.8-61-17.5c-18.3-11.7-32.5-27.8-42.9-48.3
-	c-10.3-20.5-15.5-43.3-15.5-68.4c0-25.1,5.2-48,15.5-68.5s24.6-36.6,42.9-48.3s38.6-17.5,61-17.5c32.3,0,57.5,10,75.4,30.1v-20.6
-	h85.3v249.6L1055.6,639.7L1055.6,639.7z M1059.1,514.9c0-17.4-5.2-31.9-15.5-43.8c-10.3-11.8-23.9-17.7-40.6-17.7
-	c-16.8,0-30.2,5.9-40.4,17.7c-10.2,11.8-15.3,26.4-15.3,43.8c0,17.4,5.1,31.9,15.3,43.8c10.2,11.8,23.6,17.7,40.4,17.7
-	c16.8,0,30.3-5.9,40.6-17.7C1054,546.9,1059.1,532.3,1059.1,514.9z"/>
-<path d="M1417.8,398.2c18.3,11.7,32.5,27.8,42.9,48.3c10.3,20.5,15.5,43.3,15.5,68.5c0,25.1-5.2,48-15.5,68.4
-	c-10.3,20.5-24.6,36.6-42.9,48.3s-38.6,17.5-61,17.5c-32.3,0-57.5-10-75.4-30.1v165.6h-85.3V390.2h85.3v20.6
-	c18-20,43.1-30.1,75.4-30.1C1379.2,380.7,1399.5,386.6,1417.8,398.2z M1389.5,514.9c0-17.4-5.1-31.9-15.3-43.8
-	c-10.2-11.8-23.6-17.7-40.4-17.7s-30.2,5.9-40.4,17.7c-10.2,11.8-15.3,26.4-15.3,43.8c0,17.4,5.1,31.9,15.3,43.8
-	c10.2,11.8,23.6,17.7,40.4,17.7s30.2-5.9,40.4-17.7S1389.5,532.3,1389.5,514.9z"/>
-<path d="M1713.6,555.3l53,49.4c-28.1,29.6-66.7,44.4-115.8,44.4c-28.1,0-53-5.8-74.5-17.5s-38.2-27.7-49.8-48
-	c-11.7-20.3-17.7-43.2-18-68.7c0-24.8,5.9-47.5,17.7-68c11.8-20.5,28.1-36.7,48.7-48.5s43.5-17.7,68.7-17.7
-	c24.8,0,47.6,6.1,68.2,18.2s37,29.5,49.1,52.3c12.1,22.7,18.2,49.1,18.2,79l-0.4,11.7h-181.8c3.6,11.4,10.5,20.7,20.9,28.1
-	c10.3,7.3,21.3,11,33,11c14.4,0,26.3-2.2,35.7-6.5C1695.8,570.1,1704.9,563.7,1713.6,555.3z M1596.9,486.2h92.9
-	c-2.1-12.3-7.5-22.1-16.2-29.4s-18.7-11-30.1-11s-21.5,3.7-30.3,11S1599,473.9,1596.9,486.2z"/>
-<path d="M1908.8,418.4c7.8-10.8,17.2-19,28.3-24.7s22-8.5,32.8-8.5c11.4,0,20,1.6,26,4.9l-10.8,72.7c-8.4-2.1-15.7-3.1-22-3.1
-	c-17.1,0-30.4,4.3-39.9,12.8c-9.6,8.5-14.4,24.2-14.4,46.9v120.3h-85.3V390.2h85.3V418.4L1908.8,418.4z"/>
-<path d="M2113,258.2v381.5h-85.3V258.2H2113z"/>
-<path d="M2360.8,555.3l53,49.4c-28.1,29.6-66.7,44.4-115.8,44.4c-28.1,0-53-5.8-74.5-17.5s-38.2-27.7-49.8-48
-	c-11.7-20.3-17.7-43.2-18-68.7c0-24.8,5.9-47.5,17.7-68s28.1-36.7,48.7-48.5c20.6-11.8,43.5-17.7,68.7-17.7
-	c24.8,0,47.6,6.1,68.2,18.2c20.6,12.1,37,29.5,49.1,52.3c12.1,22.7,18.2,49.1,18.2,79l-0.4,11.7h-181.8
-	c3.6,11.4,10.5,20.7,20.9,28.1c10.3,7.3,21.3,11,33,11c14.4,0,26.3-2.2,35.7-6.5C2343.1,570.1,2352.1,563.7,2360.8,555.3z
-	 M2244.1,486.2h92.9c-2.1-12.3-7.5-22.1-16.2-29.4s-18.7-11-30.1-11s-21.5,3.7-30.3,11C2251.7,464.1,2246.2,473.9,2244.1,486.2z"/>
-<path d="M2565.9,446.3c-9.9,0-17.1,1.1-21.5,3.4c-4.5,2.2-6.7,5.9-6.7,11s3.4,8.8,10.3,11.2c6.9,2.4,18,4.9,33.2,7.6
-	c20,3,37,6.7,50.9,11.2s26,12.1,36.1,22.9c10.2,10.8,15.3,25.9,15.3,45.3c0,29.9-10.9,52.4-32.8,67.6
-	c-21.8,15.1-50.3,22.7-85.3,22.7c-25.7,0-49.5-3.7-71.4-11c-21.8-7.3-37.4-14.7-46.7-22.2l33.7-60.6c10.2,9,23.4,15.8,39.7,20.4
-	c16.3,4.6,31.3,7,45.1,7c19.7,0,29.6-5.2,29.6-15.7c0-5.4-3.3-9.4-9.9-11.9c-6.6-2.5-17.2-5.2-31.9-7.9c-18.9-3.3-34.9-7.2-48-11.7
-	c-13.2-4.5-24.6-12.2-34.3-23.1c-9.7-10.9-14.6-26-14.6-45.1c0-27.2,9.7-48.5,29-63.7c19.3-15.3,46-22.9,80.1-22.9
-	c23.3,0,44.4,3.6,63.3,10.8c18.9,7.2,34,14.5,45.3,22l-32.8,58.8c-10.8-7.5-23.2-13.7-37.3-18.6
-	C2590.5,448.7,2577.6,446.3,2565.9,446.3z"/>
-<path d="M2817.3,446.3c-9.9,0-17.1,1.1-21.5,3.4c-4.5,2.2-6.7,5.9-6.7,11s3.4,8.8,10.3,11.2c6.9,2.4,18,4.9,33.2,7.6
-	c20,3,37,6.7,50.9,11.2s26,12.1,36.1,22.9c10.2,10.8,15.3,25.9,15.3,45.3c0,29.9-10.9,52.4-32.8,67.6
-	c-21.8,15.1-50.3,22.7-85.3,22.7c-25.7,0-49.5-3.7-71.4-11c-21.8-7.3-37.4-14.7-46.7-22.2l33.7-60.6c10.2,9,23.4,15.8,39.7,20.4
-	c16.3,4.6,31.3,7,45.1,7c19.8,0,29.6-5.2,29.6-15.7c0-5.4-3.3-9.4-9.9-11.9c-6.6-2.5-17.2-5.2-31.9-7.9c-18.9-3.3-34.9-7.2-48-11.7
-	c-13.2-4.5-24.6-12.2-34.3-23.1c-9.7-10.9-14.6-26-14.6-45.1c0-27.2,9.7-48.5,29-63.7c19.3-15.3,46-22.9,80.1-22.9
-	c23.3,0,44.4,3.6,63.3,10.8c18.9,7.2,34,14.5,45.3,22l-32.8,58.8c-10.8-7.5-23.2-13.7-37.3-18.6
-	C2841.8,448.7,2828.9,446.3,2817.3,446.3z"/>
-<g>
-	<path d="M2508,724h60.2v17.3H2508V724z"/>
-	<path d="M2629.2,694.4c4.9-2,10.2-3.1,16-3.1c10.9,0,19.5,3.4,25.9,10.2s9.6,16.7,9.6,29.6v57.3h-19.6v-52.6
-		c0-9.3-1.7-16.2-5.1-20.7c-3.4-4.5-9.1-6.7-17-6.7c-6.5,0-11.8,2.4-16.1,7.1c-4.3,4.8-6.4,11.5-6.4,20.2v52.6h-19.6v-94.6h19.6v9.5
-		C2620.2,699.4,2624.4,696.4,2629.2,694.4z"/>
-	<path d="M2790.3,833.2c-8.6,6.8-19.4,10.2-32.3,10.2c-7.9,0-15.2-1.4-21.9-4.1s-12.1-6.8-16.3-12.2s-6.6-11.9-7.1-19.6h19.6
-		c0.7,6.1,3.5,10.8,8.4,13.9c4.9,3.2,10.7,4.8,17.4,4.8c7,0,13.1-2,18.2-6c5.1-4,7.7-10.3,7.7-18.9v-24.7c-3.6,3.4-8,6.2-13.3,8.2
-		c-5.2,2.1-10.7,3.1-16.3,3.1c-8.7,0-16.6-2.1-23.7-6.4c-7.1-4.3-12.6-10-16.7-17.3c-4-7.3-6-15.5-6-24.6s2-17.3,6-24.7
-		s9.6-13.2,16.7-17.4c7.1-4.3,15-6.4,23.7-6.4c5.7,0,11.1,1,16.3,3.1s9.6,4.8,13.3,8.2v-8.8h19.4v107.8
-		C2803.2,815.9,2798.9,826.4,2790.3,833.2z M2782.2,755.7c2.6-4.7,3.8-10,3.8-15.9s-1.3-11.2-3.8-16c-2.6-4.8-6.1-8.5-10.5-11.1
-		c-4.5-2.7-9.5-4-15.1-4c-5.8,0-10.9,1.4-15.4,4.3c-4.5,2.8-7.9,6.6-10.3,11.4c-2.4,4.8-3.6,9.9-3.6,15.5c0,5.4,1.2,10.5,3.6,15.3
-		c2.4,4.8,5.8,8.6,10.3,11.5s9.6,4.3,15.4,4.3c5.6,0,10.6-1.4,15.1-4.1C2776.1,764.1,2779.6,760.4,2782.2,755.7z"/>
-	<path d="M2843.5,788.4h-21.6l37.9-48l-36.4-46.6h22.6l25.7,33.3l25.8-33.3h21.6l-36.2,45.9l37.9,48.6h-22.6l-27.4-35L2843.5,788.4z
-		"/>
-</g>
-<path d="M835.8,319.2c-11.5-18.9-27.4-33.7-47.6-44.7c-20.2-10.9-43-16.4-68.5-16.4h-90.6c-8.6,39.6-21.3,77.2-38,112.4
-	c-10,21-21.3,41-33.9,59.9v209.2H647v-135h72.7c25.4,0,48.3-5.5,68.5-16.4s36.1-25.8,47.6-44.7c11.5-18.9,17.3-39.5,17.3-61.9
-	C853.1,358.9,847.4,338.1,835.8,319.2z M747,416.6c-9.4,9-21.8,13.5-37,13.5l-62.8,0.4v-93.4l62.8-0.4c15.3,0,27.6,4.5,37,13.5
-	s14.1,20,14.1,33.2C761.1,396.6,756.4,407.7,747,416.6z"/>
-<path class="st0" d="M164.7,698.7c-3.5-16.5-10.4-49.6-11.3-49.6c-147.1-88-129.7-240.3-81-327.4C82.8,431.4,277,507.1,163.8,641.2
-	c-0.9,1.7,5.2,22.6,10.4,41.8c22.6-38.3,56.6-84.4,54.8-88.8C89.7,254.7,525,228.6,615.5,17.9c40.9,203.7-20.9,518.9-370.8,599
-	c-1.7,0.9-63.5,109.7-66.2,110.6c0-1.7-26.1-0.9-22.6-9.6C157.8,712.6,161.2,705.7,164.7,698.7L164.7,698.7z M160.4,616.9
-	c44.4-51.4-7.8-139.3-39.2-168C174.3,540.2,170.8,593.3,160.4,616.9L160.4,616.9z"/>
-</svg>

docs/assets/logo_full_white.svg

@@ -1,69 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 27.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 2962.2 860.2" style="enable-background:new 0 0 2962.2 860.2;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#FFFFFF;stroke:#000000;stroke-miterlimit:10;}
-	.st1{fill:#17541F;stroke:#000000;stroke-miterlimit:10;}
-</style>
-<path class="st0" d="M1055.6,639.7v-20.6c-18,20-43.1,30.1-75.4,30.1c-22.4,0-42.8-5.8-61-17.5c-18.3-11.7-32.5-27.8-42.9-48.3
-	c-10.3-20.5-15.5-43.3-15.5-68.4c0-25.1,5.2-48,15.5-68.5s24.6-36.6,42.9-48.3s38.6-17.5,61-17.5c32.3,0,57.5,10,75.4,30.1v-20.6
-	h85.3v249.6L1055.6,639.7L1055.6,639.7z M1059.1,514.9c0-17.4-5.2-31.9-15.5-43.8c-10.3-11.8-23.9-17.7-40.6-17.7
-	c-16.8,0-30.2,5.9-40.4,17.7c-10.2,11.8-15.3,26.4-15.3,43.8c0,17.4,5.1,31.9,15.3,43.8c10.2,11.8,23.6,17.7,40.4,17.7
-	c16.8,0,30.3-5.9,40.6-17.7C1054,546.9,1059.1,532.3,1059.1,514.9z"/>
-<path class="st0" d="M1417.8,398.2c18.3,11.7,32.5,27.8,42.9,48.3c10.3,20.5,15.5,43.3,15.5,68.5c0,25.1-5.2,48-15.5,68.4
-	c-10.3,20.5-24.6,36.6-42.9,48.3s-38.6,17.5-61,17.5c-32.3,0-57.5-10-75.4-30.1v165.6h-85.3V390.2h85.3v20.6
-	c18-20,43.1-30.1,75.4-30.1C1379.2,380.7,1399.5,386.6,1417.8,398.2z M1389.5,514.9c0-17.4-5.1-31.9-15.3-43.8
-	c-10.2-11.8-23.6-17.7-40.4-17.7s-30.2,5.9-40.4,17.7c-10.2,11.8-15.3,26.4-15.3,43.8c0,17.4,5.1,31.9,15.3,43.8
-	c10.2,11.8,23.6,17.7,40.4,17.7s30.2-5.9,40.4-17.7S1389.5,532.3,1389.5,514.9z"/>
-<path class="st0" d="M1713.6,555.3l53,49.4c-28.1,29.6-66.7,44.4-115.8,44.4c-28.1,0-53-5.8-74.5-17.5s-38.2-27.7-49.8-48
-	c-11.7-20.3-17.7-43.2-18-68.7c0-24.8,5.9-47.5,17.7-68c11.8-20.5,28.1-36.7,48.7-48.5s43.5-17.7,68.7-17.7
-	c24.8,0,47.6,6.1,68.2,18.2s37,29.5,49.1,52.3c12.1,22.7,18.2,49.1,18.2,79l-0.4,11.7h-181.8c3.6,11.4,10.5,20.7,20.9,28.1
-	c10.3,7.3,21.3,11,33,11c14.4,0,26.3-2.2,35.7-6.5C1695.8,570.1,1704.9,563.7,1713.6,555.3z M1596.9,486.2h92.9
-	c-2.1-12.3-7.5-22.1-16.2-29.4s-18.7-11-30.1-11s-21.5,3.7-30.3,11S1599,473.9,1596.9,486.2z"/>
-<path class="st0" d="M1908.8,418.4c7.8-10.8,17.2-19,28.3-24.7s22-8.5,32.8-8.5c11.4,0,20,1.6,26,4.9l-10.8,72.7
-	c-8.4-2.1-15.7-3.1-22-3.1c-17.1,0-30.4,4.3-39.9,12.8c-9.6,8.5-14.4,24.2-14.4,46.9v120.3h-85.3V390.2h85.3V418.4L1908.8,418.4z"/>
-<path class="st0" d="M2113,258.2v381.5h-85.3V258.2H2113z"/>
-<path class="st0" d="M2360.8,555.3l53,49.4c-28.1,29.6-66.7,44.4-115.8,44.4c-28.1,0-53-5.8-74.5-17.5s-38.2-27.7-49.8-48
-	c-11.7-20.3-17.7-43.2-18-68.7c0-24.8,5.9-47.5,17.7-68s28.1-36.7,48.7-48.5c20.6-11.8,43.5-17.7,68.7-17.7
-	c24.8,0,47.6,6.1,68.2,18.2c20.6,12.1,37,29.5,49.1,52.3c12.1,22.7,18.2,49.1,18.2,79l-0.4,11.7h-181.8
-	c3.6,11.4,10.5,20.7,20.9,28.1c10.3,7.3,21.3,11,33,11c14.4,0,26.3-2.2,35.7-6.5C2343.1,570.1,2352.1,563.7,2360.8,555.3z
-	 M2244.1,486.2h92.9c-2.1-12.3-7.5-22.1-16.2-29.4s-18.7-11-30.1-11s-21.5,3.7-30.3,11C2251.7,464.1,2246.2,473.9,2244.1,486.2z"/>
-<path class="st0" d="M2565.9,446.3c-9.9,0-17.1,1.1-21.5,3.4c-4.5,2.2-6.7,5.9-6.7,11s3.4,8.8,10.3,11.2c6.9,2.4,18,4.9,33.2,7.6
-	c20,3,37,6.7,50.9,11.2s26,12.1,36.1,22.9c10.2,10.8,15.3,25.9,15.3,45.3c0,29.9-10.9,52.4-32.8,67.6
-	c-21.8,15.1-50.3,22.7-85.3,22.7c-25.7,0-49.5-3.7-71.4-11c-21.8-7.3-37.4-14.7-46.7-22.2l33.7-60.6c10.2,9,23.4,15.8,39.7,20.4
-	c16.3,4.6,31.3,7,45.1,7c19.7,0,29.6-5.2,29.6-15.7c0-5.4-3.3-9.4-9.9-11.9c-6.6-2.5-17.2-5.2-31.9-7.9c-18.9-3.3-34.9-7.2-48-11.7
-	c-13.2-4.5-24.6-12.2-34.3-23.1c-9.7-10.9-14.6-26-14.6-45.1c0-27.2,9.7-48.5,29-63.7c19.3-15.3,46-22.9,80.1-22.9
-	c23.3,0,44.4,3.6,63.3,10.8c18.9,7.2,34,14.5,45.3,22l-32.8,58.8c-10.8-7.5-23.2-13.7-37.3-18.6
-	C2590.5,448.7,2577.6,446.3,2565.9,446.3z"/>
-<path class="st0" d="M2817.3,446.3c-9.9,0-17.1,1.1-21.5,3.4c-4.5,2.2-6.7,5.9-6.7,11s3.4,8.8,10.3,11.2c6.9,2.4,18,4.9,33.2,7.6
-	c20,3,37,6.7,50.9,11.2s26,12.1,36.1,22.9c10.2,10.8,15.3,25.9,15.3,45.3c0,29.9-10.9,52.4-32.8,67.6
-	c-21.8,15.1-50.3,22.7-85.3,22.7c-25.7,0-49.5-3.7-71.4-11c-21.8-7.3-37.4-14.7-46.7-22.2l33.7-60.6c10.2,9,23.4,15.8,39.7,20.4
-	c16.3,4.6,31.3,7,45.1,7c19.8,0,29.6-5.2,29.6-15.7c0-5.4-3.3-9.4-9.9-11.9c-6.6-2.5-17.2-5.2-31.9-7.9c-18.9-3.3-34.9-7.2-48-11.7
-	c-13.2-4.5-24.6-12.2-34.3-23.1c-9.7-10.9-14.6-26-14.6-45.1c0-27.2,9.7-48.5,29-63.7c19.3-15.3,46-22.9,80.1-22.9
-	c23.3,0,44.4,3.6,63.3,10.8c18.9,7.2,34,14.5,45.3,22l-32.8,58.8c-10.8-7.5-23.2-13.7-37.3-18.6
-	C2841.8,448.7,2828.9,446.3,2817.3,446.3z"/>
-<g>
-	<path class="st0" d="M2508,724h60.2v17.3H2508V724z"/>
-	<path class="st0" d="M2629.2,694.4c4.9-2,10.2-3.1,16-3.1c10.9,0,19.5,3.4,25.9,10.2s9.6,16.7,9.6,29.6v57.3h-19.6v-52.6
-		c0-9.3-1.7-16.2-5.1-20.7c-3.4-4.5-9.1-6.7-17-6.7c-6.5,0-11.8,2.4-16.1,7.1c-4.3,4.8-6.4,11.5-6.4,20.2v52.6h-19.6v-94.6h19.6v9.5
-		C2620.2,699.4,2624.4,696.4,2629.2,694.4z"/>
-	<path class="st0" d="M2790.3,833.2c-8.6,6.8-19.4,10.2-32.3,10.2c-7.9,0-15.2-1.4-21.9-4.1s-12.1-6.8-16.3-12.2s-6.6-11.9-7.1-19.6
-		h19.6c0.7,6.1,3.5,10.8,8.4,13.9c4.9,3.2,10.7,4.8,17.4,4.8c7,0,13.1-2,18.2-6c5.1-4,7.7-10.3,7.7-18.9v-24.7
-		c-3.6,3.4-8,6.2-13.3,8.2c-5.2,2.1-10.7,3.1-16.3,3.1c-8.7,0-16.6-2.1-23.7-6.4c-7.1-4.3-12.6-10-16.7-17.3c-4-7.3-6-15.5-6-24.6
-		s2-17.3,6-24.7s9.6-13.2,16.7-17.4c7.1-4.3,15-6.4,23.7-6.4c5.7,0,11.1,1,16.3,3.1s9.6,4.8,13.3,8.2v-8.8h19.4v107.8
-		C2803.2,815.9,2798.9,826.4,2790.3,833.2z M2782.2,755.7c2.6-4.7,3.8-10,3.8-15.9s-1.3-11.2-3.8-16c-2.6-4.8-6.1-8.5-10.5-11.1
-		c-4.5-2.7-9.5-4-15.1-4c-5.8,0-10.9,1.4-15.4,4.3c-4.5,2.8-7.9,6.6-10.3,11.4c-2.4,4.8-3.6,9.9-3.6,15.5c0,5.4,1.2,10.5,3.6,15.3
-		c2.4,4.8,5.8,8.6,10.3,11.5s9.6,4.3,15.4,4.3c5.6,0,10.6-1.4,15.1-4.1C2776.1,764.1,2779.6,760.4,2782.2,755.7z"/>
-	<path class="st0" d="M2843.5,788.4h-21.6l37.9-48l-36.4-46.6h22.6l25.7,33.3l25.8-33.3h21.6l-36.2,45.9l37.9,48.6h-22.6l-27.4-35
-		L2843.5,788.4z"/>
-</g>
-<path class="st0" d="M835.8,319.2c-11.5-18.9-27.4-33.7-47.6-44.7c-20.2-10.9-43-16.4-68.5-16.4h-90.6c-8.6,39.6-21.3,77.2-38,112.4
-	c-10,21-21.3,41-33.9,59.9v209.2H647v-135h72.7c25.4,0,48.3-5.5,68.5-16.4s36.1-25.8,47.6-44.7c11.5-18.9,17.3-39.5,17.3-61.9
-	C853.1,358.9,847.4,338.1,835.8,319.2z M747,416.6c-9.4,9-21.8,13.5-37,13.5l-62.8,0.4v-93.4l62.8-0.4c15.3,0,27.6,4.5,37,13.5
-	s14.1,20,14.1,33.2C761.1,396.6,756.4,407.7,747,416.6z"/>
-<path class="st1" d="M164.7,698.7c-3.5-16.5-10.4-49.6-11.3-49.6c-147.1-88-129.7-240.3-81-327.4C82.8,431.4,277,507.1,163.8,641.2
-	c-0.9,1.7,5.2,22.6,10.4,41.8c22.6-38.3,56.6-84.4,54.8-88.8C89.7,254.7,525,228.6,615.5,17.9c40.9,203.7-20.9,518.9-370.8,599
-	c-1.7,0.9-63.5,109.7-66.2,110.6c0-1.7-26.1-0.9-22.6-9.6C157.8,712.6,161.2,705.7,164.7,698.7L164.7,698.7z M160.4,616.9
-	c44.4-51.4-7.8-139.3-39.2-168C174.3,540.2,170.8,593.3,160.4,616.9L160.4,616.9z"/>
-</svg>

docs/changelog.rst

@@ -0,0 +1,159 @@
+Changelog
+#########
+
+* 0.3.2
+  * Fix for #172: defaulting ALLOWED_HOSTS to ``["*"]`` and allowing the user
+    to set her own value via ``PAPERLESS_ALLOWED_HOSTS`` should the need
+    arise.
+
+* 0.3.1
+  * Added a default value for ``CONVERT_BINARY``
+
+* 0.3.0
+  * Updated to using django-filter 1.x
+  * Added some system checks so new users aren't confused by misconfigurations.
+  * Consumer loop time is now configurable for systems with slow writes.  Just
+    set ``PAPERLESS_CONSUMER_LOOP_TIME`` to a number of seconds.  The default
+    is 10.
+  * As per `#44`_, we've removed support for ``PAPERLESS_CONVERT``,
+    ``PAPERLESS_CONSUME``, and ``PAPERLESS_SECRET``.  Please use
+    ``PAPERLESS_CONVERT_BINARY``, ``PAPERLESS_CONSUMPTION_DIR``, and
+    ``PAPERLESS_SHARED_SECRET`` respectively instead.
+
+* 0.2.0
+
+  * `#150`_: The media root is now a variable you can set in
+    ``paperless.conf``.
+  * `#148`_: The database location (sqlite) is now a variable you can set in
+    ``paperless.conf``.
+  * `#146`_: Fixed a bug that allowed unauthorised access to the `/fetch` URL.
+  * `#131`_: Document files are now automatically removed from disk when
+    they're deleted in Paperless.
+  * `#121`_: Fixed a bug where Paperless wasn't setting document creation time
+    based on the file naming scheme.
+  * `#81`_: Added a hook to run an arbitrary script after every document is
+    consumed.
+  * `#98`_: Added optional environment variables for ImageMagick so that it
+    doesn't explode when handling Very Large Documents or when it's just
+    running on a low-memory system.  Thanks to `Florian Harr`_ for his help on
+    this one.
+  * `#89`_ Ported the auto-tagging code to correspondents as well.  Thanks to
+    `Justin Snyman`_ for the pointers in the issue queue.
+  * Added support for guessing the date from the file name along with the
+    correspondent, title, and tags.  Thanks to `Tikitu de Jager`_ for his pull
+    request that I took forever to merge and to `Pit`_ for his efforts on the
+    regex front.
+  * `#94`_: Restored support for changing the created date in the UI.  Thanks
+    to `Martin Honermeyer`_ and `Tim White`_ for working with me on this.
+
+* 0.1.1
+
+  * Potentially **Breaking Change**: All references to "sender" in the code
+    have been renamed to "correspondent" to better reflect the nature of the
+    property (one could quite reasonably scan a document before sending it to
+    someone.)
+  * `#67`_: Rewrote the document exporter and added a new importer that allows
+    for full metadata retention without depending on the file name and
+    modification time.  A big thanks to `Tikitu de Jager`_, `Pit`_,
+    `Florian Jung`_, and `Christopher Luu`_ for their code snippets and
+    contributing conversation that lead to this change.
+  * `#20`_: Added *unpaper* support to help in cleaning up the scanned image
+    before it's OCR'd.  Thanks to `Pit`_ for this one.
+  * `#71`_ Added (encrypted) thumbnails in anticipation of a proper UI.
+  * `#68`_: Added support for using a proper config file at
+    ``/etc/paperless.conf`` and modified the systemd unit files to use it.
+  * Refactored the Vagrant installation process to use environment variables
+    rather than asking the user to modify ``settings.py``.
+  * `#44`_: Harmonise environment variable names with constant names.
+  * `#60`_: Setup logging to actually use the Python native logging framework.
+  * `#53`_: Fixed an annoying bug that caused ``.jpeg`` and ``.JPG`` images
+    to be imported but made unavailable.
+
+* 0.1.0
+
+  * Docker support!  Big thanks to `Wayne Werner`_, `Brian Conn`_, and
+    `Tikitu de Jager`_ for this one, and especially to `Pit`_
+    who spearheadded this effort.
+  * A simple REST API is in place, but it should be considered unstable.
+  * Cleaned up the consumer to use temporary directories instead of a single
+    scratch space.  (Thanks `Pit`_)
+  * Improved the efficiency of the consumer by parsing pages more intelligently
+    and introducing a threaded OCR process (thanks again `Pit`_).
+  * `#45`_: Cleaned up the logic for tag matching.  Reported by `darkmatter`_.
+  * `#47`_: Auto-rotate landscape documents.  Reported by `Paul`_ and fixed by
+    `Pit`_.
+  * `#48`_: Matching algorithms should do so on a word boundary (`darkmatter`_)
+  * `#54`_: Documented the re-tagger (`zedster`_)
+  * `#57`_: Make sure file is preserved on import failure (`darkmatter`_)
+  * Added tox with pep8 checking
+
+* 0.0.6
+
+  * Added support for parallel OCR (significant work from `Pit`_)
+  * Sped up the language detection (significant work from `Pit`_)
+  * Added simple logging
+
+* 0.0.5
+
+  * Added support for image files as documents (png, jpg, gif, tiff)
+  * Added a crude means of HTTP POST for document imports
+  * Added IMAP mail support
+  * Added a re-tagging utility
+  * Documentation for the above as well as data migration
+
+* 0.0.4
+
+  * Added automated tagging basted on keyword matching
+  * Cleaned up the document listing page
+  * Removed ``User`` and ``Group`` from the admin
+  * Added ``pytz`` to the list of requirements
+
+* 0.0.3
+
+  * Added basic tagging
+
+* 0.0.2
+
+  * Added language detection
+  * Added datestamps to ``document_exporter``.
+  * Changed ``settings.TESSERACT_LANGUAGE`` to ``settings.OCR_LANGUAGE``.
+
+* 0.0.1
+
+  * Initial release
+
+.. _Brian Conn: https://github.com/TheConnMan
+.. _Christopher Luu: https://github.com/nuudles
+.. _Florian Jung: https://github.com/the01
+.. _Tikitu de Jager: https://github.com/tikitu
+.. _Paul: https://github.com/polo2ro
+.. _Pit: https://github.com/pitkley
+.. _Wayne Werner: https://github.com/waynew
+.. _darkmatter: https://github.com/darkmatter
+.. _zedster: https://github.com/zedster
+.. _Martin Honermeyer: https://github.com/djmaze
+.. _Tim White: https://github.com/timwhite
+.. _Florian Harr: https://github.com/evils
+.. _Justin Snyman: https://github.com/stringlytyped
+
+.. _#20: https://github.com/danielquinn/paperless/issues/20
+.. _#44: https://github.com/danielquinn/paperless/issues/44
+.. _#45: https://github.com/danielquinn/paperless/issues/45
+.. _#47: https://github.com/danielquinn/paperless/issues/47
+.. _#48: https://github.com/danielquinn/paperless/issues/48
+.. _#53: https://github.com/danielquinn/paperless/issues/53
+.. _#54: https://github.com/danielquinn/paperless/issues/54
+.. _#57: https://github.com/danielquinn/paperless/issues/57
+.. _#60: https://github.com/danielquinn/paperless/issues/60
+.. _#67: https://github.com/danielquinn/paperless/issues/67
+.. _#68: https://github.com/danielquinn/paperless/issues/68
+.. _#71: https://github.com/danielquinn/paperless/issues/71
+.. _#81: https://github.com/danielquinn/paperless/issues/81
+.. _#89: https://github.com/danielquinn/paperless/issues/89
+.. _#94: https://github.com/danielquinn/paperless/issues/94
+.. _#98: https://github.com/danielquinn/paperless/issues/98
+.. _#121: https://github.com/danielquinn/paperless/issues/121
+.. _#131: https://github.com/danielquinn/paperless/issues/131
+.. _#146: https://github.com/danielquinn/paperless/issues/146
+.. _#148: https://github.com/danielquinn/paperless/pull/148
+.. _#150: https://github.com/danielquinn/paperless/pull/150

docs/conf.py

@@ -0,0 +1,364 @@
+# -*- coding: utf-8 -*-
+#
+# Paperless documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct 26 18:36:52 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+__version__ = None
+exec(open("../src/paperless/version.py").read())
+
+
+# Believe it or not, this is the officially sanctioned way to add custom CSS.
+def setup(app):
+    app.add_stylesheet("custom.css")
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.pngmath',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Paperless'
+copyright = u'2015, Daniel Quinn'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+
+#
+# If the build process ever explodes here, it's because you've set the version
+# number in paperless.version to a tuple with 3 numbers in it.
+#
+
+# The short X.Y version.
+version = ".".join([str(_) for _ in __version__[:2]])
+# The full version, including alpha/beta/rc tags.
+release = ".".join([str(_) for _ in __version__[:3]])
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'paperless'
+
+
+#
+# Attempt to use the ReadTheDocs theme.  If it's not installed, fallback to
+# the default.
+#
+
+try:
+    import sphinx_rtd_theme
+    html_theme = "sphinx_rtd_theme"
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except ImportError:
+    pass
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'paperless.tex', u'Paperless Documentation',
+   u'Daniel Quinn', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'paperless', u'Paperless Documentation',
+     [u'Daniel Quinn'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Paperless', u'Paperless Documentation',
+   u'Daniel Quinn', 'paperless', 'Scan, index, and archive all of your paper documents.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Paperless'
+epub_author = u'Daniel Quinn'
+epub_publisher = u'Daniel Quinn'
+epub_copyright = u'2015, Daniel Quinn'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = u'Paperless'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

docs/consumption.rst

@@ -0,0 +1,189 @@
+.. _consumption:
+
+Consumption
+###########
+
+Once you've got Paperless setup, you need to start feeding documents into it.
+Currently, there are three options: the consumption directory, IMAP (email), and
+HTTP POST.
+
+
+.. _consumption-directory:
+
+The Consumption Directory
+=========================
+
+The primary method of getting documents into your database is by putting them in
+the consumption directory.  The ``document_consumer`` script runs in an infinite
+loop looking for new additions to this directory and when it finds them, it goes
+about the process of parsing them with the OCR, indexing what it finds, and
+encrypting the PDF, storing it in the media directory.
+
+Getting stuff into this directory is up to you.  If you're running Paperless
+on your local computer, you might just want to drag and drop files there, but if
+you're running this on a server and want your scanner to automatically push
+files to this directory, you'll need to setup some sort of service to accept the
+files from the scanner.  Typically, you're looking at an FTP server like
+`Proftpd`_ or `Samba`_.
+
+.. _Proftpd: http://www.proftpd.org/
+.. _Samba: http://www.samba.org/
+
+So where is this consumption directory?  It's wherever you define it.  Look for
+the ``CONSUMPTION_DIR`` value in ``settings.py``.  Set that to somewhere
+appropriate for your use and put some documents in there.  When you're ready,
+follow the :ref:`consumer <utilities-consumer>` instructions to get it running.
+
+
+.. _consumption-directory-hook:
+
+Hooking into the Consumption Process
+------------------------------------
+
+Sometimes you may want to do something arbitrary whenever a document is
+consumed.  Rather than try to predict what you may want to do, Paperless lets
+you execute scripts of your own choosing just before or after a document is
+consumed using a couple simple hooks.
+
+Just write a script, put it somewhere that Paperless can read & execute, and
+then put the path to that script in ``paperless.conf`` with the variable name
+of either ``PAPERLESS_PRE_CONSUME_SCRIPT`` or
+``PAPERLESS_POST_CONSUME_SCRIPT``.  The script will be executed before or
+or after the document is consumed respectively.
+
+.. important::
+
+    These scripts are executed in a **blocking** process, which means that if
+    a script takes a long time to run, it can significantly slow down your
+    document consumption flow.  If you want things to run asynchronously,
+    you'll have to fork the process in your script and exit.
+
+
+.. _consumption-directory-hook-variables:
+
+What Can These Scripts Do?
+..........................
+
+It's your script, so you're only limited by your imagination and the laws of
+physics.  However, the following values are passed to the scripts in order:
+
+
+.. _consumption-director-hook-variables-pre:
+
+Pre-consumption script
+::::::::::::::::::::::
+
+* Document file name
+
+
+.. _consumption-director-hook-variables-post:
+
+Post-consumption script
+:::::::::::::::::::::::
+
+* Document id
+* Generated file name
+* Source path
+* Thumbnail path
+* Download URL
+* Thumbnail URL
+* Correspondent
+* Tags
+
+The script can be in any language you like, but for a simple shell script
+example, you can take a look at ``post-consumption-example.sh`` in the
+``scripts`` directory in this project.
+
+
+.. _consumption-imap:
+
+IMAP (Email)
+============
+
+Another handy way to get documents into your database is to email them to
+yourself.  The typical use-case would be to be out for lunch and want to send a
+copy of the receipt back to your system at home.  Paperless can be taught to
+pull emails down from an arbitrary account and dump them into the consumption
+directory where the process :ref:`above <consumption-directory>` will follow the
+usual pattern on consuming the document.
+
+Some things you need to know about this feature:
+
+* It's disabled by default.  By setting the values below it will be enabled.
+* It's been tested in a limited environment, so it may not work for you (please
+  submit a pull request if you can!)
+* It's designed to **delete mail from the server once consumed**.  So don't go
+  pointing this to your personal email account and wonder where all your stuff
+  went.
+* Currently, only one photo (attachment) per email will work.
+
+So, with all that in mind, here's what you do to get it running:
+
+1. Setup a new email account somewhere, or if you're feeling daring, create a
+   folder in an existing email box and note the path to that folder.
+2. In ``settings.py`` set all of the appropriate values in ``MAIL_CONSUMPTION``.
+   If you decided to use a subfolder of an existing account, then make sure you
+   set ``INBOX`` accordingly here.  You also have to set the
+   ``UPLOAD_SHARED_SECRET`` to something you can remember 'cause you'll have to
+   include that in every email you send.
+3. Restart the :ref:`consumer <utilities-consumer>`.  The consumer will check
+   the configured email account every 10 minutes for something new and pull down
+   whatever it finds.
+4. Send yourself an email!  Note that the subject is treated as the file name,
+   so if you set the subject to ``Correspondent - Title - tag,tag,tag``, you'll
+   get what you expect.  Also, you must include the aforementioned secret
+   string in every email so the fetcher knows that it's safe to import.
+5. After a few minutes, the consumer will poll your mailbox, pull down the
+   message, and place the attachment in the consumption directory with the
+   appropriate name.  A few minutes later, the consumer will import it like any
+   other file.
+
+
+.. _consumption-http:
+
+HTTP POST
+=========
+
+You can also submit a document via HTTP POST.  It doesn't do tags yet, and the
+URL schema isn't concrete, but it's a start.
+
+To push your document to Paperless, send an HTTP POST to the server with the
+following name/value pairs:
+
+* ``correspondent``: The name of the document's correspondent.  Note that there
+  are restrictions on what characters you can use here.  Specifically,
+  alphanumeric characters, `-`, `,`, `.`, and `'` are ok, everything else it
+  out.  You also can't use the sequence ` - ` (space, dash, space).
+* ``title``: The title of the document.  The rules for characters is the same
+  here as the correspondent.
+* ``signature``: For security reasons, we have the correspondent send a
+  signature using a "shared secret" method to make sure that random strangers
+  don't start uploading stuff to your server.  The means of generating this
+  signature is defined below.
+
+Specify ``enctype="multipart/form-data"``, and then POST your file with::
+
+    Content-Disposition: form-data; name="document"; filename="whatever.pdf"
+
+
+.. _consumption-http-signature:
+
+Generating the Signature
+------------------------
+
+Generating a signature based a shared secret is pretty simple: define a secret,
+and store it on the server and the client.  Then use that secret, along with
+the text you want to verify to generate a string that you can use for
+verification.
+
+In the case of Paperless, you configure the server with the secret by setting
+``UPLOAD_SHARED_SECRET``.  Then on your client, you generate your signature by
+concatenating the correspondent, title, and the secret, and then using sha256
+to generate a hexdigest.
+
+If you're using Python, this is what that looks like:
+
+.. code:: python
+
+    from hashlib import sha256
+    signature = sha256(correspondent + title + secret).hexdigest()

docs/development.md

@@ -1,465 +0,0 @@
-# Development
-
-This section describes the steps you need to take to start development
-on Paperless-ngx.
-
-Check out the source from GitHub. The repository is organized in the
-following way:
-
-- `main` always represents the latest release and will only see
-  changes when a new release is made.
-- `dev` contains the code that will be in the next release.
-- `feature-X` contain bigger changes that will be in some release, but
-  not necessarily the next one.
-
-When making functional changes to Paperless-ngx, _always_ make your changes
-on the `dev` branch.
-
-Apart from that, the folder structure is as follows:
-
-- `docs/` - Documentation.
-- `src-ui/` - Code of the front end.
-- `src/` - Code of the back end.
-- `scripts/` - Various scripts that help with different parts of
-  development.
-- `docker/` - Files required to build the docker image.
-
-## Contributing to Paperless-ngx
-
-Maybe you've been using Paperless-ngx for a while and want to add a feature
-or two, or maybe you've come across a bug that you have some ideas how
-to solve. The beauty of open source software is that you can see what's
-wrong and help to get it fixed for everyone!
-
-Before contributing please review our [code of
-conduct](https://github.com/paperless-ngx/paperless-ngx/blob/main/CODE_OF_CONDUCT.md)
-and other important information in the [contributing
-guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md).
-
-## Code formatting with pre-commit hooks
-
-To ensure a consistent style and formatting across the project source,
-the project utilizes Git [`pre-commit`](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
-hooks to perform some formatting and linting before a commit is allowed.
-That way, everyone uses the same style and some common issues can be caught
-early on.
-
-Once installed, hooks will run when you commit. If the formatting isn't
-quite right or a linter catches something, the commit will be rejected.
-You'll need to look at the output and fix the issue. Some hooks, such
-as the Python formatting tool `black`, will format failing
-files, so all you need to do is `git add` those files again
-and retry your commit.
-
-## General setup
-
-After you forked and cloned the code from GitHub you need to perform a
-first-time setup.
-
-!!! note
-
-    Every command is executed directly from the root folder of the project unless specified otherwise.
-
-1.  Install prerequisites + pipenv as mentioned in
-    [Bare metal route](/setup#bare_metal).
-
-2.  Copy `paperless.conf.example` to `paperless.conf` and enable debug
-    mode within the file via `PAPERLESS_DEBUG=true`.
-
-3.  Create `consume` and `media` directories:
-
-    ```bash
-    $ mkdir -p consume media
-    ```
-
-4.  Install the Python dependencies:
-
-    ```bash
-    $ pipenv install --dev
-    ```
-
-    !!! note
-
-        Using a virtual environment is highly recommended. You can spawn one via `pipenv shell`.
-        Make sure you're using Python 3.10.x or lower. Otherwise you might
-        get issues with building dependencies. You can use
-        [pyenv](https://github.com/pyenv/pyenv) to install a specific
-        Python version.
-
-5.  Install pre-commit hooks:
-
-    ```bash
-    $ pre-commit install
-    ```
-
-6.  Apply migrations and create a superuser for your development instance:
-
-    ```bash
-    # src/
-
-    $ python3 manage.py migrate
-    $ python3 manage.py createsuperuser
-    ```
-
-7.  You can now either ...
-
-    - install redis or
-
-    - use the included `scripts/start_services.sh` to use docker to fire
-      up a redis instance (and some other services such as tika,
-      gotenberg and a database server) or
-
-    - spin up a bare redis container
-
-      ```
-      $ docker run -d -p 6379:6379 --restart unless-stopped redis:latest
-      ```
-
-8.  Continue with either back-end or front-end development – or both :-).
-
-## Back end development
-
-The back end is a [Django](https://www.djangoproject.com/) application.
-[PyCharm](https://www.jetbrains.com/de-de/pycharm/) as well as [Visual Studio Code](https://code.visualstudio.com)
-work well for development, but you can use whatever you want.
-
-Configure the IDE to use the `src/`-folder as the base source folder.
-Configure the following launch configurations in your IDE:
-
-- `python3 manage.py runserver`
-- `python3 manage.py document_consumer`
-- `celery --app paperless worker -l DEBUG` (or any other log level)
-
-To start them all:
-
-```bash
-# src/
-
-$ python3 manage.py runserver & \
-  python3 manage.py document_consumer & \
-  celery --app paperless worker -l DEBUG
-```
-
-You might need the front end to test your back end code.
-This assumes that you have AngularJS installed on your system.
-Go to the [Front end development](#front-end-development) section for further details.
-To build the front end once use this command:
-
-```bash
-# src-ui/
-
-$ npm install
-$ ng build --configuration production
-```
-
-### Testing
-
-- Run `pytest` in the `src/` directory to execute all tests. This also
-  generates a HTML coverage report. When runnings test, `paperless.conf`
-  is loaded as well. However, the tests rely on the default
-  configuration. This is not ideal. But for now, make sure no settings
-  except for DEBUG are overridden when testing.
-
-!!! note
-
-      The line length rule E501 is generally useful for getting multiple
-      source files next to each other on the screen. However, in some
-      cases, its just not possible to make some lines fit, especially
-      complicated IF cases. Append `# noqa: E501` to disable this check
-      for certain lines.
-
-## Front end development
-
-The front end is built using AngularJS. In order to get started, you need Node.js (version 14.15+) and
-`npm`.
-
-!!! note
-
-    The following commands are all performed in the `src-ui`-directory. You will need a running back end (including an active session) to connect to the back end API. To spin it up refer to the commands under the section [above](#back-end-development).
-
-1. Install the Angular CLI. You might need sudo privileges
-   to perform this command:
-
-   ```bash
-   $ npm install -g @angular/cli
-   ```
-
-2. Make sure that it's on your path.
-
-3. Install all necessary modules:
-
-   ```bash
-   $ npm install
-   ```
-
-4. You can launch a development server by running:
-
-   ```bash
-   $ ng serve
-   ```
-
-   This will automatically update whenever you save. However, in-place
-   compilation might fail on syntax errors, in which case you need to
-   restart it.
-
-   By default, the development server is available on `http://localhost:4200/` and is configured to access the API at
-   `http://localhost:8000/api/`, which is the default of the backend. If you enabled `DEBUG` on the back end, several security overrides for allowed hosts, CORS and X-Frame-Options are in place so that the front end behaves exactly as in production.
-
-### Testing and code style
-
-- The front end code (.ts, .html, .scss) use `prettier` for code
-  formatting via the Git `pre-commit` hooks which run automatically on
-  commit. See [above](#code-formatting-with-pre-commit-hooks) for installation instructions. You can also run this via the CLI with a
-  command such as
-
-  ```bash
-  $ git ls-files -- '*.ts' | xargs pre-commit run prettier --files
-  ```
-
-- Front end testing uses Jest and Playwright. Unit tests and e2e tests,
-  respectively, can be run non-interactively with:
-
-  ```bash
-  $ ng test
-  $ npx playwright test
-  ```
-
-  - Playwright also includes a UI which can be run with:
-
-    ```bash
-    $ npx playwright test --ui
-    ```
-
-- In order to build the front end and serve it as part of Django, execute:
-
-  ```bash
-  $ ng build --configuration production
-  ```
-
-  This will build the front end and put it in a location from which the
-  Django server will serve it as static content. This way, you can verify
-  that authentication is working.
-
-## Localization
-
-Paperless-ngx is available in many different languages. Since Paperless-ngx
-consists both of a Django application and an AngularJS front end, both
-these parts have to be translated separately.
-
-### Front end localization
-
-- The AngularJS front end does localization according to the [Angular
-  documentation](https://angular.io/guide/i18n).
-- The source language of the project is "en_US".
-- The source strings end up in the file `src-ui/messages.xlf`.
-- The translated strings need to be placed in the
-  `src-ui/src/locale/` folder.
-- In order to extract added or changed strings from the source files,
-  call `ng extract-i18n`.
-
-Adding new languages requires adding the translated files in the
-`src-ui/src/locale/` folder and adjusting a couple files.
-
-1.  Adjust `src-ui/angular.json`:
-
-    ```json
-    "i18n": {
-        "sourceLocale": "en-US",
-        "locales": {
-            "de": "src/locale/messages.de.xlf",
-            "nl-NL": "src/locale/messages.nl_NL.xlf",
-            "fr": "src/locale/messages.fr.xlf",
-            "en-GB": "src/locale/messages.en_GB.xlf",
-            "pt-BR": "src/locale/messages.pt_BR.xlf",
-            "language-code": "language-file"
-        }
-    }
-    ```
-
-2.  Add the language to the available options in
-    `src-ui/src/app/services/settings.service.ts`:
-
-    ```typescript
-    getLanguageOptions(): LanguageOption[] {
-        return [
-            {code: "en-us", name: $localize`English (US)`, englishName: "English (US)", dateInputFormat: "mm/dd/yyyy"},
-            {code: "en-gb", name: $localize`English (GB)`, englishName: "English (GB)", dateInputFormat: "dd/mm/yyyy"},
-            {code: "de", name: $localize`German`, englishName: "German", dateInputFormat: "dd.mm.yyyy"},
-            {code: "nl", name: $localize`Dutch`, englishName: "Dutch", dateInputFormat: "dd-mm-yyyy"},
-            {code: "fr", name: $localize`French`, englishName: "French", dateInputFormat: "dd/mm/yyyy"},
-            {code: "pt-br", name: $localize`Portuguese (Brazil)`, englishName: "Portuguese (Brazil)", dateInputFormat: "dd/mm/yyyy"}
-            // Add your new language here
-        ]
-    }
-    ```
-
-    `dateInputFormat` is a special string that defines the behavior of
-    the date input fields and absolutely needs to contain "dd", "mm"
-    and "yyyy".
-
-3.  Import and register the Angular data for this locale in
-    `src-ui/src/app/app.module.ts`:
-
-    ```typescript
-    import localeDe from '@angular/common/locales/de'
-    registerLocaleData(localeDe)
-    ```
-
-### Back end localization
-
-A majority of the strings that appear in the back end appear only when
-the admin is used. However, some of these are still shown on the front
-end (such as error messages).
-
-- The django application does localization according to the [Django
-  documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/translation/).
-- The source language of the project is "en_US".
-- Localization files end up in the folder `src/locale/`.
-- In order to extract strings from the application, call
-  `python3 manage.py makemessages -l en_US`. This is important after
-  making changes to translatable strings.
-- The message files need to be compiled for them to show up in the
-  application. Call `python3 manage.py compilemessages` to do this.
-  The generated files don't get committed into git, since these are
-  derived artifacts. The build pipeline takes care of executing this
-  command.
-
-Adding new languages requires adding the translated files in the
-`src/locale/`-folder and adjusting the file
-`src/paperless/settings.py` to include the new language:
-
-```python
-LANGUAGES = [
-    ("en-us", _("English (US)")),
-    ("en-gb", _("English (GB)")),
-    ("de", _("German")),
-    ("nl-nl", _("Dutch")),
-    ("fr", _("French")),
-    ("pt-br", _("Portuguese (Brazil)")),
-    # Add language here.
-]
-```
-
-## Building the documentation
-
-The documentation is built using material-mkdocs, see their [documentation](https://squidfunk.github.io/mkdocs-material/reference/).
-If you want to build the documentation locally, this is how you do it:
-
-1.  Have an active pipenv shell (`pipenv shell`) and install Python dependencies:
-
-    ```bash
-    $ pipenv install --dev
-    ```
-
-2.  Build the documentation
-
-    ```bash
-    $ mkdocs build --config-file mkdocs.yml
-    ```
-
-    _alternatively..._
-
-3.  Serve the documentation. This will spin up a
-    copy of the documentation at http://127.0.0.1:8000
-    that will automatically refresh every time you change
-    something.
-
-    ```bash
-    $ mkdocs serve
-    ```
-
-## Building the Docker image
-
-The docker image is primarily built by the GitHub actions workflow, but
-it can be faster when developing to build and tag an image locally.
-
-Building the image works as with any image:
-
-```
-docker build --file Dockerfile --tag paperless:local --progress simple .
-```
-
-## Extending Paperless-ngx
-
-Paperless-ngx does not have any fancy plugin systems and will probably never
-have. However, some parts of the application have been designed to allow
-easy integration of additional features without any modification to the
-base code.
-
-### Making custom parsers
-
-Paperless-ngx uses parsers to add documents. A parser is
-responsible for:
-
-- Retrieving the content from the original
-- Creating a thumbnail
-- _optional:_ Retrieving a created date from the original
-- _optional:_ Creating an archived document from the original
-
-Custom parsers can be added to Paperless-ngx to support more file types. In
-order to do that, you need to write the parser itself and announce its
-existence to Paperless-ngx.
-
-The parser itself must extend `documents.parsers.DocumentParser` and
-must implement the methods `parse` and `get_thumbnail`. You can provide
-your own implementation to `get_date` if you don't want to rely on
-Paperless-ngx' default date guessing mechanisms.
-
-```python
-class MyCustomParser(DocumentParser):
-
-    def parse(self, document_path, mime_type):
-        # This method does not return anything. Rather, you should assign
-        # whatever you got from the document to the following fields:
-
-        # The content of the document.
-        self.text = "content"
-
-        # Optional: path to a PDF document that you created from the original.
-        self.archive_path = os.path.join(self.tempdir, "archived.pdf")
-
-        # Optional: "created" date of the document.
-        self.date = get_created_from_metadata(document_path)
-
-    def get_thumbnail(self, document_path, mime_type):
-        # This should return the path to a thumbnail you created for this
-        # document.
-        return os.path.join(self.tempdir, "thumb.webp")
-```
-
-If you encounter any issues during parsing, raise a
-`documents.parsers.ParseError`.
-
-The `self.tempdir` directory is a temporary directory that is guaranteed
-to be empty and removed after consumption finished. You can use that
-directory to store any intermediate files and also use it to store the
-thumbnail / archived document.
-
-After that, you need to announce your parser to Paperless-ngx. You need to
-connect a handler to the `document_consumer_declaration` signal. Have a
-look in the file `src/paperless_tesseract/apps.py` on how that's done.
-The handler is a method that returns information about your parser:
-
-```python
-def myparser_consumer_declaration(sender, **kwargs):
-    return {
-        "parser": MyCustomParser,
-        "weight": 0,
-        "mime_types": {
-            "application/pdf": ".pdf",
-            "image/jpeg": ".jpg",
-        }
-    }
-```
-
-- `parser` is a reference to a class that extends `DocumentParser`.
-- `weight` is used whenever two or more parsers are able to parse a
-  file: The parser with the higher weight wins. This can be used to
-  override the parsers provided by Paperless-ngx.
-- `mime_types` is a dictionary. The keys are the mime types your
-  parser supports and the value is the default file extension that
-  Paperless-ngx should use when storing files and serving them for
-  download. We could guess that from the file extensions, but some
-  mime types have many extensions associated with them and the Python
-  methods responsible for guessing the extension do not always return
-  the same value.

docs/faq.md

@@ -1,129 +0,0 @@
-# Frequently Asked Questions
-
-## _What's the general plan for Paperless-ngx?_
-
-**A:** While Paperless-ngx is already considered largely
-"feature-complete" it is a community-driven project and development
-will be guided in this way. New features can be submitted via GitHub
-discussions and "up-voted" by the community but this is not a
-guarantee the feature will be implemented. This project will always be
-open to collaboration in the form of PRs, ideas etc.
-
-## _I'm using docker. Where are my documents?_
-
-**A:** Your documents are stored inside the docker volume
-`paperless_media`. Docker manages this volume automatically for you. It
-is a persistent storage and will persist as long as you don't
-explicitly delete it. The actual location depends on your host operating
-system. On Linux, chances are high that this location is
-
-```
-/var/lib/docker/volumes/paperless_media/_data
-```
-
-!!! warning
-
-    Do not mess with this folder. Don't change permissions and don't move
-    files around manually. This folder is meant to be entirely managed by
-    docker and paperless.
-
-!!! note
-
-    Files consumed from the consumption directory are re-created inside
-    this media directory and are removed from the consumption directory
-    itself.
-
-## Let's say I want to switch tools in a year. Can I easily move to other systems?
-
-**A:** Your documents are stored as plain files inside the media folder.
-You can always drag those files out of that folder to use them
-elsewhere. Here are a couple notes about that.
-
-- Paperless-ngx never modifies your original documents. It keeps
-  checksums of all documents and uses a scheduled sanity checker to
-  check that they remain the same.
-- By default, paperless uses the internal ID of each document as its
-  filename. This might not be very convenient for export. However, you
-  can adjust the way files are stored in paperless by
-  [configuring the filename format](/advanced_usage#file-name-handling).
-- [The exporter](/administration#exporter) is
-  another easy way to get your files out of paperless with reasonable
-  file names.
-
-## _What file types does paperless-ngx support?_
-
-**A:** Currently, the following files are supported:
-
-- PDF documents, PNG images, JPEG images, TIFF images, GIF images and
-  WebP images are processed with OCR and converted into PDF documents.
-- Plain text documents are supported as well and are added verbatim to
-  paperless.
-- With the optional Tika integration enabled (see [Tika configuration](/configuration#tika),
-  Paperless also supports various Office documents (.docx, .doc, odt,
-  .ppt, .pptx, .odp, .xls, .xlsx, .ods).
-
-Paperless-ngx determines the type of a file by inspecting its content.
-The file extensions do not matter.
-
-## _Will paperless-ngx run on Raspberry Pi?_
-
-**A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B.
-The long answer is that certain parts of Paperless will run very slow,
-such as the OCR. On Raspberry Pi, try to OCR documents before feeding
-them into paperless so that paperless can reuse the text. The web
-interface is a lot snappier, since it runs in your browser and paperless
-has to do much less work to serve the data.
-
-!!! note
-
-    You can adjust some of the settings so that paperless uses less
-    processing power. See [setup](/setup#less-powerful-devices) for details.
-
-## _How do I install paperless-ngx on Raspberry Pi?_
-
-**A:** Docker images are available for armv7 and arm64 hardware, so just
-follow the docker-compose instructions. Apart from more required disk
-space compared to a bare metal installation, docker comes with close to
-zero overhead, even on Raspberry Pi.
-
-If you decide to got with the bare metal route, be aware that some of
-the python requirements do not have precompiled packages for ARM /
-ARM64. Installation of these will require additional development
-libraries and compilation will take a long time.
-
-## _How do I run this on Unraid?_
-
-**A:** Paperless-ngx is available as [community
-app](https://unraid.net/community/apps?q=paperless-ngx) in Unraid. [Uli
-Fahrer](https://github.com/Tooa) created a container template for that.
-
-## _How do I run this on my toaster?_
-
-**A:** I honestly don't know! As for all other devices that might be
-able to run paperless, you're a bit on your own. If you can't run the
-docker image, the documentation has instructions for bare metal
-installs. I'm running paperless on an i3 processor from 2015 or so.
-This is also what I use to test new releases with. Apart from that, I
-also have a Raspberry Pi, which I occasionally build the image on and
-see if it works.
-
-## _How do I proxy this with NGINX?_
-
-**A:** See [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx).
-
-## _How do I get WebSocket support with Apache mod_wsgi_?
-
-**A:** `mod_wsgi` by itself does not support ASGI. Paperless will
-continue to work with WSGI, but certain features such as status
-notifications about document consumption won't be available.
-
-If you want to continue using `mod_wsgi`, you will have to run an
-ASGI-enabled web server as well that processes WebSocket connections,
-and configure Apache to redirect WebSocket connections to this server.
-Multiple options for ASGI servers exist:
-
-- `gunicorn` with `uvicorn` as the worker implementation (the default
-  of paperless)
-- `daphne` as a standalone server, which is the reference
-  implementation for ASGI.
-- `uvicorn` as a standalone server

docs/guesswork.rst

@@ -0,0 +1,85 @@
+.. _guesswork:
+
+Guesswork
+#########
+
+During the consumption process, Paperless tries to guess some of the attributes
+of the document it's looking at.  To do this it uses two approaches:
+
+
+.. _guesswork-naming:
+
+File Naming
+===========
+
+Any document you put into the consumption directory will be consumed, but if
+you name the file right, it'll automatically set some values in the database
+for you.  This is is the logic the consumer follows:
+
+1. Try to find the correspondent, title, and tags in the file name following
+   the pattern: ``Date - Correspondent - Title - tag,tag,tag.pdf``.  Note that
+   the format of the date is **rigidly defined** as ``YYYYMMDDHHMMSSZ`` or
+   ``YYYYMMDDZ``.  The ``Z`` refers "Zulu time" AKA "UTC".
+2. If that doesn't work, we skip the date and try this pattern:
+   ``Correspondent - Title - tag,tag,tag.pdf``.
+3. If that doesn't work, we try to find the correspondent and title in the file
+   name following the pattern: ``Correspondent - Title.pdf``.
+4. If that doesn't work, just assume that the name of the file is the title.
+
+So given the above, the following examples would work as you'd expect:
+
+* ``20150314000700Z - Some Company Name - Invoice 2016-01-01 - money,invoices.pdf``
+* ``20150314Z - Some Company Name - Invoice 2016-01-01 - money,invoices.pdf``
+* ``Some Company Name - Invoice 2016-01-01 - money,invoices.pdf``
+* ``Another Company - Letter of Reference.jpg``
+* ``Dad's Recipe for Pancakes.png``
+
+These however wouldn't work:
+
+* ``2015-03-14 00:07:00 UTC - Some Company Name, Invoice 2016-01-01, money, invoices.pdf``
+* ``2015-03-14 - Some Company Name, Invoice 2016-01-01, money, invoices.pdf``
+* ``Some Company Name, Invoice 2016-01-01, money, invoices.pdf``
+* ``Another Company- Letter of Reference.jpg``
+
+
+.. _guesswork-content:
+
+Reading the Document Contents
+=============================
+
+After the consumer has tried to figure out what it could from the file name,
+it starts looking at the content of the document itself.  It will compare the
+matching algorithms defined by every tag and correspondent already set in your
+database to see if they apply to the text in that document.  In other words,
+if you defined a tag called ``Home Utility`` that had a ``match`` property of
+``bc hydro`` and a ``matching_algorithm`` of ``literal``, Paperless will
+automatically tag your newly-consumed document with your ``Home Utility`` tag
+so long as the text ``bc hydro`` appears in the body of the document somewhere.
+
+The matching logic is quite powerful, and supports searching the text of your
+document with different algorithms, and as such, some experimentation may be
+necessary to get things Just Right.
+
+
+.. _guesswork-content-howto:
+
+How Do I Set Up These Matching Algorithms?
+------------------------------------------
+
+Setting up of the algorithms is easily done through the admin interface.  When
+you create a new correspondent or tag, there are optional fields for matching
+text and matching algorithm.  From the help info there:
+
+.. note::
+
+    Which algorithm you want to use when matching text to the OCR'd PDF.  Here,
+    "any" looks for any occurrence of any word provided in the PDF, while "all"
+    requires that every word provided appear in the PDF, albeit not in the
+    order provided.  A "literal" match means that the text you enter must
+    appear in the PDF exactly as you've entered it, and "regular expression"
+    uses a regex to match the PDF.  If you don't know what a regex is, you
+    probably don't want this option.
+
+Then just save your tag/correspondent and run another document through the
+consumer.  Once complete, you should see the newly-created document,
+automatically tagged with the appropriate data.

docs/index.md

@@ -1,138 +0,0 @@
-<div class="grid-left" markdown>
-![image](assets/logo_full_black.svg#only-light){.index-logo}
-![image](assets/logo_full_white.svg#only-dark){.index-logo}
-
-**Paperless-ngx** is a _community-supported_ open-source document management system that transforms your
-physical documents into a searchable online archive so you can keep, well, _less paper_.
-
-[Get started](/setup){ .md-button .md-button--primary .index-callout }
-[Demo](https://demo.paperless-ngx.com){ .md-button .md-button--secondary target=\_blank }
-
-</div>
-<div class="grid-right" markdown>
-![image](assets/screenshots/documents-smallcards.png#only-light){.index-screenshot}
-![image](assets/screenshots/documents-smallcards-dark.png#only-dark){.index-screenshot}
-</div>
-<div class="clear"></div>
-
-## Why This Exists
-
-Paper is a nightmare. Environmental issues aside, there's no excuse for
-it in the 21st century. It takes up space, collects dust, doesn't
-support any form of a search feature, indexing is tedious, it's heavy
-and prone to damage & loss.
-
-This software is designed to make "going paperless" easier. No more worrying
-about finding stuff again, feed documents right from the post box into
-the scanner and then shred them. Perhaps you might find it useful too.
-
-## Paperless, a history
-
-Paperless is a simple Django application running in two parts: a
-_Consumer_ (the thing that does the indexing) and the _Web server_ (the
-part that lets you search & download already-indexed documents). If you
-want to learn more about its functions keep on reading after the
-installation section.
-
-Paperless-ngx is a document management system that transforms your
-physical documents into a searchable online archive so you can keep,
-well, _less paper_.
-
-Paperless-ngx forked from paperless-ng to continue the great work and
-distribute responsibility of supporting and advancing the project among
-a team of people.
-
-NG stands for both Angular (the framework used for the Frontend) and
-next-gen. Publishing this project under a different name also avoids
-confusion between paperless and paperless-ngx.
-
-If you want to learn about what's different in paperless-ngx from
-Paperless, check out these resources in the documentation:
-
-- [Some screenshots](#screenshots) of the new UI are available.
-- Read [this section](/advanced_usage#automatic-matching) if you want to learn about how paperless automates all
-  tagging using machine learning.
-- Paperless now comes with a [proper email consumer](/usage#usage-email) that's fully tested and production ready.
-- 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 [this note](/administration#encryption) about GnuPG encryption in paperless-ngx.
-- Paperless is now integrated with a
-  [task processing queue](/setup#task_processor) that tells you at a glance when and why something is not working.
-- The [changelog](/changelog) contains a detailed list of all changes in paperless-ngx.
-
-## Screenshots
-
-This is what Paperless-ngx looks like.
-
-The dashboard shows customizable views on your document and allows
-document uploads:
-
-[![image](assets/screenshots/dashboard.png)](assets/screenshots/dashboard.png)
-
-The document list provides three different styles to scroll through your
-documents:
-
-[![image](assets/screenshots/documents-table.png)](assets/screenshots/documents-table.png)
-
-[![image](assets/screenshots/documents-smallcards.png)](assets/screenshots/documents-smallcards.png)
-
-[![image](assets/screenshots/documents-largecards.png)](assets/screenshots/documents-largecards.png)
-
-Paperless-ngx also supports dark mode:
-
-[![image](assets/screenshots/documents-smallcards-dark.png)](assets/screenshots/documents-smallcards-dark.png)
-
-Extensive filtering mechanisms:
-
-[![image](assets/screenshots/documents-filter.png)](assets/screenshots/documents-filter.png)
-
-Bulk editing of document tags, correspondents, etc.:
-
-[![image](assets/screenshots/bulk-edit.png)](assets/screenshots/bulk-edit.png)
-
-Side-by-side editing of documents:
-
-[![image](assets/screenshots/editing.png)](assets/screenshots/editing.png)
-
-Tag editing. This looks about the same for correspondents and document
-types.
-
-[![image](assets/screenshots/new-tag.png)](assets/screenshots/new-tag.png)
-
-Searching provides auto complete and highlights the results.
-
-[![image](assets/screenshots/search-preview.png)](assets/screenshots/search-preview.png)
-
-[![image](assets/screenshots/search-results.png)](assets/screenshots/search-results.png)
-
-Fancy mail filters!
-
-[![image](assets/screenshots/mail-rules-edited.png)](assets/screenshots/mail-rules-edited.png)
-
-Mobile devices are supported.
-
-[![image](assets/screenshots/mobile.png)](assets/screenshots/mobile.png)
-
-## Support
-
-Community support is available via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/) and [the Matrix chat room](https://matrix.to/#/#paperless:matrix.org).
-
-### Feature Requests
-
-Feature requests can be submitted via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests) where you can search for existing ideas, add your own and vote for the ones you care about.
-
-### Bugs
-
-For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/issues) or [start a discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/support) if you have questions.
-
-## Contributing
-
-People interested in continuing the work on paperless-ngx are encouraged to reach out on [GitHub](https://github.com/paperless-ngx/paperless-ngx) or [the Matrix chat room](https://matrix.to/#/#paperless:matrix.org). If you would like to contribute to the project on an ongoing basis there are multiple teams (frontend, ci/cd, etc) that could use your help so please reach out!
-
-### Translation
-
-Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you!
-
-## Scanners & Software
-
-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](https://github.com/paperless-ngx/paperless-ngx/wiki/Scanner-&-Software-Recommendations).

docs/index.rst

@@ -0,0 +1,38 @@
+.. _index:
+
+Paperless
+=========
+
+Scan, index, and archive all of your paper documents.  Say goodbye to paper.
+
+
+.. _index-why-this-exists:
+
+Why This Exists
+===============
+
+Paper is a nightmare.  Environmental issues aside, there's no excuse for it in
+the 21st century.  It takes up space, collects dust, doesn't support any form of
+a search feature, indexing is tedious, it's heavy and prone to damage & loss.
+
+I wrote this to make "going paperless" easier.  I wanted to be able to feed
+documents right from the post box into the scanner and then shred them so I
+never have to worry about finding stuff again.  Perhaps you might find it useful
+too.
+
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   requirements
+   setup
+   consumption
+   api
+   utilities
+   guesswork
+   migrating
+   troubleshooting
+   changelog

docs/migrating.rst

@@ -0,0 +1,108 @@
+.. _migrating:
+
+Migrating, Updates, and Backups
+===============================
+
+As Paperless is still under active development, there's a lot that can change
+as software updates roll out.  You should backup often, so if anything goes
+wrong during an update, you at least have a means of restoring to something
+usable.  Thankfully, there are automated ways of backing up, restoring, and
+updating the software.
+
+
+.. _migrating-backup:
+
+Backing Up
+----------
+
+So you're bored of this whole project, or you want to make a remote backup of
+the unencrypted files for whatever reason.  This is easy to do, simply use the
+:ref:`exporter <utilities-exporter>` to dump your documents and database out
+into an arbitrary directory.
+
+
+.. _migrating-restoring:
+
+Restoring
+---------
+
+Restoring your data is just as easy, since nearly all of your data exists either
+in the file names, or in the contents of the files themselves.  You just need to
+create an empty database (just follow the
+:ref:`installation instructions <setup-installation>` again) and then import the
+``tags.json`` file you created as part of your backup.  Lastly, copy your
+exported documents into the consumption directory and start up the consumer.
+
+.. code-block:: shell-session
+
+    $ cd /path/to/project
+    $ rm data/db.sqlite3  # Delete the database
+    $ cd src
+    $ ./manage.py migrate  # Create the database
+    $ ./manage.py createsuperuser
+    $ ./manage.py loaddata /path/to/arbitrary/place/tags.json
+    $ cp /path/to/exported/docs/* /path/to/consumption/dir/
+    $ ./manage.py document_consumer
+
+Importing your data if you are :ref:`using Docker <setup-installation-docker>`
+is almost as simple:
+
+.. code-block:: shell-session
+
+    # Stop and remove your current containers
+    $ docker-compose stop
+    $ docker-compose rm -f
+
+    # Recreate them, add the superuser
+    $ docker-compose up -d
+    $ docker-compose run --rm webserver createsuperuser
+
+    # Load the tags
+    $ cat /path/to/arbitrary/place/tags.json | docker-compose run --rm webserver loaddata_stdin -
+
+    # Load your exported documents into the consumption directory
+    # (How you do this highly depends on how you have set this up)
+    $ cp /path/to/exported/docs/* /path/to/mounted/consumption/dir/
+
+After loading the documents into the consumption directory the consumer will
+immediately start consuming the documents.
+
+
+.. _migrating-updates:
+
+Updates
+-------
+
+For the most part, all you have to do to update Paperless is run ``git pull``
+on the directory containing the project files, and then use Django's
+``migrate`` command to execute any database schema updates that might have been
+rolled in as part of the update:
+
+.. code-block:: shell-session
+
+    $ cd /path/to/project
+    $ git pull
+    $ cd src
+    $ ./manage.py migrate
+
+Note that it's possible (even likely) that while ``git pull`` may update some
+files, the ``migrate`` step may not update anything.  This is totally normal.
+
+Additionally, as new features are added, the ability to control those features
+is typically added by way of an environment variable set in ``paperless.conf``.
+You may want to take a look at the ``paperless.conf.example`` file to see if
+there's anything new in there compared to what you've got int ``/etc``.
+
+If you are :ref:`using Docker <setup-installation-docker>` the update process
+requires only one additional step:
+
+.. code-block:: shell-session
+
+    $ cd /path/to/project
+    $ git pull
+    $ docker build -t paperless .
+    $ docker-compose up -d
+    $ docker-compose run --rm webserver migrate
+
+If ``git pull`` doesn't report any changes, there is no need to continue with
+the remaining steps.

docs/requirements.rst

@@ -0,0 +1,119 @@
+.. _requirements:
+
+Requirements
+============
+
+You need a Linux machine or Unix-like setup (theoretically an Apple machine
+should work) that has the following software installed on it:
+
+* `Python3`_ (with development libraries, pip and virtualenv)
+* `GNU Privacy Guard`_
+* `Tesseract`_, plus its language files matching your document base.
+* `Imagemagick`_ version 6.7.5 or higher
+* `unpaper`_
+
+.. _Python3: https://python.org/
+.. _GNU Privacy Guard: https://gnupg.org
+.. _Tesseract: https://github.com/tesseract-ocr
+.. _Imagemagick: http://imagemagick.org/
+.. _unpaper: https://www.flameeyes.eu/projects/unpaper
+
+Notably, you should confirm how you access your Python3 installation.  Many
+Linux distributions will install Python3 in parallel to Python2, using the names
+``python3`` and ``python`` respectively.  The same goes for ``pip3`` and
+``pip``.  Using Python2 will likely break things, so make sure that you're using
+the right version.
+
+For the purposes of simplicity, ``python`` and ``pip`` is used everywhere to
+refer to their Python 3 versions.
+
+In addition to the above, there are a number of Python requirements, all of
+which are listed in a file called ``requirements.txt`` in the project root.
+
+If you're not working on a virtual environment (like Vagrant or Docker), you
+should probably be using a virtualenv, but that's your call.  The reasons why
+you might choose a virtualenv or not aren't really within the scope of this
+document.  Needless to say if you don't know what a virtualenv is, you should
+probably figure that out before continuing.
+
+
+.. _requirements-apple:
+
+Apple-tastic Complications
+--------------------------
+
+Some users have `run into problems`_ with installing ImageMagick on Apple
+systems using HomeBrew.  The solution appears to be to install ghostscript as
+well as ImageMagick:
+
+.. _run into problems: https://github.com/danielquinn/paperless/issues/25
+
+.. code:: bash
+
+    $ brew install ghostscript
+    $ brew install imagemagick
+    $ brew install libmagic
+
+
+.. _requirements-baremetal:
+
+Python-specific Requirements: No Virtualenv
+-------------------------------------------
+
+If you don't care to use a virtual env, then installation of the Python
+dependencies is easy:
+
+.. code:: bash
+
+    $ pip install --user --requirement /path/to/paperless/requirements.txt
+
+This should download and install all of the requirements into
+``${HOME}/.local``.  Remember that your distribution may be using ``pip3`` as
+mentioned above.
+
+
+.. _requirements-virtualenv:
+
+Python-specific Requirements: Virtualenv
+----------------------------------------
+
+Using a virtualenv for this is pretty straightforward: create a virtualenv,
+enter it, and install the requirements using the ``requirements.txt`` file:
+
+.. code:: bash
+
+    $ virtualenv --python=/path/to/python3 /path/to/arbitrary/directory
+    $ . /path/to/arbitrary/directory/bin/activate
+    $ pip install  --requirement /path/to/paperless/requirements.txt
+
+Now you're ready to go.  Just remember to enter your virtualenv whenever you
+want to use Paperless.
+
+
+.. _requirements-documentation:
+
+Documentation
+-------------
+
+As generation of the documentation is not required for use of Paperless,
+dependencies for this process are not included in ``requirements.txt``.  If
+you'd like to generate your own docs locally, you'll need to:
+
+.. code:: bash
+
+    $ pip install sphinx
+
+and then cd into the ``docs`` directory and type ``make html``.
+
+If you are using Docker, you can use the following commands to build the
+documentation and run a webserver serving it on `port 8001`_:
+
+.. code:: bash
+
+    $ pwd
+    /path/to/paperless
+
+    $ docker build -t paperless:docs -f docs/Dockerfile .
+    $ docker run --rm -it -p "8001:8000" paperless:docs
+
+.. _port 8001: http://127.0.0.1:8001

docs/setup.md

@@ -1,869 +0,0 @@
-## Installation
-
-You can go multiple routes to setup and run Paperless:
-
-- [Use the easy install docker script](#docker_script)
-- [Pull the image from Docker Hub](#docker_hub)
-- [Build the Docker image yourself](#docker_build)
-- [Install Paperless directly on your system manually (bare metal)](#bare_metal)
-
-The Docker routes are quick & easy. These are the recommended routes.
-This configures all the stuff from the above automatically so that it
-just works and uses sensible defaults for all configuration options.
-Here you find a cheat-sheet for docker beginners: [CLI
-Basics](https://www.sehn.tech/refs/devops-with-docker/)
-
-The bare metal route is complicated to setup but makes it easier should
-you want to contribute some code back. You need to configure and run the
-above mentioned components yourself.
-
-### Docker using the Installation Script {#docker_script}
-
-Paperless provides an interactive installation script. This script will
-ask you for a couple configuration options, download and create the
-necessary configuration files, pull the docker image, start paperless
-and create your user account. This script essentially performs all the
-steps described in [Docker setup](#docker_hub) automatically.
-
-1.  Make sure that docker and docker-compose are installed.
-
-2.  Download and run the installation script:
-
-    ```shell-session
-    $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
-    ```
-
-    !!! note
-
-        macOS users will need to install e.g. [gnu-sed](https://formulae.brew.sh/formula/gnu-sed) with support
-        for running as `sed`.
-
-### From GHCR / Docker Hub {#docker_hub}
-
-1.  Login with your user and create a folder in your home-directory to have a place for your
-    configuration files and consumption directory.
-
-    ```shell-session
-    $ mkdir -v ~/paperless-ngx
-    ```
-
-2.  Go to the [/docker/compose directory on the project
-    page](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
-    and download one of the `docker-compose.*.yml` files,
-    depending on which database backend you want to use. Rename this
-    file to `docker-compose.yml`. If you want to enable
-    optional support for Office documents, download a file with
-    `-tika` in the file name. Download the
-    `docker-compose.env` file and the `.env` file as well and store them
-    in the same directory.
-
-    !!! tip
-
-        For new installations, it is recommended to use PostgreSQL as the
-        database backend.
-
-3.  Install [Docker](https://www.docker.com/) and
-    [docker-compose](https://docs.docker.com/compose/install/).
-
-    !!! warning
-
-        If you want to use the included `docker-compose.*.yml` file, you
-        need to have at least Docker version **17.09.0** and docker-compose
-        version **1.17.0**. To check do: `docker-compose -v` or `docker -v`
-
-        See the [Docker installation guide](https://docs.docker.com/engine/install/) on how to install the current
-        version of Docker for your operating system or Linux distribution of
-        choice. To get the latest version of docker-compose, follow the
-        [docker-compose installation guide](https://docs.docker.com/compose/install/linux/) if your package repository
-        doesn't include it.
-
-4.  Modify `docker-compose.yml` to your preferences. You may want to
-    change the path to the consumption directory. Find the line that
-    specifies where to mount the consumption directory:
-
-    ```yaml
-    - ./consume:/usr/src/paperless/consume
-    ```
-
-    Replace the part BEFORE the colon with a local directory of your
-    choice:
-
-    ```yaml
-    - /home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume
-    ```
-
-    Don't change the part after the colon or paperless wont find your
-    documents.
-
-    You may also need to change the default port that the webserver will
-    use from the default (8000):
-
-    ```yaml
-    ports:
-      - 8000:8000
-    ```
-
-    Replace the part BEFORE the colon with a port of your choice:
-
-    ```yaml
-    ports:
-      - 8010:8000
-    ```
-
-    Don't change the part after the colon or edit other lines that
-    refer to port 8000. Modifying the part before the colon will map
-    requests on another port to the webserver running on the default
-    port.
-
-    **Rootless**
-
-    If you want to run Paperless as a rootless container, you will need
-    to do the following in your `docker-compose.yml`:
-
-    - set the `user` running the container to map to the `paperless`
-      user in the container. This value (`user_id` below), should be
-      the same id that `USERMAP_UID` and `USERMAP_GID` are set to in
-      the next step. See `USERMAP_UID` and `USERMAP_GID`
-      [here](/configuration#docker).
-
-    Your entry for Paperless should contain something like:
-
-    > ```
-    > webserver:
-    >   image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    >   user: <user_id>
-    > ```
-
-5.  Modify `docker-compose.env`, following the comments in the file. The
-    most important change is to set `USERMAP_UID` and `USERMAP_GID` to
-    the uid and gid of your user on the host system. Use `id -u` and
-    `id -g` to get these.
-
-    This ensures that both the docker container and you on the host
-    machine have write access to the consumption directory. If your UID
-    and GID on the host system is 1000 (the default for the first normal
-    user on most systems), it will work out of the box without any
-    modifications. `id "username"` to check.
-
-    !!! 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.
-
-    !!! note
-
-        You can utilize Docker secrets for configuration settings by
-        appending `_FILE` to configuration values. For example `PAPERLESS_DBUSER`
-        can be set using `PAPERLESS_DBUSER_FILE=/var/run/secrets/password.txt`.
-
-    !!! warning
-
-        Some file systems such as NFS network shares don't support file
-        system notifications with `inotify`. When storing the consumption
-        directory on such a file system, paperless will not pick up new
-        files with the default configuration. You will need to use
-        `PAPERLESS_CONSUMER_POLLING`, which will disable inotify. See
-        [here](/configuration#polling).
-
-6.  Run `docker-compose pull`. This will pull the image.
-
-7.  To be able to login, you will need a super user. To create it,
-    execute the following command:
-
-    ```shell-session
-    $ docker-compose run --rm webserver createsuperuser
-    ```
-
-    or using docker exec from within the container:
-
-    ```shell-session
-    $ python3 manage.py createsuperuser
-    ```
-
-    This will prompt you to set a username, an optional e-mail address
-    and finally a password (at least 8 characters).
-
-8.  Run `docker-compose up -d`. This will create and start the necessary containers.
-
-9.  The default `docker-compose.yml` exports the webserver on your local
-    port
-
-    8000\. If you did not change this, you should now be able to visit
-    your Paperless instance at `http://127.0.0.1:8000` or your servers
-    IP-Address:8000. Use the login credentials you have created with the
-    previous step.
-
-### Build the Docker image yourself {#docker_build}
-
-1.  Clone the entire repository of paperless:
-
-    ```shell-session
-    git clone https://github.com/paperless-ngx/paperless-ngx
-    ```
-
-    The main branch always reflects the latest stable version.
-
-2.  Copy one of the `docker/compose/docker-compose.*.yml` to
-    `docker-compose.yml` in the root folder, depending on which database
-    backend you want to use. Copy `docker-compose.env` into the project
-    root as well.
-
-3.  In the `docker-compose.yml` file, find the line that instructs
-    docker-compose to pull the paperless image from Docker Hub:
-
-    ```yaml
-    webserver:
-      image: ghcr.io/paperless-ngx/paperless-ngx:latest
-    ```
-
-    and replace it with a line that instructs docker-compose to build
-    the image from the current working directory instead:
-
-    ```yaml
-    webserver:
-      build:
-        context: .
-        args:
-          QPDF_VERSION: x.y.x
-          PIKEPDF_VERSION: x.y.z
-          PSYCOPG2_VERSION: x.y.z
-          JBIG2ENC_VERSION: 0.29
-    ```
-
-    !!! note
-
-        You should match the build argument versions to the version for the
-        release you have checked out. These are pre-built images with
-        certain, more updated software. If you want to build these images
-        your self, that is possible, but beyond the scope of these steps.
-
-4.  Follow steps 3 to 8 of [Docker Setup](#docker_hub). When asked to run
-    `docker-compose pull` to pull the image, do
-
-    ```shell-session
-    $ docker-compose build
-    ```
-
-    instead to build the image.
-
-### Bare Metal Route {#bare_metal}
-
-Paperless runs on linux only. The following procedure has been tested on
-a minimal installation of Debian/Buster, which is the current stable
-release at the time of writing. Windows is not and will never be
-supported.
-
-1.  Install dependencies. Paperless requires the following packages.
-
-    - `python3` 3.8, 3.9
-    - `python3-pip`
-    - `python3-dev`
-    - `default-libmysqlclient-dev` for MariaDB
-    - `fonts-liberation` for generating thumbnails for plain text
-      files
-    - `imagemagick` >= 6 for PDF conversion
-    - `gnupg` for handling encrypted documents
-    - `libpq-dev` for PostgreSQL
-    - `libmagic-dev` for mime type detection
-    - `mariadb-client` for MariaDB compile time
-    - `mime-support` for mime type detection
-    - `libzbar0` for barcode detection
-    - `poppler-utils` for barcode detection
-
-    Use this list for your preferred package management:
-
-    ```
-    python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev default-libmysqlclient-dev libmagic-dev mime-support libzbar0 poppler-utils
-    ```
-
-    These dependencies are required for OCRmyPDF, which is used for text
-    recognition.
-
-    - `unpaper`
-    - `ghostscript`
-    - `icc-profiles-free`
-    - `qpdf`
-    - `liblept5`
-    - `libxml2`
-    - `pngquant` (suggested for certain PDF image optimizations)
-    - `zlib1g`
-    - `tesseract-ocr` >= 4.0.0 for OCR
-    - `tesseract-ocr` language packs (`tesseract-ocr-eng`,
-      `tesseract-ocr-deu`, etc)
-
-    Use this list for your preferred package management:
-
-    ```
-    unpaper ghostscript icc-profiles-free qpdf liblept5 libxml2 pngquant zlib1g tesseract-ocr
-    ```
-
-    On Raspberry Pi, these libraries are required as well:
-
-    - `libatlas-base-dev`
-    - `libxslt1-dev`
-
-    You will also need `build-essential`, `python3-setuptools` and
-    `python3-wheel` for installing some of the python dependencies.
-
-2.  Install `redis` >= 6.0 and configure it to start automatically.
-
-3.  Optional. Install `postgresql` and configure a database, user and
-    password for paperless. If you do not wish to use PostgreSQL,
-    MariaDB and SQLite are available as well.
-
-    !!! note
-
-        On bare-metal installations using SQLite, ensure the [JSON1
-        extension](https://code.djangoproject.com/wiki/JSON1Extension) is
-        enabled. This is usually the case, but not always.
-
-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
-    <https://github.com/paperless-ngx/paperless-ngx/releases> 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`.
-
-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:
-
-    - `PAPERLESS_REDIS` should point to your redis server, such as
-      <redis://localhost:6379>.
-    - `PAPERLESS_DBENGINE` optional, and should be one of `postgres`,
-      `mariadb`, or `sqlite`
-    - `PAPERLESS_DBHOST` should be the hostname on which your
-      PostgreSQL server is running. Do not configure this to use
-      SQLite instead. Also configure port, database name, user and
-      password as necessary.
-    - `PAPERLESS_CONSUMPTION_DIR` should point to a folder which
-      paperless should watch for documents. You might want to have
-      this somewhere else. Likewise, `PAPERLESS_DATA_DIR` and
-      `PAPERLESS_MEDIA_ROOT` define where paperless stores its data.
-      If you like, you can point both to the same directory.
-    - `PAPERLESS_SECRET_KEY` should be a random sequence of
-      characters. It's used for authentication. Failure to do so
-      allows third parties to forge authentication credentials.
-    - `PAPERLESS_URL` if you are behind a reverse proxy. This should
-      point to your domain. Please see
-      [configuration](/configuration) for more
-      information.
-
-    Many more adjustments can be made to paperless, especially the OCR
-    part. The following options are recommended for everyone:
-
-    - Set `PAPERLESS_OCR_LANGUAGE` to the language most of your
-      documents are written in.
-    - Set `PAPERLESS_TIME_ZONE` to your local time zone.
-
-    !!! warning
-
-        Ensure your Redis instance [is secured](https://redis.io/docs/getting-started/#securing-redis).
-
-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 should update your pip, so it gets the actual packages.
-
-    ```shell-session
-    sudo -Hu paperless pip3 install -r requirements.txt
-    ```
-
-    This will install all python dependencies in the home directory of
-    the new paperless user.
-
-9.  Go to `/opt/paperless/src`, and execute the following commands:
-
-    ```bash
-    # This creates the database schema.
-    sudo -Hu paperless python3 manage.py migrate
-
-    # This creates your first paperless user
-    sudo -Hu paperless python3 manage.py createsuperuser
-    ```
-
-10. Optional: Test that paperless is working by executing
-
-    ```bash
-    # Manually starts the webserver
-    sudo -Hu paperless python3 manage.py runserver
-    ```
-
-    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. You may need
-    to set `PAPERLESS_DEBUG=true` in order for the development server to work
-    normally in your browser.
-
-    !!! warning
-
-        This is a development server which should not be used in production.
-        It is not audited for security and performance is inferior to
-        production ready web servers.
-
-    !!! tip
-
-        This will not start the consumer. Paperless does this in a separate
-        process.
-
-11. Setup systemd services to run paperless automatically. You may use
-    the service definition files included in the `scripts` folder as a
-    starting point.
-
-    Paperless needs the `webserver` script to run the webserver, the
-    `consumer` script to watch the input folder, `taskqueue` for the
-    background workers used to handle things like document consumption
-    and the `scheduler` script to run tasks such as email checking at
-    certain times .
-
-    !!! note
-
-        The `socket` script enables `gunicorn` to run on port 80 without
-        root privileges. For this you need to uncomment the
-        `Require=paperless-webserver.socket` in the `webserver` script
-        and configure `gunicorn` to listen on port 80 (see
-        `paperless/gunicorn.conf.py`).
-
-    You may need to adjust the path to the `gunicorn` executable. This
-    will be installed as part of the python dependencies, and is either
-    located in the `bin` folder of your virtual environment, or in
-    `~/.local/bin/` if no virtual environment is used.
-
-    These services rely on redis and optionally the database server, but
-    don't need to be started in any particular order. The example files
-    depend on redis being started. If you use a database server, you
-    should add additional dependencies.
-
-    !!! warning
-
-        The included scripts run a `gunicorn` standalone server, which is
-        fine for running paperless. It does support SSL, however, the
-        documentation of GUnicorn states that you should use a proxy server
-        in front of gunicorn instead.
-
-        For instructions on how to use nginx for that,
-        [see the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#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.
-
-13. Configure ImageMagick to allow processing of PDF documents. Most
-    distributions have this disabled by default, since PDF documents can
-    contain malware. If you don't do this, paperless will fall back to
-    ghostscript for certain steps such as thumbnail generation.
-
-    Edit `/etc/ImageMagick-6/policy.xml` and adjust
-
-    ```
-    <policy domain="coder" rights="none" pattern="PDF" />
-    ```
-
-    to
-
-    ```
-    <policy domain="coder" rights="read|write" pattern="PDF" />
-    ```
-
-14. Optional: Install the
-    [jbig2enc](https://ocrmypdf.readthedocs.io/en/latest/jbig2.html)
-    encoder. This will reduce the size of generated PDF documents.
-    You'll most likely need to compile this by yourself, because this
-    software has been patented until around 2017 and binary packages are
-    not available for most distributions.
-
-15. Optional: If using the NLTK machine learning processing (see
-    `PAPERLESS_ENABLE_NLTK` in [configuration](/configuration#software_tweaks) for details),
-    download the NLTK data for the Snowball
-    Stemmer, Stopwords and Punkt tokenizer to your
-    `PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK
-    instructions](https://www.nltk.org/data.html) for details on how to
-    download the data.
-
-# Migrating to Paperless-ngx
-
-Migration is possible both from Paperless-ng or directly from the
-'original' Paperless.
-
-## Migrating from Paperless-ng
-
-Paperless-ngx is meant to be a drop-in replacement for Paperless-ng and
-thus upgrading should be trivial for most users, especially when using
-docker. However, as with any major change, it is recommended to take a
-full backup first. Once you are ready, simply change the docker image to
-point to the new source. E.g. if using Docker Compose, edit
-`docker-compose.yml` and change:
-
-```
-image: jonaswinkler/paperless-ng:latest
-```
-
-to
-
-```
-image: ghcr.io/paperless-ngx/paperless-ngx:latest
-```
-
-and then run `docker-compose up -d` which will pull the new image
-recreate the container. That's it!
-
-Users who installed with the bare-metal route should also update their
-Git clone to point to `https://github.com/paperless-ngx/paperless-ngx`,
-e.g. using the command
-`git remote set-url origin https://github.com/paperless-ngx/paperless-ngx`
-and then pull the latest version.
-
-## Migrating from Paperless
-
-At its core, paperless-ngx is still paperless and fully compatible.
-However, some things have changed under the hood, so you need to adapt
-your setup depending on how you installed paperless.
-
-This setup describes how to update an existing paperless Docker
-installation. The important things to keep in mind are as follows:
-
-- Read the [changelog](/changelog) and
-  take note of breaking changes.
-- You should decide if you want to stick with SQLite or want to
-  migrate your database to PostgreSQL. See [documentation](#sqlite_to_psql)
-  for details on
-  how to move your data from SQLite to PostgreSQL. Both work fine with
-  paperless. However, if you already have a database server running
-  for other services, you might as well use it for paperless as well.
-- The task scheduler of paperless, which is used to execute periodic
-  tasks such as email checking and maintenance, requires a
-  [redis](https://redis.io/) message broker instance. The
-  docker-compose route takes care of that.
-- The layout of the folder structure for your documents and data
-  remains the same, so you can just plug your old docker volumes into
-  paperless-ngx and expect it to find everything where it should be.
-
-Migration to paperless-ngx is then performed in a few simple steps:
-
-1.  Stop paperless.
-
-    ```bash
-    $ cd /path/to/current/paperless
-    $ docker-compose down
-    ```
-
-2.  Do a backup for two purposes: If something goes wrong, you still
-    have your data. Second, if you don't like paperless-ngx, you can
-    switch back to paperless.
-
-3.  Download the latest release of paperless-ngx. You can either go with
-    the docker-compose files from
-    [here](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
-    or clone the repository to build the image yourself (see
-    [above](#docker_build)). You can
-    either replace your current paperless folder or put paperless-ngx in
-    a different location.
-
-    !!! warning
-
-        Paperless-ngx includes a `.env` file. This will set the project name
-        for docker compose to `paperless`, which will also define the name
-        of the volumes by paperless-ngx. However, if you experience that
-        paperless-ngx is not using your old paperless volumes, verify the
-        names of your volumes with
-
-        ``` shell-session
-        $ docker volume ls | grep _data
-        ```
-
-        and adjust the project name in the `.env` file so that it matches
-        the name of the volumes before the `_data` part.
-
-4.  Download the `docker-compose.sqlite.yml` file to
-    `docker-compose.yml`. If you want to switch to PostgreSQL, do that
-    after you migrated your existing SQLite database.
-
-5.  Adjust `docker-compose.yml` and `docker-compose.env` to your needs.
-    See [Docker setup](#docker_hub) details on
-    which edits are advised.
-
-6.  [Update paperless.](/administration#updating)
-
-7.  In order to find your existing documents with the new search
-    feature, you need to invoke a one-time operation that will create
-    the search index:
-
-    ```shell-session
-    $ docker-compose run --rm webserver document_index reindex
-    ```
-
-    This will migrate your database and create the search index. After
-    that, paperless will take care of maintaining the index by itself.
-
-8.  Start paperless-ngx.
-
-    ```bash
-    $ docker-compose up -d
-    ```
-
-    This will run paperless in the background and automatically start it
-    on system boot.
-
-9.  Paperless installed a permanent redirect to `admin/` in your
-    browser. This redirect is still in place and prevents access to the
-    new UI. Clear your browsing cache in order to fix this.
-
-10. Optionally, follow the instructions below to migrate your existing
-    data to PostgreSQL.
-
-## Migrating from LinuxServer.io Docker Image
-
-As with any upgrades and large changes, it is highly recommended to
-create a backup before starting. This assumes the image was running
-using Docker Compose, but the instructions are translatable to Docker
-commands as well.
-
-1.  Stop and remove the paperless container
-2.  If using an external database, stop the container
-3.  Update Redis configuration
-    a) If `REDIS_URL` is already set, change it to `PAPERLESS_REDIS`
-    and continue to step 4.
-    b) Otherwise, in the `docker-compose.yml` add a new service for
-    Redis, following [the example compose
-    files](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
-    c) Set the environment variable `PAPERLESS_REDIS` so it points to
-    the new Redis container
-4.  Update user mapping
-    a) If set, change the environment variable `PUID` to `USERMAP_UID`
-    b) If set, change the environment variable `PGID` to `USERMAP_GID`
-5.  Update configuration paths
-    a) Set the environment variable `PAPERLESS_DATA_DIR` to `/config`
-6.  Update media paths
-    a) Set the environment variable `PAPERLESS_MEDIA_ROOT` to
-    `/data/media`
-7.  Update timezone
-    a) Set the environment variable `PAPERLESS_TIME_ZONE` to the same
-    value as `TZ`
-8.  Modify the `image:` to point to
-    `ghcr.io/paperless-ngx/paperless-ngx:latest` or a specific version
-    if preferred.
-9.  Start the containers as before, using `docker-compose`.
-
-## Moving data from SQLite to PostgreSQL or MySQL/MariaDB {#sqlite_to_psql}
-
-Moving your data from SQLite to PostgreSQL or MySQL/MariaDB is done via
-executing a series of django management commands as below. The commands
-below use PostgreSQL, but are applicable to MySQL/MariaDB with the
-
-!!! warning
-
-    Make sure that your SQLite database is migrated to the latest version.
-    Starting paperless will make sure that this is the case. If your try to
-    load data from an old database schema in SQLite into a newer database
-    schema in PostgreSQL, you will run into trouble.
-
-!!! warning
-
-    On some database fields, PostgreSQL enforces predefined limits on
-    maximum length, whereas SQLite does not. The fields in question are the
-    title of documents (128 characters), names of document types, tags and
-    correspondents (128 characters), and filenames (1024 characters). If you
-    have data in these fields that surpasses these limits, migration to
-    PostgreSQL is not possible and will fail with an error.
-
-!!! warning
-
-    MySQL is case insensitive by default, treating values like "Name" and
-    "NAME" as identical. See [MySQL caveats](/advanced_usage#mysql-caveats) for details.
-
-!!! warning
-
-    MySQL also enforces limits on maximum lengths, but does so differently than
-    PostgreSQL.  It may not be possible to migrate to MySQL due to this.
-
-!!! warning
-
-    Using mariadb version 10.4+ is recommended. Using the `utf8mb3` character set on
-    an older system may fix issues that can arise while setting up Paperless-ngx but
-    `utf8mb3` can cause issues with consumption (where `utf8mb4` does not).
-
-1.  Stop paperless, if it is running.
-
-2.  Tell paperless to use PostgreSQL:
-
-    a) With docker, copy the provided `docker-compose.postgres.yml`
-    file to `docker-compose.yml`. Remember to adjust the consumption
-    directory, if necessary.
-    b) Without docker, configure the database in your `paperless.conf`
-    file. See [configuration](/configuration) for
-    details.
-
-3.  Open a shell and initialize the database:
-
-    a) With docker, run the following command to open a shell within
-    the paperless container:
-
-        ``` shell-session
-        $ cd /path/to/paperless
-        $ docker-compose run --rm webserver /bin/bash
-        ```
-
-        This will launch the container and initialize the PostgreSQL
-        database.
-
-    b) Without docker, remember to activate any virtual environment,
-    switch to the `src` directory and create the database schema:
-
-        ``` shell-session
-        $ cd /path/to/paperless/src
-        $ python3 manage.py migrate
-        ```
-
-        This will not copy any data yet.
-
-4.  Dump your data from SQLite:
-
-    ```shell-session
-    $ python3 manage.py dumpdata --database=sqlite --exclude=contenttypes --exclude=auth.Permission > data.json
-    ```
-
-5.  Load your data into PostgreSQL:
-
-    ```shell-session
-    $ python3 manage.py loaddata data.json
-    ```
-
-6.  If operating inside Docker, you may exit the shell now.
-
-    ```shell-session
-    $ exit
-    ```
-
-7.  Start paperless.
-
-## Moving back to Paperless
-
-Lets say you migrated to Paperless-ngx and used it for a while, but
-decided that you don't like it and want to move back (If you do, send
-me a mail about what part you didn't like!), you can totally do that
-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. Thumbnails
-were also changed from PNG to WEBP format and will need to be
-re-generated.
-
-Execute this:
-
-```shell-session
-$ cd /path/to/paperless
-$ docker-compose run --rm webserver migrate documents 0023
-```
-
-Or without docker:
-
-```shell-session
-$ cd /path/to/paperless/src
-$ python3 manage.py migrate documents 0023
-```
-
-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}
-
-Paperless runs on Raspberry Pi. However, some things are rather slow on
-the Pi and configuring some options in paperless can help improve
-performance immensely:
-
-- Stick with SQLite to save some resources.
-- Consider setting `PAPERLESS_OCR_PAGES` to 1, so that paperless will
-  only OCR the first page of your documents. In most cases, this page
-  contains enough information to be able to find it.
-- `PAPERLESS_TASK_WORKERS` and `PAPERLESS_THREADS_PER_WORKER` are
-  configured to use all cores. The Raspberry Pi models 3 and up have 4
-  cores, meaning that paperless will use 2 workers and 2 threads per
-  worker. This may result in sluggish response times during
-  consumption, so you might want to lower these settings (example: 2
-  workers and 1 thread to always have some computing power left for
-  other tasks).
-- Keep `PAPERLESS_OCR_MODE` at its default value `skip` and consider
-  OCR'ing your documents before feeding them into paperless. Some
-  scanners are able to do this!
-- Set `PAPERLESS_OCR_SKIP_ARCHIVE_FILE` to `with_text` to skip archive
-  file generation for already ocr'ed documents, or `always` to skip it
-  for all documents.
-- If you want to perform OCR on the device, consider using
-  `PAPERLESS_OCR_CLEAN=none`. This will speed up OCR times and use
-  less memory at the expense of slightly worse OCR results.
-- If using docker, consider setting `PAPERLESS_WEBSERVER_WORKERS` to 1. This will save some memory.
-- Consider setting `PAPERLESS_ENABLE_NLTK` to false, to disable the
-  more advanced language processing, which can take more memory and
-  processing time.
-
-For details, refer to [configuration](/configuration).
-
-!!! note
-
-    Updating the
-    [automatic matching algorithm](/advanced_usage#automatic-matching) takes quite a bit of time. However, the update mechanism
-    checks if your data has changed before doing the heavy lifting. If you
-    experience the algorithm taking too much cpu time, consider changing the
-    schedule in the admin interface to daily. You can also manually invoke
-    the task by changing the date and time of the next run to today/now.
-
-    The actual matching of the algorithm is fast and works on Raspberry Pi
-    as well as on any other device.
-
-# Using nginx as a reverse proxy {#nginx}
-
-Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx) for user-maintained documentation of using nginx with Paperless-ngx.
-
-# Enhancing security {#security}
-
-Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-Security-Tools-with-Paperless-ngx) for user-maintained documentation of how to configure security tools like Fail2ban with Paperless-ngx.