chore: Auto-update chart README [skip ci]

This commit is contained in:
k8s-at-home[bot] 2022-05-30 05:51:13 +00:00
parent 37c0bf2fba
commit 11bc80140e

View File

@ -1,16 +1,10 @@
# send
![Version: 1.1.2](https://img.shields.io/badge/Version-1.1.2-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: v3.4.20](https://img.shields.io/badge/AppVersion-v3.4.20-informational?style=flat-square)
Simple, private file sharing.
**Homepage:** <https://github.com/k8s-at-home/charts/tree/master/charts/stable/send>
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| geraldwuhoo | <gerald@geraldwu.com> | |
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
## Source Code
@ -20,13 +14,66 @@ Simple, private file sharing.
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | redis | 16.10.0 |
| https://library-charts.k8s-at-home.com | common | 4.4.2 |
## TL;DR
```console
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install send k8s-at-home/send
```
## Installing the Chart
To install the chart with the release name `send`
```console
helm install send k8s-at-home/send
```
## Uninstalling the Chart
To uninstall the `send` deployment
```console
helm uninstall send
```
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/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install send \
--set env.TZ="America/New York" \
k8s-at-home/send
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install send k8s-at-home/send -f values.yaml
```
## Custom configuration
N/A
## Values
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| env | object | See below | environment variables. See more environment variables in the [send documentation](https://send.org/docs). |
@ -40,5 +87,32 @@ Kubernetes: `>=1.16.0-0`
| redis.enabled | bool | `false` | |
| service | object | See values.yaml | Configures service settings for the chart. |
## Changelog
### Version 1.0.0
#### Added
* Initial version
#### Changed
N/A
#### Fixed
N/A
### Older versions
A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/send?modal=changelog)
## Support
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
- Join our [Discord](https://discord.gg/sTMX7Vh) community
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.10.0](https://github.com/norwoodj/helm-docs/releases/v1.10.0)
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)