Skip to content

Commit

Permalink
[3proxy] Use helm-docs for README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Mario Trangoni <mjtrangoni@gmail.com>
  • Loading branch information
mjtrangoni committed Apr 2, 2024
1 parent f3d7da4 commit 43b0afb
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions charts/3proxy/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{{ template "chart.header" . }}

{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}

{{ template "chart.description" . }}

The unofficial Helm Chart for 3proxy. See more about 3proxy at <https://github.com/z3APA3A/3proxy>.

The goal of this project is to provide a Helm chart for running 3proxy in Kubernetes.

This chart creates a kubernetes *service* for the ports forwarded by [this 3proxy docker image](https://github.com/tarampampam/3proxy-docker).

## Get Repository Info

```console
helm repo add enthus-it https://enthus-it.github.io/helm-charts
helm repo update
```

See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation.

## Installing

```console
helm install --namespace=3proxy --values values.yaml 3proxy enthus-it/3proxy
```

## Uninstalling

```console
helm delete --namespace=3proxy 3proxy
# OR
helm delete MY-RELEASE
```

{{ template "chart.valuesSection" . }}

{{ template "helm-docs.versionFooter" . }}

0 comments on commit 43b0afb

Please sign in to comment.