2022-07-12 14:58:45 -04:00
# paperless-ng
2021-12-12 17:42:29 -05:00
2022-03-12 01:04:44 -05:00
Paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents.
2021-12-12 17:42:29 -05:00
2022-07-19 09:18:28 -04:00
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.
2022-07-22 20:22:10 -04:00
For more information, please click here: [paperless-ng ](https://truecharts.org/docs/charts/stable/paperless-ng )
2022-07-19 09:18:28 -04:00
2022-07-22 20:22:10 -04:00
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here ](https://github.com/truecharts/charts/issues/new/choose )**
2021-12-12 17:42:29 -05:00
## Source Code
2022-08-08 19:15:26 -04:00
* < https: // github . com / truecharts / charts / tree / master / charts / stable / paperless-ng >
2022-03-12 01:04:44 -05:00
* < https: // github . com / paperless-ngx / paperless-ngx >
* < https: // paperless-ngx . readthedocs . io / en / latest />
2021-12-12 17:42:29 -05:00
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
2022-11-08 23:14:21 -05:00
| 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 |
2021-12-12 17:42:29 -05:00
## Installing the Chart
2022-07-19 09:18:28 -04:00
### TrueNAS SCALE
2022-09-22 10:28:16 -04:00
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/SCALE%20Apps/Installing-an-App ).
2021-12-12 17:42:29 -05:00
2022-07-19 09:18:28 -04:00
### Helm
To install the chart with the release name `paperless-ng`
```console
2022-08-08 19:15:26 -04:00
helm repo add TrueCharts https://charts.truecharts.org
2022-07-19 09:18:28 -04:00
helm repo update
helm install paperless-ng TrueCharts/paperless-ng
```
## Uninstall
### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart**
2021-12-12 17:42:29 -05:00
2022-09-22 10:28:16 -04:00
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/SCALE%20Apps/Upgrade-rollback-delete-an-App ).
2021-12-12 17:42:29 -05:00
2022-07-19 09:18:28 -04:00
### Helm
To uninstall the `paperless-ng` deployment
```console
helm uninstall paperless-ng
```
## Configuration
### Helm
#### Available Settings
2022-09-11 09:56:14 -04:00
Read through the values.yaml file. It has several commented out suggested values.
2022-10-25 07:01:06 -04:00
Other values may be used from the [values.yaml ](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml ) from the [common library ](https://github.com/truecharts/library-charts/tree/main/charts/common ).
2022-07-19 09:18:28 -04:00
2022-08-08 19:15:26 -04:00
#### Configure using the command line
2022-07-19 09:18:28 -04:00
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install` .
```console
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.
```console
helm install paperless-ng TrueCharts/paperless-ng -f values.yaml
```
2022-08-08 19:15:26 -04:00
#### Connecting to other charts
2022-07-19 09:18:28 -04:00
2022-09-22 10:28:16 -04:00
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally ](https://truecharts.org/docs/manual/SCALE%20Apps/linking-apps ) quick-start guide.
2022-07-12 14:58:45 -04:00
2021-12-12 17:42:29 -05:00
## Support
2022-09-22 10:28:16 -04:00
- Please check our [quick-start guides for TrueNAS SCALE ](https://truecharts.org/docs/manual/SCALE%20Apps/Important-MUST-READ ).
2022-07-19 09:18:28 -04:00
- See the [Website ](https://truecharts.org )
2021-12-12 17:42:29 -05:00
- Check our [Discord ](https://discord.gg/tVsPTHWTtr )
- Open a [issue ](https://github.com/truecharts/apps/issues/new/choose )
2022-07-12 17:13:53 -04:00
2021-12-12 17:42:29 -05:00
---
2022-07-12 17:13:53 -04:00
2022-07-19 09:18:28 -04:00
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
2022-09-22 10:28:16 -04:00
Please consider making a [donation ](https://truecharts.org/sponsor ) or contributing back to the project any way you can!
2022-07-19 09:18:28 -04:00
---
2021-12-12 17:42:29 -05:00
All Rights Reserved - The TrueCharts Project