Skip to content

Commit 6f99f2e

Browse files
authored
Merge pull request #9 from Premian-Labs/dk/update-readme
feat: Add automated deployment and update docs
2 parents b0e4e27 + 7ef3d52 commit 6f99f2e

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

CLAUDE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,29 @@
88
- View logs: `docker-compose logs -f`
99
- Stop services: `docker-compose down`
1010

11+
## Automated Deployment
12+
- GitHub Actions automatically deploy to Railway on pushes to:
13+
- `dev` branch: Deploys to development environment
14+
- `main` branch: Deploys to production environment
15+
- Both the eRPC server and monitoring stack are deployed separately using distinct Railway service IDs
16+
1117
## Environment Variables
1218
- Required: `REDIS_ADDR`, `REDIS_PASSWORD`, `RPC_API_SECRET`
1319
- Optional: Various API keys for RPC providers (ALCHEMY_API_KEY, INFURA_API_KEY, etc.)
20+
- GitHub Actions secrets needed:
21+
- `RAILWAY_TOKEN`: Authentication token for Railway
22+
- `SVC_ID_ERPC`: Railway service ID for eRPC server
23+
- `SVC_ID_MONITOR`: Railway service ID for monitoring stack
1424

1525
## Container Structure
1626
- eRPC server: Handles RPC requests, runs on port 4000
1727
- Healthcheck: JSON-RPC `net_version` request to port 4000
28+
- Uses `Dockerfile.erpc` and `railway.erpc.json` for configuration
1829
- Metrics endpoint: Port 4001
1930
- Monitoring stack:
2031
- Grafana (port 3000) with healthcheck at /api/health
2132
- Prometheus (port 9090)
33+
- Uses `Dockerfile.monitoring` and `railway.monitor.json` for configuration
2234

2335
## Code Style Guidelines
2436
- Configuration files use YAML format

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,15 @@
88

99
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/10iW1q)
1010

11-
# License
11+
## Deployment
12+
13+
This repository is configured with GitHub Actions workflows that automatically deploy:
14+
- The eRPC server and monitoring stack to the development environment when code is pushed to the `dev` branch
15+
- The eRPC server and monitoring stack to the production environment when code is pushed to the `main` branch
16+
17+
The deployment uses Railway's service IDs to deploy the eRPC server and monitoring stack separately.
18+
19+
## License
1220

1321
Apache 2.0
1422

0 commit comments

Comments
 (0)