DOCUMENTATION
Technical documentation for deploying and operating Hayrok .
Guidance for administrators, security teams, engineers, developers, and integration owners — role-aware, task-oriented, and versioned.
DOCUMENTATION SECTIONS
15 sections, organized by task.
GS
Getting Started
First-time setup, workspace, and initial validation run.
PL
Platform Overview
Architecture, components, and the validation lifecycle.
UT
Users & Tenants
Roles, permissions, tenant configuration, and SSO.
AS
Assets & Scope
Onboarding assets, defining authorized scope, and tags.
RV
Run Validation
Selecting objectives, scenarios, approvals, and executions.
FE
Findings & Evidence
Finding drawer, evidence contract, and export.
AP
Attack Paths
Building, filtering, and reasoning about the attack graph.
RP
Reports
Executive, technical, and audit-ready report formats.
HA
Hay Assist
Prompting, explanations, and safe automation patterns.
SL
Scenario Library
Catalog structure, categories, and safety metadata.
IN
Integrations
SIEM, EDR, WAF, cloud, identity, ticketing, and collaboration.
PR
Private Runner
Deployment, connectivity, and customer-controlled scope.
AR
API Reference
REST API, webhooks, and SDK usage.
SA
Security Architecture
Data flow, isolation, encryption, and controls.
RN
Release Notes
Product updates, scenarios, and integrations.
DOCUMENTATION PRINCIPLES
What every doc page delivers.
✓Searchable
✓Versioned
✓Role-aware
✓Task-oriented
✓Linked from the product
✓Clear about prerequisites
✓Clear about permissions
✓Clear about current availability
✓Supported by diagrams and examples
QUICKSTART
From zero to your first validation in 12 minutes.
Deploy the Runner, onboard scope, and execute your first governed scenario.
01
Install the Runner
curl · one command · verified checksum
02
Authorize scope
Signed authorization contract
03
Onboard assets
From CMDB, cloud APIs, or CSV
04
Pick an objective
Guided objective selection
05
Run & review
Governed execution with evidence
POPULAR ARTICLES
What operators read most this month.
GETTING STARTED8 min · Updated Aug 2026
First validation run · a walkthrough
Read →
INTEGRATIONS12 min · Updated Aug 2026
Connecting Splunk and Elastic
Read →
SCOPE9 min · Updated Jul 2026
Authorized scope contracts
Read →
RUNNER14 min · Updated Aug 2026
Deploying the Private Runner in AWS
Read →
EVIDENCE7 min · Updated Aug 2026
Exporting audit-ready evidence
Read →
API11 min · Updated Aug 2026
REST API · authentication & pagination
Read →
THE HAYROK LIBRARY
Published guides, handbooks, and technical references.
Free downloads. Print-ready. Vendor-neutral where possible.
Continuous Validation Handbook
190 pages · Reference guide
Evidence Contract Cookbook
Field-tested templates
The Attack Path Primer
From findings to reachable impact
Governance for Autonomous Agents
Scope · safety · approvals
Deploy and operate Hayrok with confidence.
Documentation is written for the person doing the work — with prerequisites, permissions, and examples.