FlexGate Documentation
Welcome to the FlexGate Proxy documentation. This directory contains comprehensive technical documentation organized by topic.
📚 Documentation Structure
Core Documentation (Root Level)
- README.md - Project overview and getting started
- QUICKSTART.md - Quick start guide
- CHANGELOG.md - Version history and changes
- CONTRIBUTING.md - Contribution guidelines
- SECURITY.md - Security policies and reporting
- ROADMAP.md - Future development plans
- TODO.md - Active tasks and pending work
Technical Documentation
🏗️ Architecture
- System architecture and design decisions
- Monorepo vs microservices analysis
- Repository split strategy
- Hybrid deployment approach
🚀 Deployment
- Deployment strategies and guides
- Docker and non-Docker deployment
- Open source deployment
- Multi-repository setup
💻 Development
- Development guides and protocols
- Database setup and implementation
- API development guidelines
🔌 Integration
- Third-party integrations
- Einstrust SSO integration
- Authentication workflows
✨ Features
- 01-admin-ui.md - Admin UI documentation
- 02-route-management.md - Route management
- 07-webhooks.md - Webhooks system
- Feature specifications and implementation guides
📋 Planning
- Development roadmap
- Feature planning
- Launch plans and checklists
🧪 Testing
- e2e-guide.md - End-to-end testing guide
- Test automation setup
- Testing execution plans
API Documentation
- api.md - API overview
- observability.md - Metrics and monitoring
- traffic-control.md - Rate limiting and circuit breakers
Technical References
- problem.md - Problem statement
- threat-model.md - Security threat model
- trade-offs.md - Design trade-offs
- typescript-migration.md - TypeScript migration
🔍 Quick Links
Getting Started
For Developers
For Deployers
For Integrators
📝 Product Documentation
- PRODUCT.md - Product description and features
- PROJECT_SUMMARY.md - Project overview
- PRODUCT_HOMEPAGE.md - Marketing homepage content
🤝 Contributing
See CONTRIBUTING.md for guidelines on contributing to FlexGate.