Resources

Everything you need to evaluate, operate, or extend Wardex.

Documentation, runbooks, SDKs, and reference material — all versioned with the product.

Fresh Captures

Documentation and API surfaces as shipped in v1.0.27.

Current screenshots from the public documentation hub and the Redoc-backed API reference.

Wardex documentation hub showing quick start, docs index, and runbook resources.

Documentation hub

The public resources surface brings quick start, docs index, runbooks, deployment guidance, and SDK references into one release-aligned page.

Open docs index

Wardex API reference rendered from the versioned OpenAPI contract.

API reference

The versioned OpenAPI contract is published as a live Redoc experience so operators and SDK consumers can inspect the exact release surface.

Open API reference

Quick Start

Evaluate Wardex in one guided path.

Build from source

npm ci --prefix admin-console && cargo build --release

Requires Rust edition 2024, MSRV 1.88.0.

Launch the control plane

cargo run

API, browser console, and embedded monitor on port 8080.

Read the admin token

cat var/.wardex_token

Use the token for the browser session and the scripted evaluation flow.

Run the evaluation proof

WARDEX_ADMIN_TOKEN="$(cat var/.wardex_token)" bash scripts/evaluate_to_value.sh

Evaluation-only first-run proof data proves the first alert, response dry-run, evidence export, and deployment trust report in one pass.

Inspect local readiness

cargo run -- doctor

Review the same local diagnostics that back the release posture.

Open the full guide

docs/EVALUATE_WARDEX.md

The canonical 15-minute path is versioned with the product and release gate.

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.

14 resources visible

Getting Started

Step-by-step guide from fresh clone to running control plane with a sample agent enrolled.

Open Guide

Evaluate in 15 Minutes

The canonical evaluation-only journey from start, token, and first-run proof seed through first alert, evidence export, and deployment trust reporting.

Open Evaluation Guide

Documentation Index

The master map of all in-repo documentation — architecture, operations, research, and roadmap.

Open Docs

OpenAPI Contract

The versioned HTTP contract for every REST operation Wardex exposes. Track 262 documented operations and feed them directly into your OpenAPI tooling.

View OpenAPI

Deployment Models

Standalone, enterprise control-plane, regional relay, and air-gapped deployment patterns.

Read Guide

Runbooks

Operational guidance for agents, incident response, SIEM integrations, and agent rollback procedures.

Open Runbooks

SDK Guide

TypeScript and Python SDKs with 260+ methods. Perfect for automation, CI gating, and bespoke dashboards.

SDK Guide

WASM Extensions

Build custom detection and response plugins as sandboxed WebAssembly modules.

WASM Tutorial

Threat Model

Adversary profiles, abuse cases, trust boundaries, and mitigation inventory for the platform itself.

Threat Model

Configuration Reference

Every config knob, every environment variable, every default. With examples for common deployment shapes.

Open Reference

Disaster Recovery

Backup, restore, and continuity procedures for the control plane and archive tiers.

DR Guide

Reproducibility & Supply Chain

How to verify SLSA attestations, cosign signatures, and reproduce release builds bit-for-bit.

Verification Guide

Roadmap

Where Wardex is going — SSO, HA clustering, content operations, ecosystem expansion.

View Roadmap

Changelog

Auto-generated release history — every version, every change, every release.

View Changelog

Interfaces

Six ways to work with Wardex.