Appearance
Getting Started with GhostAI
Welcome to GhostAI! This guide will help you get up and running with secure AI-powered conversations that automatically protect sensitive data.
What is GhostAI?
GhostAI is a secure LLM proxy that sits between your users and AI models (OpenAI, Anthropic, etc.), automatically detecting and protecting sensitive information before it leaves your environment.
How It Works
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ User │────▶│ GhostAI │────▶│ LLM API │────▶│ Response │
│ Input │ │ Detection │ │ (OpenAI) │ │ with PII │
│ with PII │ │ & Tokenize │ │ │ │ Restored │
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
│
▼
┌─────────────┐
│ Audit Log │
│ (Compliance)│
└─────────────┘Key Benefits
- Data Protection: Sensitive data never leaves your environment
- Compliance Ready: Built-in support for HIPAA, PCI-DSS, GDPR, and 50+ regulations
- Reversible: AI responses use original values through session-scoped tokenization
- Audit Trail: Complete logging for compliance verification
- File Intelligence: Upload files up to 150 MB and ask questions about any part — hybrid search, cross-file retrieval, GPU-accelerated indexing, and PII protection on every retrieved chunk
Choose Your Path
Quick Start (5 minutes)
Get GhostAI running locally in 5 minutes. Start Quick Setup →
Full Installation
Complete installation with all dependencies and configurations. Full Installation Guide →
First Protected Chat
Learn how PII detection works with a hands-on tutorial. Try Your First Chat →
System Requirements
Minimum Requirements
| Component | Requirement |
|---|---|
| Python | 3.11 or higher |
| Node.js | 18.0 or higher |
| Memory | 4GB RAM minimum |
| Disk | 2GB free space |
Supported Platforms
- macOS: 12.0 (Monterey) or later
- Linux: Ubuntu 20.04+, Debian 11+, CentOS 8+
- Windows: Windows 10/11 with WSL2
- Docker: Any platform with Docker 20.10+
API Keys Required
You'll need at least one LLM provider API key:
- OpenAI: Get API Key
- OpenRouter: Get API Key (100+ models)
- Ollama: Install Locally (no API key needed)
Next Steps
- Quick Start - Get running in 5 minutes
- Model Comparison - Compare models side-by-side with Consensus, Mega Synthesis, and Combined Answer
- Configure Your Vertical - Set up industry-specific detection
- Explore Features - Learn about all capabilities
- File Intelligence - Hybrid search, cross-file retrieval, GPU embedding
- API Integration - Build custom integrations