From dc8ec725811bb6a66f0cb5545b19984ca19950e0 Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Tue, 15 Jul 2025 15:19:29 +0200 Subject: [PATCH] paperless: Add role --- ansible/group_vars/instance_system/vars.yaml | 3 + ansible/roles/paperless/README.md | 38 ++++++ ansible/roles/paperless/defaults/main.yml | 20 ++++ ansible/roles/paperless/handlers/main.yml | 2 + ansible/roles/paperless/meta/main.yml | 34 ++++++ ansible/roles/paperless/tasks/main.yml | 16 +++ .../templates/docker-compose.yaml.j2 | 113 ++++++++++++++++++ ansible/roles/paperless/tests/inventory | 2 + ansible/roles/paperless/tests/test.yml | 5 + ansible/roles/paperless/vars/main.yml | 2 + 10 files changed, 235 insertions(+) create mode 100644 ansible/roles/paperless/README.md create mode 100644 ansible/roles/paperless/defaults/main.yml create mode 100644 ansible/roles/paperless/handlers/main.yml create mode 100644 ansible/roles/paperless/meta/main.yml create mode 100644 ansible/roles/paperless/tasks/main.yml create mode 100644 ansible/roles/paperless/templates/docker-compose.yaml.j2 create mode 100644 ansible/roles/paperless/tests/inventory create mode 100644 ansible/roles/paperless/tests/test.yml create mode 100644 ansible/roles/paperless/vars/main.yml diff --git a/ansible/group_vars/instance_system/vars.yaml b/ansible/group_vars/instance_system/vars.yaml index 9aeda4e..a311640 100644 --- a/ansible/group_vars/instance_system/vars.yaml +++ b/ansible/group_vars/instance_system/vars.yaml @@ -1 +1,4 @@ arrstack_tz: Europe/Berlin +stack_paperless_tz: Europe/Berlin +stack_paperless_ocr_language: deu+eng +stack_paperless_ocr_languages: eng deu frk diff --git a/ansible/roles/paperless/README.md b/ansible/roles/paperless/README.md new file mode 100644 index 0000000..225dd44 --- /dev/null +++ b/ansible/roles/paperless/README.md @@ -0,0 +1,38 @@ +Role Name +========= + +A brief description of the role goes here. + +Requirements +------------ + +Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. + +Role Variables +-------------- + +A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. + +Dependencies +------------ + +A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. + +Example Playbook +---------------- + +Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: + + - hosts: servers + roles: + - { role: username.rolename, x: 42 } + +License +------- + +BSD + +Author Information +------------------ + +An optional section for the role authors to include contact information, or a website (HTML is not allowed). diff --git a/ansible/roles/paperless/defaults/main.yml b/ansible/roles/paperless/defaults/main.yml new file mode 100644 index 0000000..70f8ae8 --- /dev/null +++ b/ansible/roles/paperless/defaults/main.yml @@ -0,0 +1,20 @@ +--- + +stack_paperless_env_dir: /opt/stack_paperless +stack_paperless_puid: 1000 +stack_paperless_pgid: 100 + +stack_paperless_tz: America/Chicago +stack_paperless_ocr_language: eng # default OCR languages +stack_paperless_ocr_languages: eng deu frk # ALL installed languages +stack_paperless_ocr_skip_archive_file: with_text +stack_paperless_enable_update_check: true +# using !unsafe macro to stop ansible from interpolating as variables +stack_paperless_filename_format: !unsafe "{{created_year}}/{{correspondent}}/{{created}}_{{title}}" + +stack_paperless_dbname: ppldbname +stack_paperless_dbuser: ppldbuser +stack_paperless_dbpass: ppldbpass +stack_paperless_secret_key: super-secret-random-key +stack_paperless_admin_user: AnAdminUserName +stack_paperless_admin_password: AnAdminPassword diff --git a/ansible/roles/paperless/handlers/main.yml b/ansible/roles/paperless/handlers/main.yml new file mode 100644 index 0000000..6d5ba60 --- /dev/null +++ b/ansible/roles/paperless/handlers/main.yml @@ -0,0 +1,2 @@ +--- +# handlers file for paperless diff --git a/ansible/roles/paperless/meta/main.yml b/ansible/roles/paperless/meta/main.yml new file mode 100644 index 0000000..ea68190 --- /dev/null +++ b/ansible/roles/paperless/meta/main.yml @@ -0,0 +1,34 @@ +galaxy_info: + author: your name + description: your role description + company: your company (optional) + + # If the issue tracker for your role is not on github, uncomment the + # next line and provide a value + # issue_tracker_url: http://example.com/issue/tracker + + # Choose a valid license ID from https://spdx.org - some suggested licenses: + # - BSD-3-Clause (default) + # - MIT + # - GPL-2.0-or-later + # - GPL-3.0-only + # - Apache-2.0 + # - CC-BY-4.0 + license: license (GPL-2.0-or-later, MIT, etc) + + min_ansible_version: 2.1 + + # If this a Container Enabled role, provide the minimum Ansible Container version. + # min_ansible_container_version: + + galaxy_tags: [] + # List tags for your role here, one per line. A tag is a keyword that describes + # and categorizes the role. Users find roles by searching for tags. Be sure to + # remove the '[]' above, if you add tags to this list. + # + # NOTE: A tag is limited to a single word comprised of alphanumeric characters. + # Maximum 20 tags per role. + +dependencies: [] + # List your role dependencies here, one per line. Be sure to remove the '[]' above, + # if you add dependencies to this list. diff --git a/ansible/roles/paperless/tasks/main.yml b/ansible/roles/paperless/tasks/main.yml new file mode 100644 index 0000000..a3525f5 --- /dev/null +++ b/ansible/roles/paperless/tasks/main.yml @@ -0,0 +1,16 @@ +--- +- name: Create Paperless stack environment directory + ansible.builtin.file: + state: directory + path: "{{ stack_paperless_env_dir }}" + owner: root + group: root + mode: 0700 + +- name: Start compose stack + community.docker.docker_compose_v2: + project_name: paperless + definition: "{{ lookup('template', 'docker-compose.yaml.j2') | from_yaml }}" + remove_orphans: true + wait: true + wait_timeout: 60 diff --git a/ansible/roles/paperless/templates/docker-compose.yaml.j2 b/ansible/roles/paperless/templates/docker-compose.yaml.j2 new file mode 100644 index 0000000..6937758 --- /dev/null +++ b/ansible/roles/paperless/templates/docker-compose.yaml.j2 @@ -0,0 +1,113 @@ +# Docker Compose file for running paperless from the Docker Hub. +# This file contains everything paperless needs to run. +# Paperless supports amd64, arm and arm64 hardware. +# +# All compose files of paperless configure paperless in the following way: +# +# - Paperless is (re)started on system boot, if it was running before shutdown. +# - Docker volumes for storing data are managed by Docker. +# - Folders for importing and exporting files are created in the same directory +# as this file and mounted to the correct folders inside the container. +# - Paperless listens on port 8000. +# +# SQLite is used as the database. The SQLite file is stored in the data volume. +# +# To install and update paperless with this file, do the following: +# +# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env' +# and '.env' into a folder. +# - Run 'docker compose pull'. +# - Run 'docker compose run --rm webserver createsuperuser' to create a user. +# - use anything (secure) for username:pw +# - Run 'docker compose up -d'. +# +# For more extensive installation and update instructions, refer to the +# documentation. + +services: + paperless: + container_name: paperless + image: ghcr.io/paperless-ngx/paperless-ngx:latest + restart: unless-stopped + networks: + - caddy + - backend + ports: + - 8000:8000 + env_file: docker-compose.env + security_opt: + - no-new-privileges:true + depends_on: + - paperless-redis + - paperless-postgres + volumes: + - "{{ stack_paperless_env_dir }}/data/paperless:/usr/src/paperless/data" # container data + - "/home/marty/documents/archive/.media:/usr/src/paperless/media" # document location + - "export:/usr/src/paperless/export" # backup location + - "/home/marty/documents/archive/consume:/usr/src/paperless/consume" # watch folder + environment: + - "PAPERLESS_TIME_ZONE={{ stack_paperless_tz }}" + - "USERMAP_UID={{ stack_paperless_puid }}" + - "USERMAP_GID={{ stack_paperless_pgid }}" + - "PAPERLESS_OCR_LANGUAGE={{ stack_paperless_ocr_language }}" + - "PAPERLESS_OCR_LANGUAGES={{ stack_paperless_ocr_languages }}" + - "PAPERLESS_OCR_SKIP_ARCHIVE_FILE={{ stack_paperless_ocr_skip_archive_file }}" + - "PAPERLESS_ENABLE_UPDATE_CHECK={{ stack_paperless_enable_update_check }}" + - "PAPERLESS_REDIS=redis://paperless-redis:6379" + - "PAPERLESS_DBHOST=paperless-postgres" + - "PAPERLESS_DBNAME={{ stack_paperless_dbname }}" + - "PAPERLESS_DBUSER={{ stack_paperless_dbuser }}" + - "PAPERLESS_DBPASS={{ stack_paperless_dbpass }}" + - "PAPERLESS_SECRET_KEY={{ stack_paperless_secret_key }}" + - "PAPERLESS_FILENAME_FORMAT={{ stack_paperless_filename_format }}" + - "PAPERLESS_ADMIN_USER={{ stack_paperless_admin_user }}" + - "PAPERLESS_ADMIN_PASSWORD={{ stack_paperless_admin_password }}" + + paperless-postgres: + container_name: paperless-postgres + image: postgres:16.0-alpine #fixedVersion + restart: unless-stopped + networks: + - backend + security_opt: + - no-new-privileges:true + volumes: + - postgres-data:/var/lib/postgresql/data + environment: + POSTGRES_DB: "{{ stack_paperless_dbname }}" + POSTGRES_USER: "{{ stack_paperless_dbuser }}" + POSTGRES_PASSWORD: "{{ stack_paperless_dbpass }}" + + paperless-redis: + container_name: paperless-redis + image: redis:7.2-alpine #fixedVersion + restart: unless-stopped + networks: + - backend + security_opt: + - no-new-privileges:true + volumes: + - redis-data:/data + environment: + REDIS_ARGS: "--save 60 10" + +volumes: + data: + export: + #media: + postgres-data: + redis-data: + +networks: + caddy: + external: true + backend: + name: backend + driver: bridge + +# secrets: +# paperless_db_paperless_passwd: +# file: ./secrets/paperless_db_paperless_passwd +# paperless_secret_key: +# file: ./secrets/paperless_secret_key +# diff --git a/ansible/roles/paperless/tests/inventory b/ansible/roles/paperless/tests/inventory new file mode 100644 index 0000000..878877b --- /dev/null +++ b/ansible/roles/paperless/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/ansible/roles/paperless/tests/test.yml b/ansible/roles/paperless/tests/test.yml new file mode 100644 index 0000000..a60129a --- /dev/null +++ b/ansible/roles/paperless/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - paperless diff --git a/ansible/roles/paperless/vars/main.yml b/ansible/roles/paperless/vars/main.yml new file mode 100644 index 0000000..3082f84 --- /dev/null +++ b/ansible/roles/paperless/vars/main.yml @@ -0,0 +1,2 @@ +--- +# vars file for paperless