{"id":25524807,"url":"https://github.com/bodsch/ansible-paperless","last_synced_at":"2026-05-04T15:38:05.147Z","repository":{"id":278020576,"uuid":"934259300","full_name":"bodsch/ansible-paperless","owner":"bodsch","description":"Ansible role to install and configure paperless","archived":false,"fork":false,"pushed_at":"2025-08-19T07:25:13.000Z","size":52,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-19T09:51:07.248Z","etag":null,"topics":["ansible","ansible-role","automation","docker","docker-compose","paperless","paperless-ngx"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bodsch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-17T14:35:40.000Z","updated_at":"2025-08-19T07:25:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab7ab72a-4f0e-4ca9-a58c-0862b0766ede","html_url":"https://github.com/bodsch/ansible-paperless","commit_stats":null,"previous_names":["bodsch/ansible-paperless"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/bodsch/ansible-paperless","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodsch%2Fansible-paperless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodsch%2Fansible-paperless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodsch%2Fansible-paperless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodsch%2Fansible-paperless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bodsch","download_url":"https://codeload.github.com/bodsch/ansible-paperless/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodsch%2Fansible-paperless/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271657783,"owners_count":24797935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible","ansible-role","automation","docker","docker-compose","paperless","paperless-ngx"],"created_at":"2025-02-19T20:16:19.783Z","updated_at":"2026-05-04T15:38:05.118Z","avatar_url":"https://github.com/bodsch.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Ansible Role:  `paperless`\n\nAnsible role to install and configure [paperless-ngx](https://github.com/paperless-ngx/paperless-ngx).\n\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bodsch/ansible-paperless/main.yml?branch=main)][ci]\n[![GitHub issues](https://img.shields.io/github/issues/bodsch/ansible-paperless)][issues]\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/bodsch/ansible-paperless)][releases]\n[![Ansible Downloads](https://img.shields.io/ansible/role/d/bodsch/paperless?logo=ansible)][galaxy]\n\n[ci]: https://github.com/bodsch/ansible-paperless/actions\n[issues]: https://github.com/bodsch/ansible-paperless/issues?q=is%3Aopen+is%3Aissue\n[releases]: https://github.com/bodsch/ansible-paperless/releases\n[galaxy]: https://galaxy.ansible.com/ui/standalone/roles/bodsch/paperless/\n\n## Requirements \u0026 Dependencies\n\nAnsible Collections\n\n- [bodsch.core](https://github.com/bodsch/ansible-collection-core)\n- [bodsch.docker](https://github.com/bodsch/ansible-collection-docker) (min. version: 1.2.0)\n- [bodsch.scm](https://github.com/bodsch/ansible-collection-scm)\n\n```bash\nansible-galaxy collection install bodsch.core\nansible-galaxy collection install bodsch.docker\nansible-galaxy collection install bodsch.scm\n```\nor\n```bash\nansible-galaxy collection install --requirements-file collections.yml\n```\n\n## tested operating systems\n\n* ArchLinux\n* Debian based\n    - Debian 12\n    - Ubuntu 22.04\n\n## usage\n\n\n```yaml\npaperless_version: 2.14.7\n\npaperless_release: {}\n\npaperless_direct_download: false\n\npaperless_user:\n  owner: paperless\n  group: paperless\n  home: /home/paperless\n\npaperless_install_path: \"/opt/paperless\"\n\npaperless_service:\n  state: started\n  enabled: true\n  command: \"docker compose\"\n\npaperless_compose_networks: []\n  # - name: paperless\n  #   state: present\n  #   enable_ipv6: false\n  #   ipam:\n  #     driver: default\n  #     config:\n  #       - subnet: \"172.10.10.0/24\"\n\npaperless_compose_services: []\n  # - name: broker\n  #   image: docker.io/library/redis:7\n  #   restart: unless-stopped\n  #   volumes:\n  #     - redisdata:/data\n\npaperless_compose_volumes: []\n  # - name: redisdata\n\npaperless_config:\n  usermap:\n    uid: \"\"                             # 1000\n    gid: \"\"                             # 1000\n  url: \"\"                               # https://paperless.example.com\n  secret_key: ''                        # change-me\n  time_zone: ''                         # Europe/Berlin\n  ocr_languages: []\n    # - deu\n    # - eng\n  ocr_default_language: ''              # deu\n```\n\n### example\n\n```yaml\npaperless_config:\n  usermap:\n    uid: 1000\n    gid: 1000\n  url: \"https://paperless.molecule.local\"\n  secret_key: 'ywFJhEdXaQK088TGqDJWTu6ivkrT'\n  time_zone: Europe/Berlin\n  ocr_languages:\n    - deu\n    - eng\n  ocr_default_language: deu\n\npaperless_compose_networks:\n  - name: paperless\n    state: present\n    enable_ipv6: false\n    ipam:\n      driver: default\n      config:\n        - subnet: \"172.10.10.0/24\"\n\npaperless_compose_services:\n  - name: broker\n    image: docker.io/library/redis:7\n    restart: unless-stopped\n    volumes:\n      - \"{{ paperless_install_path }}/paperless-data/redis-data:/data\"\n    sysctls:\n      - net.core.somaxconn=4096\n    deploy:\n      resources:\n        limits:\n          cpus: '0.3'\n          memory: \"256M\"\n        reservations:\n          cpus: '0.1'\n          memory: \"128M\"\n\n  - name: webserver\n    image: ghcr.io/paperless-ngx/paperless-ngx:latest\n    restart: unless-stopped\n    depends_on:\n      - broker\n    ports:\n      - \"8000:8000\"\n    volumes:\n      - \"{{ paperless_install_path }}/paperless-data/data:/usr/src/paperless/data\"\n      - \"{{ paperless_install_path }}/paperless-data/media:/usr/src/paperless/media\"\n      - \"{{ paperless_install_path }}/paperless-data/export:/usr/src/paperless/export\"\n      - \"{{ paperless_install_path }}/paperless-data/consume:/usr/src/paperless/consume\"\n    env_file: ../docker-compose.env\n    environment:\n      PAPERLESS_REDIS: redis://broker:6379\n```\n\n\n## Contribution\n\nPlease read [Contribution](CONTRIBUTING.md)\n\n## Development,  Branches (Git Tags)\n\nThe `master` Branch is my *Working Horse* includes the \"latest, hot shit\" and can be complete broken!\n\nIf you want to use something stable, please use a [Tagged Version](https://github.com/bodsch/ansible-paperless/-/tags)!\n\n---\n\n## Author and License\n\n- Bodo Schulz\n\n## License\n\n[Apache](LICENSE)\n\n**FREE SOFTWARE, HELL YEAH!**\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbodsch%2Fansible-paperless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbodsch%2Fansible-paperless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbodsch%2Fansible-paperless/lists"}