Documentation

Everything you need to deploy, configure, and optimize HailBytes security tools.

Quick Start Guides

Featured Documentation

Popular

AWS CloudFormation Templates

One-click deployment templates for both products. Includes VPC setup, security groups, database configuration, and load balancing.

View Templates →
New

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
  • SIEM Integration
  • Ticketing Systems
  • CI/CD Pipelines

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

GoPhish

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
View Tutorial →
reNgine

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
View Tutorial →
GoPhish

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
View Tutorial →
reNgine

Bug Bounty Reconnaissance Workflow

Optimize your bug bounty hunting with automated reconnaissance and AI-powered vulnerability analysis.

  • Multi-target reconnaissance setup
  • Configure 20+ security tools integration
  • Use AI for vulnerability prioritization
  • Track historical scan data
  • Export reports for submissions
View Tutorial →
Integration

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
View Tutorial →
Advanced

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
View Tutorial →

Video Tutorials

GoPhish Workflow Tutorial

Complete workflow guide for creating and managing phishing campaigns in GoPhish.

Watch on YouTube →

Deploy GoPhish on AWS

Complete walkthrough for deploying GoPhish Cloud on AWS infrastructure.

Watch on YouTube →

reNgine Cloud Setup

Complete guide to deploying and running your first reNgine reconnaissance scan.

Watch on YouTube →

Azure Deploy: GoPhish

Step-by-step Azure marketplace deployment guide for GoPhish Cloud.

Watch on YouTube →

Need More Help?

Can't find what you're looking for? Our support team is here to help.