Install
Prerequisites, build, and the files the binary writes.
On this page
Prerequisites
- Go
1.27 or newer (
go.modcurrently requiresgo 1.27) - Ollama
on any node that should serve models (default
http://localhost:11434) - For an admin/relay: a reachable public IP, or NAT forwarding of TCP
admin_port(default 4002) and TCP+UDPrelay_port(default 4001)
Build
From the product repo
root, so config.yaml and web/ resolve:
git clone https://github.com/asynchronomatic/speakeasy.git
cd speakeasy
go mod download
make build
make build writes build/speakeasy and build/admincli. Cross-compile with make build-all (Windows amd64, Linux amd64/arm64, Darwin arm64).
First-run files
Run the binary from a directory that will hold config and keys. speakeasy join (members) or speakeasy admin init (seed node) writes:
| File | Purpose |
|---|---|
config.yaml |
Runtime settings (mode 0600) |
node.key |
Proxy libp2p identity |
relay.key |
Admin/relay identity |
Existing node.key / relay.key are kept if you re-run init. Keep the keys. Losing them changes this node’s peer ID.
The dashboard is served from the web/ directory next to the process. Run from the checkout (or copy web/ with the binary).
Optional
Set ACCESSIBLE=1 so the huh forms in init / join use screen-reader prompts.
Admin persistence defaults to admin.jkv in the working directory. Override with ADMIN_DB_PATH if you need a different path.