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_data_root |
path | /var/lib/paperless | Root data directory for Paperless-ngx |
paperless_ngx_dirs |
dict | Dictionary of sub-directory paths under data_root. See defaults/main.yml#L11-L16 for an example. |
|
paperless_ngx_enabled |
boolean | false | Enable Paperless-ngx |
paperless_ngx_hostname |
string | Hostname used by Paperless-ngx for generating URLs | |
paperless_ngx_ocr_language |
string | kor | OCR language 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_redis |
string | Redis connection string for Paperless-ngx | |
paperless_ngx_secret_key |
string | Django secret key for Paperless-ngx. See defaults/main.yml#L8 for an example. |
|
paperless_ngx_services |
list | Required. List of service definitions with name and command (defined in vars/) | |
paperless_ngx_time_zone |
string | Asia/Seoul | Time zone for Paperless-ngx |
paperless_ngx_user |
string | paperless | System user for Paperless-ngx services |
paperless_ngx_user_groups |
string | redis | Supplementary groups for the Paperless-ngx user |