46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
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`.
|
|
<!-- TODO: Describe variables -->
|
|
|
|
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
|
|
|
|
Author Information
|
|
------------------
|
|
|
|
Copyright (c) 2025 Marty Oehme. All Rights Reserved.
|