Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation Overview

This guide covers installing all HoneyBee components.

Component Installation

HoneyBee Core

The central orchestration manager.

Options:

  • Docker - Recommended for production
  • Cargo - For development

Requirements:

  • Rust 1.75+ (nightly)
  • Linux, Windows, or macOS

HoneyBee Node

Individual honeypot nodes.

Options:

Requirements:

  • Go 1.21+ (for building)
  • Static binary (no runtime dependencies)
  • Linux, Windows, or macOS

HoneyBee Potstore

Honeypot repository (automatically cloned by nodes).

No installation required - Nodes automatically clone from GitHub.

Installation Order

  1. Install HoneyBee Core first
  2. Install HoneyBee Nodes and connect to Core
  3. Honeypots are installed automatically via Core commands

System Requirements

Minimum Requirements

  • CPU: 1 core
  • RAM: 512 MB
  • Disk: 1 GB free space
  • Network: TCP connectivity between Core and Nodes
  • CPU: 2+ cores
  • RAM: 2 GB
  • Disk: 10 GB free space (for honeypots)
  • Network: Low latency (< 100ms)

For Honeypots

  • Python 3.7+ (for Python-based honeypots like Cowrie)
  • PHP 7.4+ (for PHP-based honeypots like HonnyPotter)
  • Git (for cloning Potstore)

Platform-Specific Notes

Linux

All components work natively on Linux. Systemd service files available.

Windows

  • Core: Requires Rust nightly
  • Node: Pre-built Windows binaries available
  • Honeypots: Python/PHP must be installed

macOS

  • Core: Requires Rust nightly
  • Node: Pre-built macOS binaries available
  • Honeypots: Python/PHP via Homebrew

Verification

After installation, verify each component:

Verify Core

# Check if Core is running
curl http://localhost:9002/health

# Or check logs
docker logs honeybee-core

Verify Node

# Check node status
./build/honeybee-node -version

# Validate configuration
./build/honeybee-node -config configs/config.yaml -validate

Verify Honeypots

Honeypots are verified automatically when installed. Check node logs for installation status.

Next Steps