{"id":26906752,"url":"https://github.com/dudecalledbro/document-pi","last_synced_at":"2025-04-01T11:18:34.849Z","repository":{"id":284578953,"uuid":"955397191","full_name":"DudeCalledBro/document-pi","owner":"DudeCalledBro","description":"Ansible playbooks to automate the deployment of Paperless-ngx","archived":false,"fork":false,"pushed_at":"2025-03-26T15:18:37.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T16:29:17.269Z","etag":null,"topics":["ansible","automation","docker-compose","paperless-ngx"],"latest_commit_sha":null,"homepage":"","language":"YAML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DudeCalledBro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"DudeCalledBro"}},"created_at":"2025-03-26T15:17:30.000Z","updated_at":"2025-03-26T15:18:41.000Z","dependencies_parsed_at":"2025-03-26T16:29:34.256Z","dependency_job_id":"11ecb4cf-28e5-4c5c-81d9-08660d849619","html_url":"https://github.com/DudeCalledBro/document-pi","commit_stats":null,"previous_names":["dudecalledbro/document-pi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fdocument-pi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fdocument-pi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fdocument-pi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DudeCalledBro%2Fdocument-pi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DudeCalledBro","download_url":"https://codeload.github.com/DudeCalledBro/document-pi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246628227,"owners_count":20808107,"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","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","automation","docker-compose","paperless-ngx"],"created_at":"2025-04-01T11:18:34.210Z","updated_at":"2025-04-01T11:18:34.838Z","avatar_url":"https://github.com/DudeCalledBro.png","language":"YAML","funding_links":["https://github.com/sponsors/DudeCalledBro"],"categories":[],"sub_categories":[],"readme":"# Document Pi\n\n[![CI](https://github.com/DudeCalledBro/document-pi/actions/workflows/ci.yml/badge.svg)](https://github.com/DudeCalledBro/document-pi/actions/workflows/ci.yml)\n\nThis repository contains the Ansible code for deploying Paperless-ngx using Docker.\n\n## Prerequisites\n\n- Ensure you have Ansible installed (e.g. `pip3 install ansible`)\n- Ensure Docker is installed on the proxy server (you may want to checkout my [ansible-docker-role](https://github.com/DudeCalledBro/ansible-role-docker))\n- **Optional**: Set up a reverse proxy for your Paperless-ngx instance (you may want to checkout my [traefik-deployment](https://github.com/DudeCalledBro/traefik-ansible))\n\n## Installation\n\n1. Copy the example.hosts.yml file to hosts.yml. You also have to setup a variables file for your configuration. Therefore you have to copy example.config.yml to config.yml.\n\n2. Configure the setup (config.yml), such as the Traefik reverse proxy.\n\n    ```yaml\n    # Define the paperless compose override\n    paperless_docker_override:\n      services:\n        broker:\n          networks:\n            - paperless\n    \n        db:\n          networks:\n            - paperless\n    \n        webserver:\n          labels:\n            - traefik.enable=true\n            - traefik.http.routers.paperless.rule=Host(`documents.local`)\n            - traefik.http.routers.paperless.entrypoints=websecure\n            - traefik.http.routers.paperless.tls=true\n            - traefik.http.services.paperless.loadBalancer.server.port=8000\n            - traefik.docker.network=traefik\n          networks:\n            - paperless\n            - traefik\n    \n      # Custom networking in your docker compose override\n      networks:\n        paperless:\n          name: paperless\n        traefik:\n          name: traefik\n    ```\n\n3. Run the Ansible playbook to deploy Jellyfin\n\n    ```bash\n    ansible-playbook main.yml\n    ```\n\n\u003e You may have to enter a password to SSH into the target system, so you need to add `-k` after the `ansible-playbook` command.\n\n## License\n\nCopyright © 2025 Niclas Spreng\n\nLicensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdudecalledbro%2Fdocument-pi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdudecalledbro%2Fdocument-pi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdudecalledbro%2Fdocument-pi/lists"}