-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[3proxy] Use helm-docs for README.md
Signed-off-by: Mario Trangoni <mjtrangoni@gmail.com>
- Loading branch information
1 parent
f3d7da4
commit 43b0afb
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" . }} |