Documentation

Onboarding Guide

Welcome to AegisGate Security Platform. This guide walks you through getting up and running in 5 steps — no DevOps or Kubernetes expertise required.

Step 1: Deploy AegisGate

Option A: Guided Setup (recommended for new users)

# 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 detects Docker, Kubernetes, systemd, or bare metal; recommends a deploy profile; and generates a validated config file. No YAML editing required.

Option B: Deploy Profile

# List available profiles
./aegisgate-platform --profile list

# Run with the quickstart profile (zero-config evaluation)
./aegisgate-platform --profile quickstart --embedded-mcp

Option C: Docker

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

Step 2: Verify Installation

curl http://localhost:8443/health | jq .

Expected response:

{
  "status": "healthy",
  "tier": "community",
  "version": "4.2.0"
}

If you see "status": "unhealthy", check the Troubleshooting Guide.

Step 3: Point Your AI Traffic Through AegisGate

# Set OpenAI to use AegisGate proxy
export OPENAI_BASE_URL=http://localhost:8080/v1

Or configure your application to use AegisGate as a forward proxy. All traffic to your AI services will be scanned for threats, secrets, and PII.

Step 4: Test Detection

Send a test request to verify scanning is working:

curl -X POST http://localhost:8080/api/v1/scan \
  -H "Content-Type: application/json" \
  -d '{"content": "My credit card is 4532-1234-5678-9012 and my SSN is 123-45-6789"}'

You should see PII detection blocking or redacting the sensitive data.

Step 5: Configure for Your Needs

Configure Scanning Rules

scanning:
  secrets:
    - pattern: "sk-[a-zA-Z0-9]{48}"
      severity: critical
  pii:
    - type: ssn
      action: block
    - type: credit_card
      action: mask

Enable Compliance Frameworks (Developer+)

# Check which frameworks are available for your tier
curl http://localhost:8443/api/v1/compliance/status | jq .

Set Up SSO (Developer+)

  1. Navigate to Dashboard → Settings → SSO
  2. Select your identity provider (Okta, Azure AD, Google Workspace)
  3. Enter Client ID and Client Secret
  4. Configure user attribute mapping
  5. Test connection

Enable SIEM Integration (Professional+)

siem:
  enabled: true
  platform: splunk  # or elasticsearch, qrad, sentinel, etc.
  endpoint: "https://your-siem.example.com:8088"
  token: "your-hec-token"

Step 6: Validate Your Config

# Validate before going to production
./aegisgate-platform config validate aegisgate-platform.yaml
  1. ✅ Run a test scan to verify detection is working
  2. ✅ Review the Configuration Reference
  3. ✅ Set up Compliance Reports for your framework
  4. ✅ Configure team RBAC policies
  5. ✅ Set up monitoring and alerts
  6. ✅ Plan a maintenance window for your first patch

Next Steps