- Migrate from custom HTTP server to VitePress framework - Rename project to Tokenized License Approval System (TLAS) - Add comprehensive documentation for all stakeholders: - Business: Executive summary, value proposition, governance - Operations: Infrastructure, installation, monitoring, backup - Departments: User guide, workflows, verification, issuance - Developers: API reference, authentication, webhooks, SDKs - Compliance: OWASP, DPDP Act, IT Act, audit framework - Add modern theme with dark mode and full-text search - Update Dockerfile for VitePress build process Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
86 lines
3.5 KiB
Markdown
86 lines
3.5 KiB
Markdown
# Operations Guide
|
|
|
|
## Deployment Architecture
|
|
|
|
```
|
|
┌─────────────────────┐
|
|
│ Load Balancer │
|
|
│ (Nginx/HAProxy) │
|
|
└──────────┬──────────┘
|
|
│
|
|
┌────────────────┼────────────────┐
|
|
│ │ │
|
|
┌────────▼────────┐ │ ┌────────▼────────┐
|
|
│ Frontend │ │ │ Frontend │
|
|
│ Container │ │ │ Container │
|
|
│ (Node 1) │ │ │ (Node 2) │
|
|
└─────────────────┘ │ └─────────────────┘
|
|
│
|
|
┌─────────▼─────────┐
|
|
│ API Gateway │
|
|
│ (NestJS) │
|
|
└─────────┬─────────┘
|
|
│
|
|
┌────────────────────┼────────────────────┐
|
|
│ │ │
|
|
┌────────▼────────┐ ┌────────▼────────┐ ┌────────▼────────┐
|
|
│ PostgreSQL │ │ Redis │ │ Besu Node │
|
|
│ (Primary) │ │ (Cache) │ │ (Blockchain) │
|
|
└────────┬────────┘ └─────────────────┘ └─────────────────┘
|
|
│
|
|
┌────────▼────────┐
|
|
│ PostgreSQL │
|
|
│ (Replica) │
|
|
└─────────────────┘
|
|
```
|
|
|
|
## System Requirements
|
|
|
|
### Minimum Production Configuration
|
|
|
|
| Component | Specification |
|
|
|-----------|---------------|
|
|
| Application Server | 4 vCPU, 8GB RAM, 100GB SSD |
|
|
| Database Server | 4 vCPU, 16GB RAM, 500GB SSD |
|
|
| Blockchain Node | 4 vCPU, 8GB RAM, 200GB SSD |
|
|
| Load Balancer | 2 vCPU, 4GB RAM |
|
|
|
|
### Network Requirements
|
|
|
|
| Port | Service | Access |
|
|
|------|---------|--------|
|
|
| 443 | HTTPS | Public |
|
|
| 80 | HTTP (redirect) | Public |
|
|
| 5432 | PostgreSQL | Internal |
|
|
| 6379 | Redis | Internal |
|
|
| 8545 | Besu RPC | Internal |
|
|
| 30303 | Besu P2P | Internal |
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Clone repository
|
|
git clone https://github.com/goa-gel/tlas.git
|
|
cd tlas
|
|
|
|
# Configure environment
|
|
cp .env.example .env
|
|
# Edit .env with your settings
|
|
|
|
# Start all services
|
|
docker-compose up -d
|
|
|
|
# Verify deployment
|
|
docker-compose ps
|
|
curl https://localhost/api/health
|
|
```
|
|
|
|
## Documentation Index
|
|
|
|
- [Infrastructure Requirements](/operations/infrastructure) - Detailed hardware and network specifications
|
|
- [Installation Guide](/operations/installation) - Step-by-step deployment instructions
|
|
- [Configuration](/operations/configuration) - Environment variables and settings
|
|
- [Monitoring](/operations/monitoring) - Health checks, alerts, and dashboards
|
|
- [Backup & Recovery](/operations/backup) - Data protection procedures
|
|
- [Security Hardening](/operations/security) - Production security checklist
|