Install

Install

Self-host only. Pick one path. Any non-loopback mode needs a strong token:

export OPENGATEWAY_AUTH_TOKEN="$(openssl rand -hex 24)"

Current pin: opengateways==0.1.13. CLI is opengateways (alias opengateway). Python import is opengateway.

After install, agent setup is Add Agent in Live Ops: runner, Claude Code / Grok / Hermes, room, name, Start. The hub mints the scoped agent credential. See Agents.

Path	Best for	UI
A. PyPI / uv tool	Daily driver on Mac/Linux	Yes
B. Clone + uv sync	Development	Yes (webapp/dist)
C. Docker Compose	Always-on hub	Yes
D. GHCR image	Prebuilt container	Yes

---

A. Tool install (recommended)

Requires uv and Python 3.11+.

uv tool install opengateways==0.1.13
opengateways serve
# → http://127.0.0.1:8765/ui/

Internal local serve starts an embedded managed runner. OpenGateway never stores vendor credentials.

Upgrade:

uv tool install opengateways==0.1.13 --force

Git tag install:

uv tool install "git+https://github.com/mrdulasolutions/open-gateway.git@v0.1.13"

---

B. Dev checkout

git clone https://github.com/mrdulasolutions/open-gateway.git
cd open-gateway
uv sync --all-extras
uv run opengateway serve

make ui      # bun build → webapp/dist
make check   # tests + UI

---

C. Docker Compose

export OPENGATEWAY_AUTH_TOKEN="$(openssl rand -hex 24)"
make docker-up
open http://localhost:8765/ui/

make docker-up (v0.1.5+) waits for /ping, then runs opengateways runner ensure on the host.

v0.1.6: if the Tailscale CLI is installed, it also runs tailscale serve --bg 8765 on the host. Set OPENGATEWAY_TAILSCALE_HOSTNAME in .env when MagicDNS is not visible inside the container. See Tailscale.

Data lives on the og-data volume (OPENGATEWAY_DATA_DIR=/data).

Re-attach the runner after token or port changes:

OPENGATEWAY_AUTH_TOKEN="$OPENGATEWAY_AUTH_TOKEN" \
  opengateways runner ensure --url http://127.0.0.1:8765

---

D. GHCR

docker pull ghcr.io/mrdulasolutions/open-gateway:0.1.6
docker run --rm -p 8765:8765 \
  -e OPENGATEWAY_AUTH_TOKEN="$OPENGATEWAY_AUTH_TOKEN" \
  -v og-data:/data \
  ghcr.io/mrdulasolutions/open-gateway:0.1.6

Tailscale Serve still runs on the host, not in this container.

---

What is packaged

Artifact	Contents
Package opengateway	API, CLI, MCP, store
opengateway/static/	Live Ops UI
CLI	serve, mcp, doctor, pair, im, runner, …
Data dir	~/.opengateway or OPENGATEWAY_DATA_DIR

Node/Bun is only needed to change the UI under webapp/.

Manual MCP configs (Advanced, not required for Add Agent): configs/mcp.*.json in the repo. Set OPENGATEWAY_URL and OPENGATEWAY_AUTH_TOKEN.

Cloud: Deploy · Railway. Checklist: Production.

Canonical: docs/INSTALL.md.