Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

Vigil Guard Documentation

Version: 2.1.0 | Last Updated: 2025-12-12

Quick Navigation

I want to... Go to
Get started quickly Quickstart
Understand the architecture Architecture
Configure detection rules Configuration Guide
Monitor threats Dashboard Guide
Investigate prompts Investigation Guide
Troubleshoot issues Troubleshooting
Use the API API Reference

Documentation Structure

docs/
├── README.md                 # This file (hub)
├── ARCHITECTURE.md           # 3-branch system design
├── SECURITY.md               # Security policies
├── TROUBLESHOOTING.md        # Common issues
│
├── overview/
│   └── QUICKSTART.md         # 5-minute setup
│
├── guides/                   # User guides
│   ├── README.md            # Guide navigation
│   ├── dashboard.md         # Monitoring
│   ├── investigation.md     # Prompt analysis
│   ├── configuration.md     # Settings
│   ├── administration.md    # User management
│   └── settings.md          # Preferences
│
├── services/
│   └── README.md            # All microservices
│
├── config/
│   ├── unified-config.md    # Main configuration
│   ├── heuristics.md        # Branch A settings
│   └── env.md               # Environment variables
│
├── operations/
│   ├── installation.md      # Full install guide
│   ├── docker.md            # Container management
│   └── troubleshooting.md   # Quick fixes
│
├── api/
│   ├── web-api.md           # REST API reference
│   ├── events_v2.md         # ClickHouse schema
│   └── plugin.md            # Browser extension API
│
├── plugin/
│   ├── BROWSER_EXTENSION.md # Chrome extension docs
│   └── QUICK_START.md       # Extension setup
│
└── specialized/
    ├── GRAFANA_SETUP.md     # Dashboard setup
    ├── CLICKHOUSE_RETENTION.md # Data lifecycle
    └── WEBHOOK_SECURITY.md  # Webhook auth

Key Endpoints

Service URL Purpose
Web UI http://localhost/ui Configuration interface
n8n Webhook POST /webhook/vigil-guard-2 Detection endpoint
Grafana http://localhost:3001 Dashboards
ClickHouse http://localhost:8123 Analytics

Internal Services:

Service Endpoint Timeout
Heuristics (A) http://heuristics-service:5005/analyze 1s
Semantic (B) http://semantic-service:5006/analyze 2s
LLM Safety Engine (C) http://prompt-guard-api:8000/detect 3s
PII http://vigil-presidio-pii:5001/analyze 5s

Pipeline Overview

Input → Validation → 3-Branch Executor → Arbiter → Decision
                           ↓                ↓
                     [A] [B] [C]      ALLOW/BLOCK
                                           ↓
                                     PII Redaction
                                           ↓
                                     ClickHouse Log
                                           ↓
                                        Output

Arbiter: Weights A=0.30, B=0.40, C=0.30 | Block threshold: 50

Version History

Version Date Highlights
2.1.0 2025-12 Solo-PG exception, optimized arbiter weights (S:40%, PG:30%)
2.0.0 2025-11 3-branch architecture, Arbiter v2
1.8.1 2025-11 Hybrid language detection
1.7.0 2025-11 Sanitization integrity
1.6.0 2025-01 Presidio integration

Full changelog: CHANGELOG.md

Contributing

See CONTRIBUTING.md for guidelines.

Quick commands:

# Run tests
cd services/workflow && npm test

# Development
cd services/web-ui/frontend && npm run dev

Need help? See Troubleshooting or file an issue.