History

Marty Oehme 208cecd5ef paperless: Change script scan output dir Still a HACK should not be hard-coded but perhaps installed as a runnable script on localhost for the role (e.g. `scan-paperless`) which receives its scanner more dynamically.		2025-10-20 23:53:58 +02:00
..
defaults	paperless: Add restic backups	2025-07-18 21:37:06 +02:00
meta	roles: Set caddy and docker dependency chain	2025-07-19 10:23:22 +02:00
scripts	paperless: Change script scan output dir	2025-10-20 23:53:58 +02:00
tasks	repo: Rename compose templates to compose.yaml.jinja	2025-07-18 21:49:32 +02:00
templates	paperless: Fix compose missing quote	2025-07-21 22:19:59 +02:00
tests	repo: Rename all yml extensions to yaml	2025-07-18 21:37:03 +02:00
README.md	paperless: Improve documentation	2025-07-17 18:08:52 +02:00

README.md

Role Name

Set up a docker-hosted paperless-ngx instance.

Requirements

The target server needs to be running a reasonably recent version of docker, which contains the docker compose (not docker-compose) sub-command.

Role Variables

All relevant variables reside in defaults/main.yml.

Dependencies

Relies on the caddy role to be executed for caddy to pick up the container and proxy to it.

Example Playbook

The role can easily be set up in the following way to deploy to any server:

- hosts: servers
  roles:
     - role: paperless

An example scanning script is included which I wrote for my old printer and allows (relatively) rapid scanning by pushing a button, and automatically merging and sending the files to the consume folder.

This will need to be adjusted for wherever you watch for the documents, but is a simple example of how it could be integrated into a scanning workflow.

License

MIT