Uebliche

Appearance

Getting Started ​

This guide covers local setup for the current headless Gateway runtime.

Prerequisites ​

  • Docker Engine + Compose v2
  • Reachable Public API (CONNECT_API_BASE)
  • Free local ports:
    • 25565 (Minecraft)
    • 9001 (Connect control + metrics)
    • 18080 (dev health port via compose.dev.yml)

Run the dev stack ​

From the repository root:

bash
cd gateway
docker compose -f compose.dev.yml up --build

This starts:

  • watcher (control-plane client)
  • mcproxy (Minecraft TCP relay)

Validate runtime health ​

bash
curl -fsS http://127.0.0.1:18080/health
curl -fsS http://127.0.0.1:9001/metrics | head

If the gateway has active routes in the Public API, Minecraft traffic can be tested on:

  • 127.0.0.1:25565

Typical env overrides ​

  • CONNECT_API_BASE (default in dev: http://host.docker.internal:8080/v1)
  • CONNECT_GATEWAY_NAME
  • CONNECT_GATEWAY_REGION
  • CONNECT_GATEWAY_NETWORK_ID
  • CONNECT_GATEWAY_PUBLIC_HOST
  • CONNECT_GATEWAY_CONNECT_PORT (default 9001)

Stop ​

bash
docker compose -f compose.dev.yml down

Next ​