History

Marty Oehme 770da26b03 paperless: Improve documentation		2025-07-17 18:08:52 +02:00
..
defaults	repo: Move ansible setup to root dir	2025-07-17 18:07:52 +02:00
meta	repo: Move ansible setup to root dir	2025-07-17 18:07:52 +02:00
scripts	paperless: Improve documentation	2025-07-17 18:08:52 +02:00
tasks	repo: Move ansible setup to root dir	2025-07-17 18:07:52 +02:00
templates	repo: Move ansible setup to root dir	2025-07-17 18:07:52 +02:00
tests	repo: Move ansible setup to root dir	2025-07-17 18:07:52 +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