{"id":46269901,"url":"https://github.com/beuterei/paperless-ngx","last_synced_at":"2026-03-04T03:02:05.834Z","repository":{"id":325873908,"uuid":"1102654136","full_name":"Beuterei/paperless-ngx","owner":"Beuterei","description":"Setup for paperless-ngx as document index/archive.","archived":false,"fork":false,"pushed_at":"2025-11-23T21:51:31.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-23T23:27:13.288Z","etag":null,"topics":["docker","docker-compose","paperless-ngx"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Beuterei.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-23T20:56:53.000Z","updated_at":"2025-11-23T21:48:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Beuterei/paperless-ngx","commit_stats":null,"previous_names":["beuterei/paperless-ngx"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Beuterei/paperless-ngx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beuterei%2Fpaperless-ngx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beuterei%2Fpaperless-ngx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beuterei%2Fpaperless-ngx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beuterei%2Fpaperless-ngx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Beuterei","download_url":"https://codeload.github.com/Beuterei/paperless-ngx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beuterei%2Fpaperless-ngx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30070479,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T01:03:42.280Z","status":"online","status_checked_at":"2026-03-04T02:00:07.464Z","response_time":59,"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":["docker","docker-compose","paperless-ngx"],"created_at":"2026-03-04T03:02:05.180Z","updated_at":"2026-03-04T03:02:05.817Z","avatar_url":"https://github.com/Beuterei.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://docs.paperless-ngx.com/assets/logo_full_white.svg\"\u003e\n    \u003cimg alt=\"Logo\" src=\"https://docs.paperless-ngx.com/assets/logo_full_white.svg\" height=\"60\"\u003e\n  \u003c/picture\u003e\n\n  \u003ch3 align=\"center\"\u003epaperless-ngx\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Docker setup for paperless-ngx\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    ·\n    \u003ca href=\"https://github.com/Beuterei/paperless-ngx/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/Beuterei/paperless-ngx/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\nSmall docker setup for paperless-ngx.\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started Develop\n\nTo get a local copy up and running follow these simple steps.\n\n### Prerequisites\n\n- [Docker](https://docs.docker.com/get-docker/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\n### Installation\n\n1. Clone the repo\n\n```sh\ngit clone https://github.com/Beuterei/paperless-ngx.git\n```\n\n2. Start docker-compose\n\n```sh\ndocker-compose up --build\n```\n\n3. Set permissions for WebDAV\n\n```sh\ndocker exec $(docker-compose ps -q webdav) chmod -R 777 /var/lib/dav\n```\n\n4. Navigate to `localhost:3500`\n\n### Customization\n\n1. Create a `.env` file\n\n```sh\ntouch .env\n```\n\n2. Overwrite variables as you like (format: `{variable name}={variable value}`)\n\n| Variable                    | Description                          | Default value | Required |\n| --------------------------- | ------------------------------------ | ------------- | -------- |\n| `POSTGRES_PASSWORD`         | Password for the PostgreSQL database | none          | true     |\n| `PAPERLESS_WEBDAV_USER`     | Username for WebDAV access           | none          | true     |\n| `PAPERLESS_WEBDAV_PASSWORD` | Password for WebDAV access           | none          | true     |\n\n## Getting Started Production\n\nTo get a copy up and running follow these simple steps.\n\n### Prerequisites\n\n- [Docker](https://docs.docker.com/get-docker/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\n### Installation\n\n1. Clone the repo\n\n```sh\ngit clone https://github.com/Beuterei/paperless-ngx.git\n```\n\n2. Create a `.env.production` file\n\n```sh\ntouch .env.production\n```\n\n3. Overwrite all variables marked under Customization as required\n4. Start docker-compose\n\n```sh\ndocker-compose --env-file ./.env.production -f docker-compose.yml -f docker-compose.production.yml up -d\n```\n\n5. Set permissions for WebDAV\n\n```sh\ndocker exec paperlessWebdavProd chmod -R 777 /var/lib/dav\n```\n\n### Customization\n\n1. Create a `.env.production` file\n\n```sh\ntouch .env.production\n```\n\n2. Overwrite variables as you like (format: `{variable name}={variable value}`)\n\n| Variable                            | Description                                                                     | Default value            | Required |\n| ----------------------------------- | ------------------------------------------------------------------------------- | ------------------------ | -------- |\n| `POSTGRES_PASSWORD`                 | Password for the PostgreSQL database                                            | none                     | true     |\n| `PAPERLESS_HOST`                    | Hostname/domain for your paperless-ngx instance (used for VIRTUAL_HOST and URL) | none                     | true     |\n| `PAPERLESS_LETSENCRYPT_HOST`        | Hostname/domain for Let's Encrypt                                               | ${PAPERLESS_HOST}        | false    |\n| `PAPERLESS_WEBDAV_HOST`             | Hostname/domain for WebDAV service                                              | none                     | true     |\n| `PAPERLESS_WEBDAV_LETSENCRYPT_HOST` | Hostname/domain for WebDAV Let's Encrypt                                        | ${PAPERLESS_WEBDAV_HOST} | false    |\n| `PAPERLESS_WEBDAV_USER`             | Username for WebDAV access                                                      | none                     | true     |\n| `PAPERLESS_WEBDAV_PASSWORD`         | Password for WebDAV access                                                      | none                     | true     |\n| `ACME_CHALLENGE`                    | ACME challenge type for Let's Encrypt                                           | HTTP-01                  | false    |\n| `PAPERLESS_SECRET_KEY`              | Secret key for the paperless-ngx instance                                       | none                     | true     |\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/Beuterei/paperless-ngx.svg?style=flat-square\n[contributors-url]: https://github.com/Beuterei/paperless-ngx/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/Beuterei/paperless-ngx.svg?style=flat-square\n[forks-url]: https://github.com/Beuterei/paperless-ngx/network/members\n[stars-shield]: https://img.shields.io/github/stars/Beuterei/paperless-ngx.svg?style=flat-square\n[stars-url]: https://github.com/Beuterei/paperless-ngx/stargazers\n[issues-shield]: https://img.shields.io/github/issues/Beuterei/paperless-ngx.svg?style=flat-square\n[issues-url]: https://github.com/Beuterei/paperless-ngx/issues\n[license-shield]: https://img.shields.io/github/license/Beuterei/paperless-ngx.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeuterei%2Fpaperless-ngx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeuterei%2Fpaperless-ngx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeuterei%2Fpaperless-ngx/lists"}