Apparatus Documentation Navigator

Welcome! This guide helps you find the right documentation for your needs.

---

📍 Quick Navigation

Getting Started

• Quick Reference — Common commands, services, and troubleshooting
• Integration Guide — How Apparatus + Chimera work together

Learning & Tutorials

• Tutorial: CLI Reference — Command-line tool and scripting
• Tutorial: Dashboard — Web UI features and monitoring
• Tutorial: Webhooks — Webhook integration and testing
• Tutorial: Chaos Engineering — Chaos features explained
• Tutorial: Defense Rules — WAF and defense configuration
• Tutorial: Autopilot — Red team autonomous agent
• Tutorial: Monitoring — Metrics, dashboards, and observability
• Tutorial: Scenarios — Multi-step testing scenarios
• Tutorial: Live Payload Fuzzer — Interactive API & payload testing
• Tutorial: Testing Lab — Unified security testing (k6, Nuclei, Escape Artist)
• Tutorial: Attacker Fingerprinting — Real-time threat monitoring & response
• Tutorial: Overview Dashboard — Real-time metrics and incident monitoring
• Tutorial: Scenario Builder — Multi-step automated testing sequences
• Tutorial: Chaos Console — Safe fault injection and resilience testing
• Tutorial: Advanced Red Team — Multi-target campaigns and complex strategies
• Tutorial: Performance Tuning — Optimizing for scale and load

Reference & Architecture

• Architecture Guide — System design, component details, performance
• Visual Diagrams — Mermaid flowcharts and network diagrams
• Complete Features — All 58+ features catalog
• API Reference — Detailed endpoint documentation

---

🎯 Find Documentation by Task

I want to…

Start Testing

→ Quick Reference → Common Testing Scenarios section

Understand System Architecture

→ Architecture Guide + Visual Diagrams

Run Tests via Command Line

→ Tutorial: CLI Reference

Monitor in Real-Time

→ Tutorial: Dashboard or Tutorial: Monitoring

Create Automated Test Sequences

→ Tutorial: Scenarios

Use AI Red Team

→ Tutorial: Autopilot

Test with Chaos Attacks

→ Tutorial: Chaos Engineering

Set Up Security Rules

→ Tutorial: Defense Rules

Integrate Webhooks

→ Tutorial: Webhooks

Test APIs and Payloads Manually

→ Tutorial: Live Payload Fuzzer

Run Security Tests (Load, Vulnerabilities, Egress)

→ Tutorial: Testing Lab

Monitor and Respond to Attacks

→ Tutorial: Attacker Fingerprinting

View System Health and Incidents

→ Tutorial: Overview Dashboard

Build and Run Multi-Step Tests

→ Tutorial: Scenario Builder

Test Resilience with Chaos

→ Tutorial: Chaos Console

Plan Advanced Attack Campaigns

→ Tutorial: Advanced Red Team

Optimize for Performance & Load

→ Tutorial: Performance Tuning

Troubleshoot Issues

→ Quick Reference → Troubleshooting section

Find an Endpoint

→ API Reference or Complete Features

---

📚 Documentation Structure

docs/
├── NAVIGATOR.md (this file)
├── quick-reference.md ..................... Start here! Commands & scenarios
├── integration-guide.md ................... Apparatus + Chimera integration
├── architecture.md ........................ System design & technical details
├── diagrams.md ............................ Visual flowcharts & network topology
├── features.md ............................ Feature inventory (58+)
├── api.md ................................ API endpoint reference
│
├── tutorial-cli.md ........................ Command-line tool & scripting
├── tutorial-dashboard.md .................. Web UI & real-time monitoring
├── tutorial-webhooks.md ................... Webhook integration
├── tutorial-chaos-engineering.md .......... Chaos features
├── tutorial-defense-rules.md .............. Defense mechanisms & WAF
├── tutorial-autopilot.md .................. AI red team automation
├── tutorial-monitoring.md ................. Metrics & observability
├── tutorial-scenarios.md .................. Multi-step scenarios
├── tutorial-live-payload-fuzzer.md ........ Interactive API & payload testing
├── tutorial-testing-lab.md ................ Unified security testing hub
├── tutorial-attacker-fingerprinting.md .... Real-time threat monitoring
├── tutorial-overview-dashboard.md ......... System health & incident monitoring
├── tutorial-scenario-builder.md ........... Multi-step automation sequences
├── tutorial-chaos-console.md .............. Fault injection & resilience testing
├── tutorial-advanced-red-team.md .......... Multi-target campaigns & strategies
├── tutorial-performance-tuning.md ......... Optimization for scale & load
│
└── DOCUMENTATION_ROADMAP.md .............. Future documentation plans

---

🔥 Most Visited Sections

