Quickstart

What You'll End With

• A running HailBytes SAT instance with an admin login
• One sending profile (SMTP) verified with a test email
• One target group, one email template, one landing page
• One launched campaign and a result you can read

Step 1: Deploy (5 minutes)

Pick the path that matches how you ship infrastructure. Each option lands you at the HailBytes SAT login page.

For an air-gapped or local trial, run the Docker image directly:

docker run -d \
  --name hailbytes-sat \
  -p 3333:3333 -p 80:80 -p 443:443 \
  -v hailbytes-sat-data:/opt/hailbytes-sat/data \
  hailbytes/hailbytes-sat:latest

Step 2: First Login

1. Open https://<your-host>:3333/. Accept the self-signed certificate warning (replace with a real cert later).
2. Sign in with the temporary admin credentials shown in the deploy output.
3. Set a new password when prompted.
4. Go to Settings → API Key and copy your key. You'll need it for the API and MCP.

Step 3: Configure SMTP & Send a Test

Go to Sending Profiles → New Profile. Pick a template (Amazon SES, SendGrid, Microsoft 365) or fill the fields manually:

Name:         "Quickstart SMTP"
Host:         smtp.your-provider.com:587
Username:     YOUR_SMTP_USERNAME
Password:     YOUR_SMTP_PASSWORD
From Address: security@your-domain.com

Click Send Test Email and verify it lands. If it doesn't, see the SMTP tutorial.

Step 4: Build the Three Building Blocks

1. Group: Users & Groups → New Group. Add yourself as a single target.
2. Template: Email Templates → New Template. Pick a starter (e.g. Microsoft 365 password reset). Confirm {{.URL}} is in the body.
3. Landing Page: Landing Pages → New Page. Pick a credential-capture starter and set a Training Redirect URL so clickers see a coaching page.

Step 5: Launch

Go to Campaigns → New Campaign. Wire the four pieces together and launch:

Name:     "Quickstart Test"
Template: Microsoft 365 Password Reset
Page:     M365 Login Mirror
SMTP:     Quickstart SMTP
URL:      https://<your-host>
Groups:   Quickstart Targets

Or do the entire thing through the API:

curl -X POST https://<your-host>:3333/api/campaigns/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Quickstart Test",
    "template": {"name": "Microsoft 365 Password Reset"},
    "page":     {"name": "M365 Login Mirror"},
    "smtp":     {"name": "Quickstart SMTP"},
    "url":      "https://your-host",
    "groups":   [{"name": "Quickstart Targets"}]
  }'

Step 6: Read the Result

Check your inbox, click the link (or don't), then back in the dashboard open the campaign. You should see five live counters: Sent · Opened · Clicked · Submitted · Reported. The same numbers are available via API:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://<your-host>:3333/api/campaigns/1/summary

Where to Go Next