Using a volume claim template to define the persistent volume claim for the Redis pod has two advantages: first, it enables using clustered Redis, if we decide that becomes necessary, and second, it makes deleteing and recreating the volume easier in the case of data corruption. Simply scale down the StatefulSet to 0, delete the PVC, and scale the StatefulSet back up. |
||
---|---|---|
.. | ||
README.md | ||
ingress.yaml | ||
kustomization.yaml | ||
paperless-ngx.yaml |
README.md
Paperless-ngx
Paperless-ngx is a community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.
Deploy with kustomize
kubectl apply -k paperless-ngx
Generic resources, including the persistent volumes and pods, are defined in
paperless-ngx/paperless-ngx.yaml
. Environment-specific overrides are
supplied in paperless-ngx/kustomization.yaml
. An Ingress resource is
configured in paperless-ngx/ingress.yaml
.
This deployment uses SQLite as the database engine. Paperless-ngx supports other engines, but SQLite is fine for a single-instance deployment with only a small number of documents.
Authentication via "HTTP remote user" is enabled, and the Ingress is configured to use Authelia. This provides a single sign-on experince, since Paperless-ngx does not currently support LDAP or OAuth/OpenID Connect.