mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
5c4363cbea
- Add the chart from k8s-at-home with some modifications - Add the Apache 2.0 license to the new charts/paperless-ngx subdirectory, the license under which the chart was distributed by k8s-at-home. I believe the chart will have to maintain this license. - Update the maintainers section and contact information to point to Paperless-ngx. - Regenerate the README (using helm-docs) - Add a GitHub actions configuration to publish the chart using GitHub pages. This makes the GitHub Pages page rendered by this repository usable as a Helm repository, without affecting potential future uses of the Pages site. These are in response to discussion #1790.
51 lines
2.6 KiB
Markdown
51 lines
2.6 KiB
Markdown
# paperless
|
|
|
|
 
|
|
|
|
Paperless-ngx - Index and archive all of your scanned paper documents
|
|
|
|
**Homepage:** <https://github.com/paperless-ngx/paperless-ngx/tree/main/charts/paperless-ngx>
|
|
|
|
## Maintainers
|
|
|
|
| Name | Email | Url |
|
|
| ---- | ------ | --- |
|
|
| Paperless-ngx maintainers | | |
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/paperless-ngx/paperless-ngx>
|
|
|
|
## Requirements
|
|
|
|
Kubernetes: `>=1.16.0-0`
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://charts.bitnami.com/bitnami | postgresql | 11.6.12 |
|
|
| https://charts.bitnami.com/bitnami | redis | 16.13.1 |
|
|
| https://library-charts.k8s-at-home.com | common | 4.5.2 |
|
|
|
|
## Values
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| env | object | See below | See the following files for additional environment variables: https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose/ https://github.com/paperless-ngx/paperless-ngx/blob/main/paperless.conf.example |
|
|
| env.COMPOSE_PROJECT_NAME | string | `"paperless"` | Project name |
|
|
| env.PAPERLESS_DBHOST | string | `nil` | Database host to use |
|
|
| env.PAPERLESS_OCR_LANGUAGE | string | `"eng"` | OCR languages to install |
|
|
| env.PAPERLESS_PORT | int | `8000` | Port to use |
|
|
| env.PAPERLESS_REDIS | string | `nil` | Redis to use |
|
|
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
|
|
| image.repository | string | `"ghcr.io/paperless-ngx/paperless-ngx"` | image repository |
|
|
| image.tag | string | chart.appVersion | image tag |
|
|
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
|
|
| persistence.consume | object | See values.yaml | Configure volume to monitor for new documents. |
|
|
| persistence.data | object | See values.yaml | Configure persistence for data. |
|
|
| persistence.export | object | See values.yaml | Configure export volume. |
|
|
| persistence.media | object | See values.yaml | Configure persistence for media. |
|
|
| postgresql | object | See values.yaml | Enable and configure postgresql database subchart under this key. For more options see [postgresql chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) |
|
|
| redis | object | See values.yaml | Enable and configure redis subchart under this key. For more options see [redis chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/redis) |
|
|
| service | object | See values.yaml | Configures service settings for the chart. |
|
|
|