History

Marty Oehme 4a5a0beca1 restic: Fix backup container conditionals Change the inclusion of backup containers so they actually work. They check that restic is enabled globally, and that restic is enabled for the individual stack they belong to. If either of the conditions is not met they do not deploy. This way we can simply enable restic globally with `restic_enable` and by default all stacks will be backed up. But if we want to exclude specific stacks from backups we can do so with the individual `<role>_restic_enable = False` variable. Finally found a good version of doing so with the help of the following medium article: https://medium.com/opsops/is-defined-in-ansible-d490945611ae which basically makes use of default fallbacks instead.		2025-07-19 10:23:23 +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: Improve documentation	2025-07-17 18:08:52 +02:00
tasks	repo: Rename compose templates to compose.yaml.jinja	2025-07-18 21:49:32 +02:00
templates	restic: Fix backup container conditionals	2025-07-19 10:23:23 +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