readme-vars.yml

---

# project information
project_name: paperless-ngx
project_url: "https://github.com/paperless-ngx/paperless-ngx"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/paperless-ngx-banner.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }}) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

project_deprecation_status: true
project_deprecation_message: |
  We recommend switching to the new official container: 
  https://github.com/paperless-ngx/paperless-ngx

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Contains all relevant configuration files." }
  - { vol_path: "/data", vol_host_path: "/path/to/appdata/data", desc: "Storage location for all paperless-ngx data files." }
param_usage_include_ports: true
param_ports:
  - { external_port: "8000", internal_port: "8000", port_desc: "http gui" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "America/New_York", desc: "Specify a timezone to use EG America/New_York"}
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "REDIS_URL", env_value: "", desc: "Specify an external redis instance to use. Can optionally include a port (`redis:6379`) and/or db (`redis/foo`). If left blank or not included, will use a built-in redis instance. If changed after initial setup will also require manual modification of /config/settings.py"}

# optional parameters
optional_block_1: false
optional_block_1_items: ""

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT
  More info at [paperless-ngx]({{ project_url }}).
  For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream [here](https://paperless-ng.readthedocs.io/en/latest/administration.html) and can be accessed with this container thus: `docker exec -it <container_name> manage <command>`. For example, `docker exec -it paperless manage  document_retagger -tT`.
# changelog
changelogs:
  - { date: "05.09.22:", desc: "Deprecate." }
  - { date: "16.05.22:", desc: "Add correct libqpdf.so to arm builds." }
  - { date: "14.05.22:", desc: "Fine tune disabling of redis." }
  - { date: "12.05.22:", desc: "Move migrations to after multilangocr mod. Fix disabling of redis. Add missing dep for postgresql." }
  - { date: "12.05.22:", desc: "Utilize lsio wheel for pikepdf." }
  - { date: "11.05.22:", desc: "Update upstream artifact name and utilize lsio wheels for scipy and scikit-learn." }
  - { date: "05.05.22:", desc: "Add runtime dependencies libxslt1.1 for armhf" }
  - { date: "30.04.22:", desc: "Add runtime dependencies lizbar and poppler-utils" }
  - { date: "27.04.22:", desc: "Add build-dependencies for arm32 builds." }
  - { date: "11.04.22:", desc: "Replaced uwsgi with gunicorn due to websocket issues." }
  - { date: "11.03.22:", desc: "Initial Release." }