Getting Started
Welcome to the AegisGate Security Platform documentation. Here you’ll find everything you need to deploy, configure, and use AegisGate Security Platform.
Quick Start
Docker (Recommended)
docker run -d \
-p 8080:8080 \
-p 8081:8081 \
-p 8443:8443 \
ghcr.io/aegisgatesecurity/aegisgate-platform:latest
Verify Installation
curl http://localhost:8443/health
Expected response:
{"status":"healthy","version":"2.0.1","services":{"proxy":"up","mcp":"up","scanner":"up"}}
Configuration
Environment Variables
| Variable | Description | Default |
|---|---|---|
AEGIS_LICENSE | License key | Community |
AEGIS_LOG_LEVEL | Log verbosity | info |
AEGIS_PROXY_PORT | HTTP proxy port | 8080 |
AEGIS_MCP_PORT | MCP server port | 8081 |
AEGIS_DASHBOARD_PORT | Dashboard port | 8443 |
AEGIS_RATE_LIMIT | Requests per minute | 1000 |
API Reference
Health Check
GET /health
Returns system status.
Proxy Endpoints
POST /v1/scan
Scans content for threats.
Next Steps
- Technical Details - Deep dive into architecture
- Blog - Security research and updates