Documentation
Everything you need to deploy, configure, and optimize HailBytes security tools.
Quick Start Guides
HailBytes SAT
- Quickstart (10 minutes)
- Deploy on AWS (5 minutes)
- Deploy on AWS via the CLI
- Deploy on Azure (5 minutes)
- Deploy on Azure via the CLI
- Create Your First Campaign
- Email Template Best Practices
- Configure SMTP (SES, SendGrid, etc.)
- REST API Reference
- MCP Server Reference (for AI agents)
- SAML & OIDC SSO
- SCIM 2.0 Provisioning
- MSSP White-Label & Multi-Tenancy
- Training Tracks & Dashboard
- Just-In-Time Training
- Risk-Based Auto-Enroll
- Phish Triage Queue
- Executive Reports
Featured Documentation
AWS CloudFormation Templates
One-click deployment templates for both products. Includes VPC setup, security groups, database configuration, and load balancing.
View Templates →Azure ARM Templates
Complete Azure deployment with VM Scale Sets, managed databases, and Application Gateway with WAF.
View Templates →Documentation Sections
Deployment
- AWS Deployment Guide
- Azure Deployment Guide
- Docker Deployment
- Kubernetes (AKS/EKS)
- High Availability Setup
- SSL/TLS Configuration
Configuration
- Environment Variables
- Database Setup
- Email Configuration
- Authentication & SSO
- Webhook Integration
- Custom Branding
API Reference
- REST API Overview
- Authentication
- Campaign Management
- Scan Automation
- Webhooks & Events
- Rate Limits
User Guides
- Creating Campaigns
- Email Templates
- Landing Pages
- Target Groups
- Reporting & Analytics
- Best Practices
Integrations
- Slack Notifications
- Microsoft Teams
- Discord Alerts
- Telegram & Lark
- SIEM Integration
- MCP Server (AI Agents)
Troubleshooting
- Common Issues
- Email Delivery
- Performance Tuning
- Database Issues
- Logs & Debugging
- Support Resources
Core Use Cases & Tutorials
Step-by-step guides for the most common security workflows
Building a Quarterly Phishing Campaign
Learn how to create progressive phishing simulations that adapt to user behavior and track improvement over time.
- Create baseline assessment campaigns
- Design realistic phishing templates
- Schedule progressive difficulty levels
- Analyze click-through rates and trends
- Generate compliance reports
Continuous Subdomain Monitoring
Set up automated reconnaissance to discover new subdomains and detect shadow IT before attackers do.
- Configure daily reconnaissance scans
- Set up Slack/Teams alerts for new findings
- Integrate with vulnerability scanners
- Track attack surface changes over time
- Export findings to CSV/JSON
Executive-Targeted Spear Phishing
Test C-level executives with highly personalized campaigns while maintaining discretion and compliance.
- Create VIP-only target groups
- Design executive-focused templates
- Configure private reporting dashboards
- Schedule non-disruptive timing
- Provide remediation training
Bug Bounty Reconnaissance Workflow
Optimize your bug bounty hunting with automated reconnaissance and AI-powered vulnerability analysis.
- Multi-target reconnaissance setup
- Configure 30+ integrated security tools
- Use AI for vulnerability prioritization
- Drive scans from AI agents via the built-in MCP server
- Track historical scan data and export reports
SIEM Integration for SOC Teams
Stream security events to Splunk, Sentinel, or ELK for centralized monitoring and incident response.
- Configure webhook endpoints
- Map events to SIEM schemas
- Create correlation rules
- Build custom dashboards
- Set up automated playbooks
CI/CD Pipeline Security Gates
Integrate security scanning into GitHub Actions, GitLab CI, or Jenkins to block insecure deployments.
- API-based scan triggering
- Fail pipelines on critical findings
- Parallel staging environment scans
- Generate security badges
- Track security debt over time
Video Tutorials
HailBytes SAT Product Demo
Full 4-minute campaign-lifecycle walkthrough - the canonical SAT overview.
HailBytes ASM Product Demo
Full 5-minute analyst-day walkthrough - the canonical ASM overview.
HailBytes SAT Workflow Tutorial
Complete workflow guide for creating and managing phishing campaigns in HailBytes SAT.
Watch on YouTube →Deploy HailBytes SAT on AWS
Complete walkthrough for deploying HailBytes SAT on AWS infrastructure.
Watch on YouTube →HailBytes ASM Setup
Complete guide to deploying and running your first HailBytes ASM reconnaissance scan.
Watch on YouTube →Azure Deploy: HailBytes SAT
Step-by-step Azure marketplace deployment guide for HailBytes SAT.
Watch on YouTube →Need More Help?
Can't find what you're looking for? Our support team is here to help.