Skip to main content

Honey Documentation

Search GCP, AWS, Kubernetes, Docker, Consul, Proxmox, TrueNAS, static local hosts, and other remote honey servers in parallel, then SSH, docker exec, or run recipes against results via a TUI, web UI, or MCP server.

Install​

macOS (Homebrew):

brew install --cask shareed2k/tap/honey

Debian/Ubuntu (.deb):

# grab the .deb for your arch from the latest release, then:
dpkg -i honey_*_linux_amd64.deb        # or _arm64

The package installs honey to /usr/bin, a systemd service that runs as an unprivileged honey user, an example config at /etc/honey/config.yaml, and the honey-plugin-init shim for docker plugins. Configure and start it:

sudoedit /etc/honey/config.yaml
systemctl enable --now honey
journalctl -u honey -f
Docker access is opt-in

docker: steps and docker plugins need honey to reach the Docker socket. The package does not add the honey user to the docker group on install — that membership is effectively root-equivalent (a container can mount the host filesystem), so it must be a deliberate choice. honey's core features (search, SSH exec, web UI, mesh) work without it. To enable docker features:

usermod -aG docker honey && systemctl restart honey

The package recommends tmux (session recordings), shellcheck and python3-flake8 (recipe step linting); apt pulls these automatically. tun2proxy — needed only for honey egress --tun (transparent proxy) — is not in apt; install it from its GitHub releases.

Build from source:

go build -o honey ./cmd/honey

Quick start​

# Interactive TUI — search all configured backends
honey search

# Filter by name substring
honey search my-host

# JSON output
honey search --json --provider aws,k8s web

Guides​