https://github.com/bodsch/ansible-paperless

Ansible role to install and configure paperless
https://github.com/bodsch/ansible-paperless

ansible ansible-role automation docker docker-compose paperless paperless-ngx

Last synced: 2 months ago
JSON representation

Ansible role to install and configure paperless

• Host: GitHub
• URL: https://github.com/bodsch/ansible-paperless
• Owner: bodsch
• License: apache-2.0
• Created: 2025-02-17T14:35:40.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-08-19T07:25:13.000Z (2 months ago)
• Last Synced: 2025-08-19T09:51:07.248Z (2 months ago)
• Topics: ansible, ansible-role, automation, docker, docker-compose, paperless, paperless-ngx
• Language: Jinja
• Homepage:
• Size: 50.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# Ansible Role:  `paperless`

Ansible role to install and configure [paperless-ngx](https://github.com/paperless-ngx/paperless-ngx).

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bodsch/ansible-paperless/main.yml?branch=main)][ci]

[![GitHub issues](https://img.shields.io/github/issues/bodsch/ansible-paperless)][issues]

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/bodsch/ansible-paperless)][releases]

[![Ansible Downloads](https://img.shields.io/ansible/role/d/bodsch/paperless?logo=ansible)][galaxy]

[ci]: https://github.com/bodsch/ansible-paperless/actions

[issues]: https://github.com/bodsch/ansible-paperless/issues?q=is%3Aopen+is%3Aissue

[releases]: https://github.com/bodsch/ansible-paperless/releases

[galaxy]: https://galaxy.ansible.com/ui/standalone/roles/bodsch/paperless/

## Requirements & Dependencies

Ansible Collections

- [bodsch.core](https://github.com/bodsch/ansible-collection-core)

- [bodsch.docker](https://github.com/bodsch/ansible-collection-docker) (min. version: 1.2.0)

- [bodsch.scm](https://github.com/bodsch/ansible-collection-scm)

```bash

ansible-galaxy collection install bodsch.core

ansible-galaxy collection install bodsch.docker

ansible-galaxy collection install bodsch.scm

```

or

```bash

ansible-galaxy collection install --requirements-file collections.yml

```

## tested operating systems

* ArchLinux

* Debian based

    - Debian 12

    - Ubuntu 22.04

## usage

```yaml

paperless_version: 2.14.7

paperless_release: {}

paperless_direct_download: false

paperless_user:

  owner: paperless

  group: paperless

  home: /home/paperless

paperless_install_path: "/opt/paperless"

paperless_service:

  state: started

  enabled: true

  command: "docker compose"

paperless_compose_networks: []

  # - name: paperless

  #   state: present

  #   enable_ipv6: false

  #   ipam:

  #     driver: default

  #     config:

  #       - subnet: "172.10.10.0/24"

paperless_compose_services: []

  # - name: broker

  #   image: docker.io/library/redis:7

  #   restart: unless-stopped

  #   volumes:

  #     - redisdata:/data

paperless_compose_volumes: []

  # - name: redisdata

paperless_config:

  usermap:

    uid: ""                             # 1000

    gid: ""                             # 1000

  url: ""                               # https://paperless.example.com

  secret_key: ''                        # change-me

  time_zone: ''                         # Europe/Berlin

  ocr_languages: []

    # - deu

    # - eng

  ocr_default_language: ''              # deu

```

### example

```yaml

paperless_config:

  usermap:

    uid: 1000

    gid: 1000

  url: "https://paperless.molecule.local"

  secret_key: 'ywFJhEdXaQK088TGqDJWTu6ivkrT'

  time_zone: Europe/Berlin

  ocr_languages:

    - deu

    - eng

  ocr_default_language: deu

paperless_compose_networks:

  - name: paperless

    state: present

    enable_ipv6: false

    ipam:

      driver: default

      config:

        - subnet: "172.10.10.0/24"

paperless_compose_services:

  - name: broker

    image: docker.io/library/redis:7

    restart: unless-stopped

    volumes:

      - "{{ paperless_install_path }}/paperless-data/redis-data:/data"

    sysctls:

      - net.core.somaxconn=4096

    deploy:

      resources:

        limits:

          cpus: '0.3'

          memory: "256M"

        reservations:

          cpus: '0.1'

          memory: "128M"

  - name: webserver

    image: ghcr.io/paperless-ngx/paperless-ngx:latest

    restart: unless-stopped

    depends_on:

      - broker

    ports:

      - "8000:8000"

    volumes:

      - "{{ paperless_install_path }}/paperless-data/data:/usr/src/paperless/data"

      - "{{ paperless_install_path }}/paperless-data/media:/usr/src/paperless/media"

      - "{{ paperless_install_path }}/paperless-data/export:/usr/src/paperless/export"

      - "{{ paperless_install_path }}/paperless-data/consume:/usr/src/paperless/consume"

    env_file: ../docker-compose.env

    environment:

      PAPERLESS_REDIS: redis://broker:6379

```

## Contribution

Please read [Contribution](CONTRIBUTING.md)

## Development,  Branches (Git Tags)

The `master` Branch is my *Working Horse* includes the "latest, hot shit" and can be complete broken!

If you want to use something stable, please use a [Tagged Version](https://github.com/bodsch/ansible-paperless/-/tags)!

---

## Author and License

- Bodo Schulz

## License

[Apache](LICENSE)

**FREE SOFTWARE, HELL YEAH!**