Marko Oldenburg
841a8dafb0
All checks were successful
Build Helm Chart / helm-package (push) Successful in 21s
Updated the Chart.yaml and README.md files for the paperless-ngx Helm chart to reflect the new version 0.25.6. This change is necessary to ensure that users are aware of the latest updates and improvements in the software. The appVersion remains at 2.20.0, and the kubeVersion is still set to ">=1.28.0-0". The README badge for the version has also been updated to maintain consistency and inform users of the current version being used.
105 lines
7.5 KiB
Markdown
105 lines
7.5 KiB
Markdown
# Paperless-ngx
|
|
|
|
<img src="https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/b948750/src-ui/src/assets/logo-notext.svg" align="right" width="92" alt="paperless-ngx logo">
|
|
|
|
|
|
|
|
|
|
|
|
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](https://git.cooltux.net/marko/HelmChartSammlung/issues/new?assignees=marko&labels=bug&template=bug_report.yaml&name=paperless-ngx&version=0.25.0)**
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/paperless-ngx/paperless-ngx>
|
|
|
|
## 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
|
|
|
|
```console
|
|
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
|
|
|
|
```console
|
|
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](./values.yaml) file. It has several commented out suggested values.
|
|
Other values may be used from the [values.yaml](https://github.com/bjw-s/helm-charts/tree/a081de5/charts/library/common/values.yaml) from the [bjw-s common library](https://github.com/bjw-s/helm-charts/tree/a081de5/charts/library/common).
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
```console
|
|
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.
|
|
|
|
```console
|
|
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`](./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](https://github.com/bjw-s/helm-charts/tree/a081de5/charts/library/common)
|
|
|
|
| Key | Type | Default | Description |
|
|
| ------------------- | ------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| env | object | See [values.yaml](./values.yaml) | Environment variables [[ref]](https://docs.paperless-ngx.com/configuration/) |
|
|
| 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](./values.yaml) | Enable and configure ingress settings for the chart under this key. |
|
|
| mariadb | object | See [values.yaml](./values.yaml) | Enable and configure mariadb database subchart under this key. If enabled, the app's db envs will be set for you. [[ref]](https://github.com/bitnami/charts/tree/main/bitnami/mariadb) |
|
|
| persistence.consume | object | See [values.yaml](./values.yaml) | Configure consume volume settings for the chart under this key. |
|
|
| persistence.data | object | See [values.yaml](./values.yaml) | Configure data volume settings for the chart under this key. |
|
|
| persistence.export | object | See [values.yaml](./values.yaml) | Configure export volume settings for the chart under this key. |
|
|
| persistence.media | object | See [values.yaml](./values.yaml) | Configure media volume settings for the chart under this key. |
|
|
| postgresql | object | See [values.yaml](./values.yaml) | Enable and configure postgresql database subchart under this key. If enabled, the app's db envs will be set for you. [[ref]](https://github.com/bitnami/charts/tree/main/bitnami/postgresql) |
|
|
| redis | object | See [values.yaml](./values.yaml) | Enable and configure redis subchart under this key. If enabled, the app's Redis env will be set for you. [[ref]](https://github.com/bitnami/charts/tree/main/bitnami/redis) |
|
|
| service.main | object | See [values.yaml](./values.yaml) | Configures service settings for the chart. |
|
|
|
|
---
|
|
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|