Resources
Everything you need to evaluate, operate, or extend Wardex.
Documentation, runbooks, SDKs, and reference material — all versioned with the product.
Quick Start
Running in under five minutes.
Build from source
cargo build --releaseRequires Rust edition 2024, MSRV 1.88.0.
Launch the server
cargo run -- serveAPI, browser console, and embedded monitor on port 8080.
Analyse a scenario
cargo run -- analyze examples/credential_storm.csvRun a canned attack scenario through the detection pipeline.
Run the test suite
cargo test1,500+ automated tests with stable CI signal.
Install on macOS
brew tap pinkysworld/wardex && brew install wardexInstall on Debian / Ubuntu
sudo apt install wardexVia the signed Wardex APT repository.
Documentation
Find what you need, fast.
All docs are kept in-repo alongside the code they describe. No stale pages, no out-of-sync references.
Getting Started
Step-by-step guide from fresh clone to running control plane with a sample agent enrolled.
Documentation Index
The master map of all in-repo documentation — architecture, operations, research, and roadmap.
OpenAPI Contract
The versioned HTTP contract for every REST endpoint Wardex exposes. Feed directly into your OpenAPI tooling.
Deployment Models
Standalone, enterprise control-plane, regional relay, and air-gapped deployment patterns.
Runbooks
Operational guidance for agents, incident response, SIEM integrations, and agent rollback procedures.
SDK Guide
TypeScript and Python SDKs with 60+ methods. Perfect for automation, CI gating, and bespoke dashboards.
WASM Extensions
Build custom detection and response plugins as sandboxed WebAssembly modules.
Threat Model
Adversary profiles, abuse cases, trust boundaries, and mitigation inventory for the platform itself.
Configuration Reference
Every config knob, every environment variable, every default. With examples for common deployment shapes.
Disaster Recovery
Backup, restore, and continuity procedures for the control plane and archive tiers.
Reproducibility & Supply Chain
How to verify SLSA attestations, cosign signatures, and reproduce release builds bit-for-bit.
Roadmap
Where Wardex is going — SSO, HA clustering, content operations, ecosystem expansion.
Changelog
Auto-generated release history — every version, every change, every release.
Interfaces