Skip to main content

Install the agent

The Engress agent is a single binary: engress-agent. It registers with the edge and proxies HTTP from the tunnel to a local TCP backend.

Prerequisites​

  • A machine that can reach the public internet on outbound TCP (no inbound ports required).
  • Go 1.25+ if you build from source.
  • Access to private ghostweasellabs modules if building locally (GOPRIVATE=github.com/ghostweasellabs/*).

macOS and Linux (build from source)​

Release binaries and an install script are not published yet. Build from the engress-agent repository:

export GOPRIVATE=github.com/ghostweasellabs/*
export GONOSUMDB=github.com/ghostweasellabs/*

go install github.com/ghostweasellabs/engress-agent/cmd/engress-agent@latest

Ensure $(go env GOPATH)/bin is on your PATH, then verify:

engress-agent version

You should see a version line with the current commit SHA.

Docker​

A container image is published to GHCR for CI and lab use:

docker run --rm ghcr.io/ghostweasellabs/engress-agent:main version

For a long-running tunnel, pass tunnel serve and the required flags (see Your first endpoint).

Windows​

Build from source with Go on Windows using the same go install path above. WSL is supported — run the agent inside WSL if your model server lives there so --local can reach 127.0.0.1.

Next​

Create your first endpoint — sign in, issue a token, and bring a tunnel up.