1. Quick Reference — Commands & Docker setup
2. Tutorial: Dashboard — Real-time monitoring UI
3. Architecture Guide — How it works
4. Visual Diagrams — Flowcharts & network topology
5. Integration Guide — Apparatus + Chimera workflow

---

💡 Common Starting Points

For Security Testers

1. Read: Quick Reference
2. Launch: docker-compose up
3. Open: http://localhost:8090/dashboard
4. Learn: Tutorial: Dashboard

For Developers

1. Read: Architecture Guide + Visual Diagrams
2. Setup: pnpm install && pnpm build
3. Start: pnpm start or pnpm dev:server
4. Test: pnpm test

For DevOps/SRE

1. Read: Integration Guide
2. Deploy: docker-compose up
3. Monitor: Tutorial: Monitoring
4. Scale: See “Performance Tuning” in Integration Guide

For Security Research

1. Read: Tutorial: Autopilot
2. Explore: Tutorial: Chaos Engineering
3. Deep dive: Complete Features
4. Understand flows: Visual Diagrams

---

🔍 Key Concepts at a Glance

Concept	Learn More
MTD (Moving Target Defense)	Architecture → Defense Architecture, or Features → DEFENSE section
Autopilot (AI Red Team)	Tutorial: Autopilot, or Features → RED TEAM AUTOMATION
Scenarios (Multi-step tests)	Tutorial: Scenarios, or Features → SCENARIO AUTOMATION
Deception (Honeypot)	Features → DECEPTION & HONEYPOTS
Tarpit Defense	Features → DEFENSE & MITIGATION
Middleware Stack	Architecture → Middleware Stack, or Visual Diagrams → Request Flow
Protocol Servers	Architecture → Protocol Servers, or Visual Diagrams → Protocol Architecture
Self-Healing	Features → DEFENSE & MITIGATION or Architecture → Core Systems

---

🎓 Recommended Learning Path

Level 1: Getting Started (30 minutes)

• Quick Reference — Commands & services
• Start docker-compose and explore dashboard
• Try 2-3 common testing scenarios

Level 2: Understanding Architecture (1 hour)

• Architecture Guide — Read overview sections
• Visual Diagrams — Study the 10 key diagrams
• Integration Guide — How components work together

Level 3: Deep Dive Features (2 hours)

• Pick a feature area: Chaos, Deception, Autopilot, Defense
• Read corresponding tutorial
• Read corresponding feature catalog section
• Try hands-on examples

Level 4: Advanced Usage (Variable)

• Read all remaining tutorials
• Explore Complete Features
• Review API Reference
• Create custom scenarios and automations

---

🤝 Need Help?

• Questions about a feature? → Search Complete Features
• How do I…? → Check “I want to…” section above
• Technical question? → Start with Architecture Guide
• Not sure where to start? → Read Quick Reference
• Found an issue? → Check Troubleshooting in Quick Reference

---

📖 Document Status

Document	Purpose	Target Audience	Status
quick-reference.md	Quick commands & help	Everyone	✅ Current
integration-guide.md	Component integration	Testers & DevOps	✅ Current
architecture.md	Technical design	Developers	✅ Current
diagrams.md	Visual architecture	Everyone	✅ Current
features.md	Feature inventory	Everyone	✅ Current
api.md	API endpoints	Developers	✅ Current
tutorial-cli.md	CLI tool guide	Developers	✅ Current
tutorial-dashboard.md	Web UI guide	Testers	✅ Current
tutorial-webhooks.md	Webhook integration	Developers	✅ Current
tutorial-chaos-engineering.md	Chaos features	Security team	✅ Current
tutorial-defense-rules.md	Defense setup	Security team	✅ Current
tutorial-autopilot.md	AI red team	Advanced users	✅ Current
tutorial-monitoring.md	Monitoring & metrics	DevOps/SRE	✅ Current
tutorial-scenarios.md	Scenario creation	Advanced users	✅ Current
tutorial-live-payload-fuzzer.md	API/payload testing	Security testers	✅ New
tutorial-testing-lab.md	Unified testing (k6/Nuclei)	QA/Security engineers	✅ New
tutorial-attacker-fingerprinting.md	Threat monitoring & response	SOC/Incident response	✅ New
tutorial-overview-dashboard.md	System health & incidents	All users	✅ New
tutorial-scenario-builder.md	Multi-step automation	Advanced users	✅ New
tutorial-chaos-console.md	Fault injection & resilience	DevOps/SRE	✅ New
tutorial-advanced-red-team.md	Multi-target campaigns	Red teamers	✅ New
tutorial-performance-tuning.md	Optimization & scaling	Operators	✅ New

---

Last Updated: 2026-02-22

For documentation roadmap and planned improvements, see DOCUMENTATION_ROADMAP.md.