TeamPiped-mirror/Piped-Kubernetes
1
0
Fork 0
mirror of https://github.com/TeamPiped/Piped-Kubernetes.git synced 2024-08-14 23:57:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix chart README generation.

Browse source
This commit is contained in:
Skyler Mäntysaari 2024-01-24 13:29:44 +02:00
parent e84aa7b6f4
commit 60153fd456
3 changed files with 37 additions and 204 deletions
Download patch file Download diff file Expand all files Collapse all files

87
charts/apps/piped/README.md
View file

@ -1,11 +1,9 @@
# piped
![Version: 4.1.0](https://img.shields.io/badge/Version-4.1.0-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
![Version: 5.0.0](https://img.shields.io/badge/Version-5.0.0-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
Piped is an alternative privacy-friendly YouTube frontend which is efficient by design.
NOTICE: There is currently NO caching support included in the chart.
## Source Code
* <https://github.com/TeamPiped/Piped>
@ -21,58 +19,27 @@ Kubernetes: `>=1.22.0-0`
| Repository | Name | Version |
|------------|------|---------|
| https://bjw-s.github.io/helm-charts | common | 1.5.1 |
| https://charts.bitnami.com/bitnami | postgresql | 13.2.0 |
## TL;DR
```console
helm repo add TeamPiped https://helm.piped.video
helm repo update
helm install piped TeamPiped/piped
```
| https://charts.bitnami.com/bitnami | postgresql | 13.2.27 |
## Installing the Chart
To install the chart with the release name `piped`
```bash
# Add the repository
helm repo add TeamPiped https://helm.piped.video
```console
helm install piped TeamPiped/piped
# Update your local Helm chart repository cache
helm repo update
# Install the chart
helm install TeamPiped piped -f values.yaml
```
## Uninstalling the Chart
To uninstall the `piped` deployment
```console
helm uninstall piped
```
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/blob/main/charts/library/common/values.yaml) from the [common library](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common).
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install piped \
--set env.TZ="America/New York" \
TeamPiped/piped
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install piped TeamPiped/piped -f values.yaml
```
## Custom configuration
## Values
**Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common)
The following table contains an overview of available values and their descriptions / default values.
<details>
<summary>Expand</summary>
| Key | Type | Default | Description |
|-----|------|---------|-------------|
@ -92,7 +59,7 @@ helm install piped TeamPiped/piped -f values.yaml
| controller.enabled | bool | `false` | enable the controller. |
| frontend.args[0] | string | `"-c"` | |
| frontend.args[1] | string | `"sed -i s/pipedapi.kavin.rocks/$BACKEND_HOSTNAME/g /usr/share/nginx/html/assets/* && /docker-entrypoint.sh nginx -g 'daemon off;'"` | |
| frontend.command | string | `"/bin/ash"` | BACKEND_HOSTNAME: pipedapi.example.org |
| frontend.command | string | `"/bin/ash"` | |
| frontend.enabled | bool | `true` | |
| frontend.image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| frontend.image.repository | string | `"1337kavin/piped-frontend"` | image repository |
@ -130,7 +97,7 @@ helm install piped TeamPiped/piped -f values.yaml
| postgresql.auth.username | string | `"piped"` | |
| postgresql.enabled | bool | `true` | |
| postgresql.image.tag | string | `"13.12.0-debian-11-r58"` | |
| probes | object | See below | Probe configuration -- [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| probes | object | See below | [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
| probes.liveness | object | See below | Liveness probe configuration |
| probes.liveness.custom | bool | `false` | Set this to `true` if you wish to specify your own livenessProbe |
| probes.liveness.enabled | bool | `true` | Enable the liveness probe |
@ -158,25 +125,7 @@ helm install piped TeamPiped/piped -f values.yaml
| ytproxy.service.main.primary | bool | `true` | |
| ytproxy.service.main.type | string | `"ClusterIP"` | |
## Changelog
### Version 4.1.0
#### Added
N/A
#### Changed
* Upgraded `postgresql` chart dependency to version 13.2.0
#### Fixed
N/A
## Support
- Open an [issue](https://github.com/TeamPiped/Piped-Kubernetes/issues/new/choose)
</details>
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)