Skip to content

paperless_ngx

Configure and deploy Paperless-ngx

Builds Paperless-ngx from nixpkgs (pinned commit) and creates multiple s6 services (web, worker, beat, consumer).

Variables

Variable Type Default Description
paperless_ngx_enabled boolean false Enable Paperless-ngx
paperless_ngx_env dict Environment variables for Paperless-ngx configuration. See defaults/main.yml#L7-L8 and the upstream documentation for an example.
paperless_ngx_package string Nix package attribute for Paperless-ngx
paperless_ngx_package_path path /opt/paperless Nix build output path for Paperless-ngx
paperless_ngx_port string 3002 TCP port for the Paperless-ngx web service
paperless_ngx_user string paperless System user for Paperless-ngx services
paperless_ngx_user_groups string redis Supplementary groups for the Paperless-ngx user