tractatus/deployment-quickstart/.env.example
TheFlow 2594c0d812 feat: deployment quickstart kit - 30-minute Docker deployment (Task 6)
Complete production-ready deployment package enabling implementers to deploy
Tractatus with all 5 governance services in 30 minutes using Docker Compose.

**Package Contents (15KB):**

1. docker-compose.yml
   - MongoDB 7.0 with authentication
   - Tractatus Node.js application
   - Health checks and volume management
   - Network configuration

2. Dockerfile
   - Multi-stage build (builder + production)
   - Security-hardened (non-root user, minimal image)
   - Health checks integrated
   - Production-optimized

3. .env.example
   - Complete configuration template
   - All 5 governance service toggles
   - Required secrets (MongoDB, JWT, Admin)
   - Feature flags and optional services
   - Rate limiting, CORS, CSP configuration

4. sample-governance-rules.json
   - 10 production-ready governance rules
   - STR-001: BoundaryEnforcer (human approval for values)
   - STR-002: CrossReferenceValidator (port specifications)
   - OPS-001: ContextPressureMonitor (pressure monitoring)
   - OPS-002: InstructionPersistenceClassifier (classification)
   - TAC-001: MetacognitiveVerifier (complex verification)
   - SYS-001/002: Database and project isolation
   - SEC-001: CSP enforcement
   - VAL-001: Te Tiriti commitment
   - QUAL-001: World-class quality

5. verify-deployment.sh
   - Automated verification (40+ checks)
   - 7 test categories: env, Docker, network, DB, services, security, files
   - Color-coded output (pass/fail/warn)
   - CI/CD integration ready

6. TROUBLESHOOTING.md
   - Comprehensive troubleshooting guide
   - 6 major sections covering common deployment issues
   - Docker, database, application, services, performance, security
   - Quick reference commands

7. README.md
   - "Deploy in 30 minutes" guide
   - 6-step quickstart (2+5+10+3+5+5 minutes)
   - Configuration guide (basic + production)
   - Testing procedures and monitoring
   - Architecture diagram
   - Backup/restore procedures

8. scripts/load-governance-rules.js
   - Loads sample rules into MongoDB
   - JSON validation and error handling
   - Creates indexes (rule_id, quadrant, enforced_by)
   - Summary statistics by quadrant and service

**Implementer Page Updates:**

- Added prominent "Deployment Quickstart Kit" section after hero
- Green gradient background with "NEW" badge
- Two-column layout: description + download / file list
- Download button: /downloads/tractatus-quickstart.tar.gz (15KB)
- Professional design matching site aesthetic

**Deliverables:**

 Production-ready Docker Compose configuration
 Complete environment configuration template
 10 sample governance rules (all 5 services)
 Automated deployment verification (40+ tests)
 Comprehensive troubleshooting guide
 Step-by-step deployment guide (30 minutes)
 Database initialization scripts
 Package deployed to production

**Testing:**

- Package structure validated
- File permissions correct (644/755)
- Deployed to https://agenticgovernance.digital/downloads/
- Implementer page updated with download section

**Roadmap Progress:**

Phase 1, Week 2, Task 6: Deployment Quickstart Kit - COMPLETED
Priority: High | Effort: 3-4 days | Status:  Done

Next: Task 8 - Technical Architecture Diagram (Week 3)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-12 07:27:37 +13:00

103 lines
4.4 KiB
Text

# Tractatus Framework - Environment Configuration Template
# Copy this file to .env and fill in your actual values
#=============================================================================
# REQUIRED: Database Configuration
#=============================================================================
MONGODB_USERNAME=tractatus
MONGODB_PASSWORD=YOUR_SECURE_PASSWORD_HERE # CHANGE THIS!
MONGODB_DATABASE=tractatus_prod
MONGODB_PORT=27017
MONGODB_URI=mongodb://tractatus:YOUR_SECURE_PASSWORD_HERE@mongodb:27017/tractatus_prod?authSource=admin
#=============================================================================
# REQUIRED: Application Configuration
#=============================================================================
NODE_ENV=production
APP_PORT=9000
BASE_URL=https://your-domain.com # Your production URL
# JWT Secret (generate with: openssl rand -base64 32)
JWT_SECRET=YOUR_JWT_SECRET_HERE # CHANGE THIS!
# Session Secret (generate with: openssl rand -base64 32)
SESSION_SECRET=YOUR_SESSION_SECRET_HERE # CHANGE THIS!
#=============================================================================
# REQUIRED: Admin Account
#=============================================================================
ADMIN_EMAIL=admin@your-domain.com
ADMIN_PASSWORD=YOUR_ADMIN_PASSWORD_HERE # CHANGE THIS!
#=============================================================================
# REQUIRED: Anthropic API (for AI-assisted features)
#=============================================================================
ANTHROPIC_API_KEY=sk-ant-your-api-key-here # Get from console.anthropic.com
#=============================================================================
# Governance Services (5 Core Components)
#=============================================================================
BOUNDARY_ENFORCER_ENABLED=true
CONTEXT_PRESSURE_ENABLED=true
CROSS_REF_VALIDATOR_ENABLED=true
PERSISTENCE_CLASSIFIER_ENABLED=true
METACOGNITIVE_VERIFIER_ENABLED=true
#=============================================================================
# Rate Limiting & Performance
#=============================================================================
RATE_LIMIT_WINDOW_MS=900000 # 15 minutes
RATE_LIMIT_MAX_REQUESTS=100 # Max requests per window
MAX_FILE_SIZE=10485760 # 10MB max upload size
#=============================================================================
# Feature Flags
#=============================================================================
BLOG_ENABLED=true
KOHA_ENABLED=true # Donation system
DEMOS_ENABLED=true # Interactive demos
ANALYTICS_ENABLED=false # Privacy-preserving analytics
#=============================================================================
# Optional: Email Configuration (for notifications)
#=============================================================================
# SMTP_HOST=smtp.example.com
# SMTP_PORT=587
# SMTP_USER=noreply@your-domain.com
# SMTP_PASSWORD=your-email-password
# SMTP_FROM_NAME=Tractatus Framework
# SMTP_FROM_EMAIL=noreply@your-domain.com
#=============================================================================
# Optional: Stripe (for Koha donations)
#=============================================================================
# STRIPE_SECRET_KEY=sk_live_your-stripe-key
# STRIPE_PUBLIC_KEY=pk_live_your-stripe-key
# STRIPE_WEBHOOK_SECRET=whsec_your-webhook-secret
#=============================================================================
# Optional: Analytics (Privacy-Preserving)
#=============================================================================
# PLAUSIBLE_DOMAIN=your-domain.com
# PLAUSIBLE_API_KEY=your-plausible-key
#=============================================================================
# Security Headers
#=============================================================================
HELMET_ENABLED=true
CSP_ENABLED=true
CORS_ORIGIN=https://your-domain.com # Comma-separated for multiple origins
#=============================================================================
# Logging
#=============================================================================
LOG_LEVEL=info # debug, info, warn, error
LOG_TO_FILE=true
LOG_TO_CONSOLE=true
#=============================================================================
# Development/Testing (disable in production)
#=============================================================================
# DEBUG=false
# VERBOSE_LOGGING=false
# ENABLE_DEBUGGING_ENDPOINTS=false