{"id":50911515,"url":"https://github.com/daemonless/paperless-ngx","last_synced_at":"2026-06-16T10:31:39.220Z","repository":{"id":357262938,"uuid":"1235967042","full_name":"daemonless/paperless-ngx","owner":"daemonless","description":"A community-supported supercharged document management system: scan, index and archive all your documents","archived":false,"fork":false,"pushed_at":"2026-06-15T09:01:30.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-15T11:39:40.853Z","etag":null,"topics":["freebsd","oci-image","paperless-ngx","podman","self-hosted"],"latest_commit_sha":null,"homepage":"https://daemonless.io","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daemonless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2026-05-11T20:33:55.000Z","updated_at":"2026-06-15T09:01:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/daemonless/paperless-ngx","commit_stats":null,"previous_names":["daemonless/paperless-ngx"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/daemonless/paperless-ngx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemonless%2Fpaperless-ngx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemonless%2Fpaperless-ngx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemonless%2Fpaperless-ngx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemonless%2Fpaperless-ngx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daemonless","download_url":"https://codeload.github.com/daemonless/paperless-ngx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemonless%2Fpaperless-ngx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34402648,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-16T02:00:06.860Z","response_time":126,"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":["freebsd","oci-image","paperless-ngx","podman","self-hosted"],"created_at":"2026-06-16T10:31:38.616Z","updated_at":"2026-06-16T10:31:39.213Z","avatar_url":"https://github.com/daemonless.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nTHIS FILE IS AUTOGENERATED - DO NOT EDIT MANUALLY\nSource: dbuild templates\n--\u003e\n\n# Paperless-ngx\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/paperless-ngx/build.yaml?style=flat-square\u0026label=Build\u0026color=green)](https://github.com/daemonless/paperless-ngx/actions)\n[![Last Commit](https://img.shields.io/github/last-commit/daemonless/paperless-ngx?style=flat-square\u0026label=Last+Commit\u0026color=blue)](https://github.com/daemonless/paperless-ngx/commits)\n\nA community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.\n\n| | |\n|---|---|\n| **Port** | 8000 |\n| **Registry** | `ghcr.io/daemonless/paperless-ngx` |\n| **Source** | [https://github.com/paperless-ngx/paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) |\n| **Website** | [https://paperless-ngx.org/](https://paperless-ngx.org/) |\n\n## Version Tags\n\n| Tag | Description | Best For |\n| :--- | :--- | :--- |\n| `latest` | **Upstream Binary**. Built from official release. | Most users. Matches Linux Docker behavior. |\n\n## Prerequisites\n\nBefore deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.\n\n## Deployment\n\n### Podman Compose\n\n```yaml\nservices:\n  paperless-ngx:\n    image: ghcr.io/daemonless/paperless-ngx:latest\n    container_name: paperless-ngx\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=UTC\n      - PAPERLESS_ADMIN_USER=admin\n      - PAPERLESS_ADMIN_PASSWORD=\u003cPAPERLESS_ADMIN_PASSWORD\u003e\n    volumes:\n      - \"/path/to/containers/paperless-ngx:/config\"\n      - \"/path/to/containers/paperless-ngx/config/media/documents:/config/media/documents\"\n    ports:\n      - 8000:8000\n      - 5555:5555\n    restart: unless-stopped\n```\n\n### Podman CLI\n\n```bash\npodman run -d --name paperless-ngx \\\n  -p 8000:8000 \\\n  -p 5555:5555 \\\n  -e PUID=1000 \\\n  -e PGID=1000 \\\n  -e TZ=UTC \\\n  -e PAPERLESS_ADMIN_USER=admin \\\n  -e PAPERLESS_ADMIN_PASSWORD=\u003cPAPERLESS_ADMIN_PASSWORD\u003e \\\n  -v /path/to/containers/paperless-ngx:/config \\\n  -v /path/to/containers/paperless-ngx/config/media/documents:/config/media/documents \\\n  ghcr.io/daemonless/paperless-ngx:latest\n```\n\n### Ansible\n\n```yaml\n- name: Deploy paperless-ngx\n  containers.podman.podman_container:\n    name: paperless-ngx\n    image: ghcr.io/daemonless/paperless-ngx:latest\n    state: started\n    restart_policy: always\n    env:\n      PUID: \"1000\"\n      PGID: \"1000\"\n      TZ: \"UTC\"\n      PAPERLESS_ADMIN_USER: \"admin\"\n      PAPERLESS_ADMIN_PASSWORD: \"\u003cPAPERLESS_ADMIN_PASSWORD\u003e\"\n    ports:\n      - \"8000:8000\"\n      - \"5555:5555\"\n    volumes:\n      - \"/path/to/containers/paperless-ngx:/config\"\n      - \"/path/to/containers/paperless-ngx/config/media/documents:/config/media/documents\"\n```\n\n## Parameters\n\n### Environment Variables\n\n| Variable | Default | Description |\n|----------|---------|-------------|\n| `PUID` | `1000` | User ID for the application process |\n| `PGID` | `1000` | Group ID for the application process |\n| `TZ` | `UTC` | Timezone for the container |\n| `PAPERLESS_ADMIN_USER` | `admin` | Optional - Set name of the admin user on first start |\n| `PAPERLESS_ADMIN_PASSWORD` | `\u003cPAPERLESS_ADMIN_PASSWORD\u003e` | Optional - Set password of the admin user on first start |\n\n### Volumes\n\n| Path | Description |\n|------|-------------|\n| `/config` | Configuration directory |\n| `/config/media/documents` | Optional - the actual document store (originals, archive and thumbnails) |\n\n### Ports\n\n| Port | Protocol | Description |\n|------|----------|-------------|\n| `8000` | TCP | Web UI |\n| `5555` | TCP | Flower monitoring UI available at '/flower', optional |\n\n## First time setup\nTo configure the admin user with a password during the first startup, you can define some\nadditional environment variables in your container file:\n```yaml\nservices:\n  paperlessngx:\n    env:\n      - PAPERLESS_ADMIN_USER=\"\"\n      - PAPERLESS_ADMIN_PASSWORD=\"\"\n```\nThese 2 variables can be removed after the initial setup was done and paperless won't change an existing admin user's\npassword when these vars are defined.\n\n## Configuration\nConfiguration is best done using a `.env` file next to your compose.yaml.\nIf no `.env` file is in compose.yaml, paperless-ngx will use default values.\n\n## Documents directory\nIf you want to keep your documents in a separate ZFS filesystem, you can mount it at `/config/media/documents`.\nThis directoru should contain these 3 directories:\n```\n- archive\n- originals\n- thumbnails\n```\n\n\n**Architectures:** amd64\n**User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000)\n**Base:** FreeBSD 15.0\n\n---\n\nNeed help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaemonless%2Fpaperless-ngx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaemonless%2Fpaperless-ngx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaemonless%2Fpaperless-ngx/lists"}