charts/charts/paperless

Paperless

This is a helm chart for Paperless-ng. The documentation can be found here.

This chart is not maintained by the upstream project and any issues with the chart should be raised here.

TL;DR;

$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
$ helm install k8s-at-home/paperless

Installing the Chart

To install the chart with the release name my-release:

helm install --name my-release k8s-at-home/paperless

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release --purge

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The chart's values.yaml file contains a set of suggested values for a minimal deployment. Further configuration options are found in the common library. All configuration for the Paperless application itself is through environment variables. Please refer to the links provided in chart's values file.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install paperless \
  --set env.PAPERLESS_TIME_ZONE="America/New_York" \
    k8s-at-home/paperless

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install paperless k8s-at-home/paperless --values values.yaml

---

Upgrading an existing Release to a new major version

A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.

Upgrading from 2.x.x to 3.x.x

Version 3.0.0 of this chart has been adapted for Paperless-ng (currently a fork of the main project). The default values.yaml has been updated accordingly. Changes include:

• A new set of environment variables
• New mouthPath defaults for the consume and export volumes
• Seperate consumer pod no longer required.