Documentation

Documentation

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

Guided Setup (30-Second Setup)

# Build the binary
go build -o aegisgate-platform ./cmd/aegisgate-platform/

# Auto-detect your environment and generate a validated config
./aegisgate-platform setup --non-interactive

# Start the platform
./aegisgate-platform --config aegisgate-platform.yaml --embedded-mcp

The setup wizard auto-detects Docker, Kubernetes, systemd, or bare metal; recommends a deploy profile; generates a validated config; and prints next steps. No YAML editing required.

docker run -d \
  -p 8080:8080 \
  -p 8081:8081 \
  -p 8443:8443 \
  -p 9000:9000 \
  ghcr.io/aegisgatesecurity/aegisgate-platform:v4.4.0

Verify Installation

curl http://localhost:8443/health

Expected response:

{"status":"healthy","version":"4.4.0","services":{"proxy":"up","mcp":"up","scanner":"up","a2a":"up","trust":"up"}}

Configuration

Deploy Profiles

Instead of editing YAML from scratch, use one of 5 predefined profiles:

ProfileUse CaseTLSRate Limit
quickstartZero-config evaluationOff60 RPM
small-team5–50 usersAuto-gen300 RPM
productionHardened productionTLS 1.3 (bring certs)1,000 RPM
high-securityRegulated industriesmTLS + FIPS5,000 RPM
air-gappedIsolated networksTLS 1.3 (bring certs)1,000 RPM
# List all profiles
./aegisgate-platform --profile list

# Run with a profile
./aegisgate-platform --profile small-team --embedded-mcp

# Generate a config from a profile for customization
./aegisgate-platform setup --profile production --output my-config.yaml

Config Validation

# Validate before deploying
./aegisgate-platform config validate aegisgate-platform.yaml

# Show effective config (what the running platform would use)
./aegisgate-platform config show --format json

Maintenance Windows

# Enable maintenance mode (returns 503 with Retry-After)
./aegisgate-platform maintenance enable --message "Security update in progress"

# Schedule a future window
./aegisgate-platform maintenance schedule --start "2026-09-01T02:00:00Z" --end "2026-09-01T04:00:00Z" --reason "Quarterly patch"

# Disable
./aegisgate-platform maintenance disable

Environment Variables

VariableDescriptionDefault
AEGIS_LICENSELicense keyCommunity
AEGIS_LOG_LEVELLog verbosityinfo
AEGIS_PROXY_PORTHTTP proxy port8080
AEGIS_MCP_PORTMCP server port8081
AEGIS_DASHBOARD_PORTDashboard port8443
AEGIS_RATE_LIMITRequests per minute1000

Tip: Use ./aegisgate-platform config show to see the full effective configuration including defaults, profile values, file overrides, and environment variable overrides. Config precedence: CLI flags > env vars > config file > profile > defaults.

API Reference

Health Check

GET /health

Returns system status including all subsystem health (proxy, MCP, scanner, A2A, trust, persistence, license, certificates, SIEM).

Proxy Endpoints

POST /api/v1/scan

Scans content for threats. Returns detection results with MITRE ATLAS mapping, PII findings, and compliance cross-references.

Maintenance API

GET  /api/v1/maintenance    # Get maintenance state
POST /api/v1/maintenance     # Enable/disable/schedule

Next Steps