From 58ee2df1a3b37374118ef568b6de2ee3c4f9639b Mon Sep 17 00:00:00 2001
From: naison <895703375@qq.com>
Date: Fri, 11 Apr 2025 22:06:00 +0800
Subject: [PATCH] docs: add readme.md for helm charts (#534)

---
 charts/kubevpn/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 charts/kubevpn/README.md

diff --git a/charts/kubevpn/README.md b/charts/kubevpn/README.md
new file mode 100644
index 00000000..4045101b
--- /dev/null
+++ b/charts/kubevpn/README.md
@@ -0,0 +1,24 @@
+# Helm charts for KubeVPN server
+
+Use helm to install kubevpn server means use cluster mode. All user will use this instance.
+
+- Please make sure users should have permission to namespace `kubevpn`.
+- Otherwise, will fall back to create `kubevpn` deployment in own namespace.
+
+## Install with default mode
+
+```shell
+helm install kubevpn kubevpn/kubevpn -n kubevpn --create-namespace
+```
+
+in China, you can use tencent image registry
+
+```shell
+helm install kubevpn kubevpn/kubevpn --set image.repository=ccr.ccs.tencentyun.com/kubevpn/kubevpn -n kubevpn --create-namespace
+```
+
+## AWS Fargate cluster
+
+```shell
+helm install kubevpn kubevpn/kubevpn --set netstack=gvisor -n kubevpn --create-namespace
+```
\ No newline at end of file