Management Overview¶
This section provides operational guidance for running and maintaining a production instance of ContextForge.
Whether you're self-hosting, running in the cloud, or deploying to Kubernetes, this section helps you monitor, back up, and maintain the system.
What's new in 1.0.0-RC-3
Multi‑tenancy (email auth, teams, RBAC, resource visibility) was introduced in v0.9.0 and is fully supported in 1.0.0-RC-3.
- See the Changelog
- Quick enablement (excerpt):
EMAIL_AUTH_ENABLED=true,PLATFORM_ADMIN_EMAIL=...,AUTO_CREATE_PERSONAL_TEAMS=true - Learn more: Team Management, RBAC
🧭 What's Covered¶
| Page | Description |
|---|---|
| Configuration | Core gateway configuration reference - databases, environment variables, and deployment settings |
| Plugin Configuration | Plugin-framework configuration reference - PLUGINS_* settings, runtime transports, TLS, and aliases |
| Password Management | Password reset, account unlock, API recovery, and emergency lockout procedures |
| Scaling Guide | 📈 Production Scaling - Horizontal/vertical scaling, Kubernetes HPA, connection pooling, and performance tuning |
| Performance Tuning | Optimize Gunicorn workers, database connections, and container resources |
| Dynamic Client Registration | 🔐 OAuth2 DCR - Automatic client provisioning for streamable HTTP servers |
| Backups | How to persist and restore your database, configs, and resource state |
| Export & Import | Complete configuration management with CLI, API, and Admin UI |
| Export/Import Tutorial | Step-by-step tutorial for getting started with export/import |
| Export/Import Reference | Quick reference guide for export/import commands and APIs |
| Bulk Import | Import multiple tools at once for migrations and team onboarding |
| Metadata Tracking | 📊 NEW - Comprehensive audit trails and entity metadata tracking |
| Well-Known URIs | Configure robots.txt, security.txt, and custom well-known files |
| Logging | Configure structured logging, log destinations, and log rotation |
🔐 Runtime Config via .env¶
Most operational settings (logging level, database pool size, auth mode) are controlled through .env or environment variables.
Update the file and restart the container or process to apply changes.
🧪 Health & Readiness¶
Expose the /health endpoint for use with:
- Cloud load balancer health checks
- Kubernetes probes
- CI/CD smoke tests
Sample check:
Expected response:
🔁 Service Restart Commands¶
Depending on your environment:
docker restart mcpgatewaykubectl rollout restart deployment/mcpgateway