History

Marty Oehme cd842ea4b5 Add hostname to restic containers Will pass through the hostname to any snapshots set up. The hostname is _not_ derived from the random docker container string but instead takes the name of the _host_ on which docker is running (from ansible facts). The hostname in combination with the tag should point to the correct host -> stack which is being backed up.		2025-07-18 21:37:07 +02:00
..
defaults	paperless: Add restic backups	2025-07-18 21:37:06 +02:00
meta	repo: Rename all yml extensions to yaml	2025-07-18 21:37:03 +02:00
scripts	paperless: Improve documentation	2025-07-17 18:08:52 +02:00
tasks	repo: Rename all yml extensions to yaml	2025-07-18 21:37:03 +02:00
templates	Add hostname to restic containers	2025-07-18 21:37:07 +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