User Guides
This directory contains user-facing documentation for the AI Security Gateway, organized by topic area.
Getting Started
Essential guides for new users:
- Admin Quick Start Guide - Get up and running in 5 minutes
- Installation Guide - Complete setup and deployment guide
- Configuration Reference - Environment variables and configuration options
Configuration
Guides for configuring the system:
- Authentication Guide - Authentication system overview
- OAuth Provider Setup Guide - Complete OAuth provider configuration guide
- OAuth Setup Guide - Configure OAuth providers
- OAuth Quick Reference - OAuth commands and workflows
- OAuth Encryption Setup - Encryption configuration
- Okta XAA Setup Guide - How to setup XAA per-proxy
- Session Management - Session security
- API Key Authentication - API key management
- Custom API Keys - Custom API key configuration
- Custom Policies Guide - Creating security policies
- System Prompts Guide - System prompt management and injection
- OAuth User Access Control Summary - Access control overview
Deployment
Production deployment guides:
- Docker Deployment - Docker and Docker Compose deployment
- Docker Commands - Docker command reference
- Web Server Deployment - Web server configuration
- Hybrid Deployment - Hybrid deployment patterns
Integration
Integration with external systems:
- Integration Guide - Langfuse, SIEM, SOAR, and Slack integration
- OAuth Proxy Chatbot Integration Guide - Generic guide for chatbots/applications integrating with OAuth-protected MCP servers
- OAuth Proxy Quick Reference - Quick reference for OAuth Proxy API endpoints and code snippets
- Cursor MCP OAuth Setup - Cursor IDE integration
- Claude Code Proxy Setup - Claude Code integration
Operations
Operational procedures and troubleshooting:
- Troubleshooting Guide - Common issues and solutions
- Security Runbook - Security operations procedures
- Security Audit Guide - Security audit procedures
- Threat Model - Security threat analysis
- Observability User Guide - Monitoring and observability
- Audit Logging - Audit logging system
- Alert Recording System - Alert system guide
API Usage
API documentation and examples:
- API Examples - Comprehensive API usage examples
- Unified Web API - Complete API reference
- Proxy API Reference - Proxy management API
- OAuth API Reference - OAuth API documentation
- A2A API Reference - A2A agent management API
- Playground Guide - Interactive API testing
A2A Agent Management
A2A (Agent-to-Agent) protocol management:
- Agent Registry Guide - Complete guide for managing A2A agents
OAuth Proxy
OAuth Proxy with Dynamic Client Registration:
- OAuth Proxy Chatbot Integration Guide - Complete guide for chatbot/application developers integrating with OAuth-protected MCP servers
- OAuth Proxy Quick Reference - Quick lookup guide for API endpoints and code snippets
- Cursor MCP OAuth Setup - Complete OAuth Proxy setup guide with automatic DCR