Skip to content

Commit afc8b9a

Browse files
authored
Add Helm Chart deployment docs. (#5)
1 parent 8ecdb39 commit afc8b9a

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,35 @@ npm run test:coverage
175175
yarn test:coverage
176176
```
177177

178+
## Helm Chart Deployment
179+
180+
For Kubernetes production deployments, it is recommended to use the official [Subscan Essentials Helm Chart](https://github.com/subscan-explorer/subscan-essentials-chart).
181+
182+
### Quick Start
183+
184+
1. Add the Helm repository:
185+
186+
```bash
187+
helm repo add subscan https://subscan-explorer.github.io/subscan-essentials-chart/
188+
helm repo update
189+
```
190+
191+
2. Install (modify `values.yaml` as needed for your environment):
192+
193+
```bash
194+
helm install subscan-essentials subscan/subscan-essentials-chart -f example/subscan-essentials/values.yaml
195+
```
196+
197+
3. Upgrade:
198+
199+
```bash
200+
helm upgrade subscan-essentials subscan/subscan-essentials-chart -f example/subscan-essentials/values.yaml
201+
```
202+
203+
For advanced configuration and environment variable details, please refer to the [subscan-essentials-chart repository README](https://github.com/subscan-explorer/subscan-essentials-chart).
204+
205+
> This Helm Chart supports multi-network (mainnet/testnet), custom images, resource limits, Ingress (traefik/ingress-nginx), database and cache services, and other production-grade deployment requirements.
206+
178207
## Linting and Formatting
179208

180209
To check for linting and formatting errors:

0 commit comments

Comments
 (0)