paperless¶
Paperless - Index and archive all of your scanned paper documents
This chart is not maintained by the upstream project and any issues with the chart should be raised here
Chart taken from k8s-at-home repo here.
Source Code¶
- https://github.com/paperless-ngx/paperless-ngx
- https://github.com/zekker6/helm-charts/tree/main/charts/apps/paperless
Requirements¶
Kubernetes: >=1.16.0-0
Dependencies¶
| Repository | Name | Version |
|---|---|---|
| https://charts.bitnami.com/bitnami | postgresql | 16.x |
| https://charts.bitnami.com/bitnami | redis | 20.6.x |
| https://zekker6.github.io/helm-charts | common | 0.5.2 |
TL;DR¶
helm repo add zekker6 https://zekker6.github.io/helm-charts/
helm repo update
helm install paperless zekker6/paperless
Installing the Chart¶
To install the chart with the release name paperless
helm install paperless zekker6/paperless
Uninstalling the Chart¶
To uninstall the paperless deployment
helm uninstall paperless
The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.
Configuration¶
Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.
Specify each parameter using the --set key=value[,key=value] argument to helm install.
helm install paperless \
--set env.TZ="America/New York" \
zekker6/paperless
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
helm install paperless zekker6/paperless -f values.yaml
Custom configuration¶
N/A
Values¶
Important: When deploying an application Helm chart you can add more values from our common library chart here
| Key | Type | Default | Description |
|---|---|---|---|
| env | object | See below | See the following files for additional environment variables: https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose/ https://github.com/paperless-ngx/paperless-ngx/blob/main/paperless.conf.example |
| env.COMPOSE_PROJECT_NAME | string | "paperless" | Project name |
| env.PAPERLESS_DBHOST | string | nil | Database host to use |
| env.PAPERLESS_OCR_LANGUAGE | string | "eng" | OCR languages to install |
| env.PAPERLESS_PORT | int | 8000 | Port to use |
| env.PAPERLESS_REDIS | string | nil | Redis to use |
| image.pullPolicy | string | "IfNotPresent" | image pull policy |
| image.repository | string | "ghcr.io/paperless-ngx/paperless-ngx" | image repository |
| image.tag | string | chart.appVersion | image tag |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| persistence.consume | object | See values.yaml | Configure volume to monitor for new documents. |
| persistence.data | object | See values.yaml | Configure persistence for data. |
| persistence.export | object | See values.yaml | Configure export volume. |
| persistence.media | object | See values.yaml | Configure persistence for media. |
| postgresql | object | See values.yaml | Enable and configure postgresql database subchart under this key. For more options see postgresql chart documentation |
| redis | object | See values.yaml | Enable and configure redis subchart under this key. For more options see redis chart documentation |
| service | object | See values.yaml | Configures service settings for the chart. |
Older versions¶
A historical overview of changes can be found on ArtifactHUB
Support¶
Autogenerated from chart metadata using helm-docs v1.14.2