Marko Oldenburg
48f0388d3b
Improved the readiness and liveness probes for the paperless-ngx chart by switching from exec commands to HTTP GET requests. This change allows for more reliable checks that verify the application is up and fully running based on the web server's response. The readiness probe now checks the root path and will only return success if the application is fully connected to the database and Redis, improving traffic flow during startup. In addition, the chart version was updated from 0.25.0 to 0.25.1 to reflect these changes. There are no breaking changes, but the adjustments to the probes enhance the overall stability and monitoring capabilities of the deployment.
Paperless-ngx
A community-supported supercharged version of paperless: scan, index and archive all your physical documents
Homepage: https://git.cooltux.net/marko/HelmChartSammlung/src/branch/main/charts/paperless-ngx
This chart is not maintained by the upstream project and any issues with the chart should be raised here
Source Code
Requirements
Kubernetes: >=1.28.0-0
Dependencies
| Repository | Name | Version |
|---|---|---|
| https://bjw-s.github.io/helm-charts | common | 4.4.0 |
| https://charts.bitnami.com/bitnami | mariadb | 23.2.4 |
| https://charts.bitnami.com/bitnami | postgresql | 18.1.11 |
| https://charts.bitnami.com/bitnami | redis | 24.0.0 |
Installing the Chart
To install the chart with the release name paperless-ngx
Traditional
helm repo add cooltux https://git.cooltux.net/api/packages/marko/helm
helm repo update
helm install cooltux/paperless-ngx
Uninstalling the Chart
To uninstall the paperless-ngx deployment
helm uninstall paperless-ngx
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 bjw-s common library.
Specify each parameter using the --set key=value[,key=value] argument to helm install.
helm install paperless-ngx \
--set env.TZ="America/New York" \
cooltux/paperless-ngx
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
helm install paperless-ngx cooltux/paperless-ngx -f values.yaml
Custom configuration
Database Installation
Paperless-ngx supports PostgreSQL and MariaDB.
This chart can install PostgreSQL or MariaDB and configure Paperless-ngx automatically.
See each database section in values.yaml for configuration examples.
Values
Important: When deploying an application Helm chart you can add more values from the bjw-s common library chart here
| Key | Type | Default | Description |
|---|---|---|---|
| env | object | See values.yaml | Environment variables [ref] |
| env.TZ | string | "UTC" |
Set the container timezone |
| image.pullPolicy | string | "IfNotPresent" |
Image pull policy |
| image.repository | string | "ghcr.io/paperless-ngx/paperless-ngx" |
Image repository |
| image.tag | string | "2.20.0" |
Image tag |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| mariadb | object | See values.yaml | Enable and configure mariadb database subchart under this key. If enabled, the app's db envs will be set for you. [ref] |
| persistence.consume | object | See values.yaml | Configure consume volume settings for the chart under this key. |
| persistence.data | object | See values.yaml | Configure data volume settings for the chart under this key. |
| persistence.export | object | See values.yaml | Configure export volume settings for the chart under this key. |
| persistence.media | object | See values.yaml | Configure media volume settings for the chart under this key. |
| postgresql | object | See values.yaml | Enable and configure postgresql database subchart under this key. If enabled, the app's db envs will be set for you. [ref] |
| redis | object | See values.yaml | Enable and configure redis subchart under this key. If enabled, the app's Redis env will be set for you. [ref] |
| service.main | object | See values.yaml | Configures service settings for the chart. |
Autogenerated from chart metadata using helm-docs