Skip to content

Commit 945a7b6

Browse files
committed
[getting-started] add Helm deployment example
1 parent 502b908 commit 945a7b6

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/getting-started/private-server.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,48 @@ To run the server, you'll need:
8989
./sms-gateway
9090
```
9191

92+
=== "📦 With Helm"
93+
1. **Install Helm**
94+
2. **Add the chart repository**
95+
```sh
96+
helm repo add sms-gate https://s3.sms-gate.app/charts
97+
helm repo update
98+
```
99+
3. **Create values.yaml file**
100+
```yaml title="values.yaml"
101+
image:
102+
pullPolicy: IfNotPresent
103+
104+
database:
105+
deployInternal: true
106+
mariadb:
107+
rootPassword: ${GENERATE_MARIADB_ROOT_PASSWORD}
108+
password: ${GENERATE_DATABASE_PASSWORD}
109+
110+
gateway:
111+
privateToken: ${GENERATE_PRIVATE_TOKEN}
112+
```
113+
114+
4. **Install the chart**
115+
```sh
116+
helm upgrade --install sms-gate-server sms-gate/server \
117+
--create-namespace \
118+
--namespace sms-gate \
119+
--values values.yaml
120+
```
121+
122+
!!! danger "Security Warning"
123+
**Never commit secrets to version control!** Replace placeholder values with actual high-entropy secrets:
124+
125+
- Generate unique passwords/tokens using: `openssl rand -base64 32`
126+
- Use environment variables or secret management tools
127+
- Consider [sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) for Kubernetes
128+
- Use cloud secret managers (AWS Secrets Manager, Azure Key Vault, GCP Secret Manager)
129+
130+
For detailed Helm chart documentation, see [Helm Chart Documentation](https://github.com/android-sms-gateway/server/blob/master/deployments/helm-chart/README.md).
131+
132+
133+
92134
3. **Configure reverse proxy**
93135
```nginx title="Example Nginx Config"
94136
location / {

0 commit comments

Comments
 (0)