catalog/stable/paperless-ng/7.0.9/README.md

3.4 KiB

paperless-ng

Paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents.

TrueCharts can be installed as both normal Helm Charts or as Apps on TrueNAS SCALE.

This readme is just an automatically generated general guide on installing our Helm Charts and Apps. For more information, please click here: paperless-ng

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

Source Code

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository Name Version
https://charts.truecharts.org/ postgresql 8.0.122
https://charts.truecharts.org redis 3.0.121
https://library-charts.truecharts.org common 10.9.4

Installing the Chart

TrueNAS SCALE

To install this Chart on TrueNAS SCALE check our Quick-Start Guide.

Helm

To install the chart with the release name paperless-ng

helm repo add TrueCharts https://charts.truecharts.org
helm repo update
helm install paperless-ng TrueCharts/paperless-ng

Uninstall

TrueNAS SCALE

Upgrading, Rolling Back and Uninstalling the Chart

To upgrade, rollback or delete this Chart from TrueNAS SCALE check our Quick-Start Guide.

Helm

To uninstall the paperless-ng deployment

helm uninstall paperless-ng

Configuration

Helm

Available Settings

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.

Configure using the command line

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

helm install paperless-ng \
  --set env.TZ="America/New York" \
    TrueCharts/paperless-ng

Configure using a yaml file

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

helm install paperless-ng TrueCharts/paperless-ng -f values.yaml

Connecting to other charts

If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our Linking Charts Internally quick-start guide.

Support


Sponsor TrueCharts

TrueCharts can only exist due to the incredible effort of our staff. Please consider making a donation or contributing back to the project any way you can!


All Rights Reserved - The TrueCharts Project