ansible-collection-docker-apps/roles/paperless-ngx/README.md

Paperless-ngx

Deploy Paperless-ngx document management system using Docker Compose.

Description

Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive.

Variables

Required

Variable	Default	Description
paperless_db_password	paperless	PostgreSQL password
paperless_consume_path	{{ app_dir }}/consume	Document intake directory

Optional

Variable	Default	Description
paperless_http_port	8000	Web interface port
paperless_data_path	{{ app_dir }}/data	Application data storage
paperless_media_path	{{ app_dir }}/media	Processed document storage
paperless_export_path	{{ app_dir }}/export	Document export directory
paperless_pgdata_path	{{ app_dir }}/pgdata	PostgreSQL data storage
paperless_redisdata_path	{{ app_dir }}/redisdata	Redis data storage
paperless_container_version	latest	Paperless-ngx Docker image tag
paperless_db_name	paperless	PostgreSQL database name
paperless_db_user	paperless	PostgreSQL username

Example

- role: patrickj.docker_apps.paperless-ngx
  vars:
    paperless_http_port: 8080
    paperless_db_password: "{{ vault_paperless_db_password }}"
    paperless_consume_path: /path/to/consume