explorer-monorepo/deployment/README.md

Deployment Documentation

Complete deployment documentation for the ChainID 138 Explorer Platform.

Documentation Files

📘 DEPLOYMENT_GUIDE.md

Complete step-by-step guide with detailed instructions for:

• LXC container setup
• Application installation
• Database configuration
• Nginx reverse proxy setup
• Cloudflare DNS, SSL, and Tunnel configuration
• Security hardening
• Monitoring setup

Use this for: Full deployment walkthrough

📋 DEPLOYMENT_TASKS.md

Detailed task checklist with all 71 tasks organized by phase:

• Pre-deployment (5 tasks)
• Phase 1: LXC Setup (8 tasks)
• Phase 2: Application Installation (12 tasks)
• Phase 3: Database Setup (10 tasks)
• Phase 4: Infrastructure Services (6 tasks)
• Phase 5: Application Services (10 tasks)
• Phase 6: Nginx Reverse Proxy (9 tasks)
• Phase 7: Cloudflare Configuration (18 tasks)
• Phase 8: Security Hardening (12 tasks)
• Phase 9: Monitoring (8 tasks)
• Post-Deployment Verification (13 tasks)
• Optional Enhancements (8 tasks)

Use this for: Tracking deployment progress

✅ DEPLOYMENT_CHECKLIST.md

Interactive checklist for tracking deployment completion.

Use this for: Marking off completed items

⚡ QUICK_DEPLOY.md

Quick reference with essential commands and common issues.

Use this for: Quick command lookup during deployment

Configuration Files

nginx/explorer.conf

Complete Nginx configuration with:

• Rate limiting
• SSL/TLS settings
• Reverse proxy configuration
• Security headers
• Caching rules
• WebSocket support

cloudflare/tunnel-config.yml

Cloudflare Tunnel configuration template.

scripts/deploy-lxc.sh

Automated deployment script for initial setup.

Deployment Architecture

Internet
    ↓
Cloudflare (DNS, SSL, WAF, CDN)
    ↓
Cloudflare Tunnel (optional)
    ↓
LXC Container
    ├── Nginx (Reverse Proxy)
    │   ├── → Frontend (Port 3000)
    │   └── → API (Port 8080)
    ├── PostgreSQL + TimescaleDB
    ├── Elasticsearch
    ├── Redis
    └── Application Services
        ├── Indexer
        ├── API Server
        └── Frontend Server

Quick Start

1. Read the deployment guide: DEPLOYMENT_GUIDE.md
2. Use the task list: DEPLOYMENT_TASKS.md
3. Track progress: DEPLOYMENT_CHECKLIST.md
4. Quick reference: QUICK_DEPLOY.md

Prerequisites

• Proxmox VE with LXC support
• Cloudflare account with domain
• 16GB+ RAM, 4+ CPU cores, 100GB+ storage
• Ubuntu 22.04 LTS template
• SSH access to Proxmox host

Estimated Time

• First deployment: 6-8 hours
• Subsequent deployments: 2-3 hours
• Updates: 30-60 minutes

Support

For issues during deployment:

1. Check QUICK_DEPLOY.md for common issues
2. Review service logs: journalctl -u <service-name> -f
3. Check Nginx logs: tail -f /var/log/nginx/explorer-error.log
4. Verify Cloudflare tunnel: systemctl status cloudflared

Version

Version: 1.0.0
Last Updated: 2024-12-23