scanservjs-helm/README.md

ScanservJS Helm chart

This independent chart uses the upstream ScanservJS image and creates the scanner Deployment, Service, ConfigMap, and optional Ingress. Its Git tag tracks the tested upstream release (v3.3.0). The chart owns the Send to Paperless action in files/send-to-paperless.js; users select the shared PVC, output and consume subpaths, scanner eSCL address, and ingress host through Helm values. No site-specific address or recipient is built into the chart.

The action is a filesystem handoff, not email: it validates staged PDFs, images, or image ZIPs, converts a ZIP to one PDF, atomically places the result in the configured consume directory, and only then removes the staged file. Give ScanservJS and Paperless access to the same claim. The homelab values are in homelab-gitops/apps/scanner.

helm repo add brunner.ninja https://brunner.ninja/charts
helm repo update brunner.ninja
helm upgrade --install scanner brunner.ninja/scanservjs \
  --namespace paperless-ngx -f values.yaml --wait --timeout 10m

./test.sh checks the rendered topology and runs the real action with sample PDF/JPEG files. ./install.sh values.yaml installs from this checkout. CI publishes and promotes the chart using PACKAGE_USERNAME, PACKAGE_TOKEN, and GITOPS_TOKEN Actions secrets.