RavenXcope Documentation
Welcome to the RavenXcope technical documentation — a comprehensive defense center platform for network sensor management, security analytics, and threat monitoring.
What is RavenXcope?
RavenXcope is a multi-service platform that provides:
- Sensor lifecycle management — Register, enroll, monitor, and configure network sensors across distributed locations.
- Virtual sensor deployment — Deploy and manage virtual sensor workloads on physical sensor hosts.
- Security analytics — Aggregate and visualize IDS/IPS alerts from OpenSearch with rich filtering, charting, and PDF export.
- Organization-scoped access control — Multi-tenant user, role, and permission management.
- AI-powered analytics chat — Optional LLM-backed conversational analytics with citation support.
Service Architecture
Documentation Sections
Backend
Technical documentation for the Ravenxcope Backend — the central .NET API service. Covers architecture, startup pipeline, configuration, and all feature modules (auth, sensors, analytics, assets, locations, organizations, roles, and permissions).
Frontend
Technical documentation for the Ravenxcope Frontend — a React single-page application. Covers architecture, routing, authentication, API integration, and all feature modules (sensor dashboard, analytics, user/role management).
Sensor Agent
Technical documentation for the Ravenxcope Sensor Agent — a lightweight Go service deployed on each sensor host. Covers the enrollment flow, heartbeat mechanism, interface detection, and Docker deployment.
Ansible Service
Technical documentation for the Ravenxcope Ansible Service — a Go-based executor for Ansible playbooks. Covers playbook orchestration, rule management, and API-driven host configuration.
Quick Links
| Topic | Backend | Frontend | Sensor Agent | Ansible Service |
|---|---|---|---|---|
| Overview | Backend Overview | Frontend Overview | Agent Overview | Ansible Overview |
| Architecture | Backend Architecture | Frontend Architecture | Enrollment Flow | API Reference |
| Configuration | Backend Config | Frontend Config | Agent Config | Ansible Config |
| Deployment | Backend Runbook | Frontend Runbook | Agent Deployment | Ansible Deployment |
| Development | Backend Dev Guide | Frontend Dev Guide | — | — |