HoneyBadger Vanguard

Quick Start

# Check API status
curl https://api.invokehoneybadger.com/api/v1/status

# List available modules
curl https://api.invokehoneybadger.com/api/v1/modules

# With authentication (self-hosted)
curl -H "X-API-Key: your_key" https://your-api.local/api/v1/agents

Note: This site displays API documentation and status. For a functional backend, see the self-hosting guide below.

Self-Hosting

Deploy your own private HBV API instance with Docker Compose:

git clone https://github.com/invokehoneybadger/invokehoneybadger-api.git
cd invokehoneybadger-api/self-hosted
cp .env.example .env
# Edit .env with your secrets
docker-compose up -d

Zero-trust with Twingate: Deploy behind Twingate connectors for private network access without public exposure.

Architecture

Local-First Design: HBV tools are designed to operate locally by default for maximum OPSEC. Results are saved to local files unless explicitly configured to sync with a self-hosted API.

Optional Cloud Sync

• Deploy your own API backend (Docker Compose template provided)
• Use Twingate or VPN for zero-trust access
• Configure HBV tools with --api-endpoint flag
• Centralize data collection across multiple agents

OPSEC: HBV tools never "phone home" to public servers. All API communication is opt-in and user-controlled.

Quick Links