Quick Start

Get Tetrapus running locally in under five minutes. Pull from our Docker registry — no build tools required.

Prerequisites

Docker — install from docker.com
GPU — Vulkan-capable GPU recommended for the desktop app (software rendering available as fallback)

Run the Desktop App

Full GUI with scene renderer, pane system, and live data. Needs X11 or Wayland display.

Bash

docker pull registry.tetrapus.com/tetrapus

# X11
docker run -it --rm \
  -e DISPLAY=$DISPLAY \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  --device /dev/dri \
  registry.tetrapus.com/tetrapus

# Wayland
docker run -it --rm \
  -e WAYLAND_DISPLAY=$WAYLAND_DISPLAY \
  -e XDG_RUNTIME_DIR=/tmp \
  -v $XDG_RUNTIME_DIR/$WAYLAND_DISPLAY:/tmp/$WAYLAND_DISPLAY \
  --device /dev/dri \
  registry.tetrapus.com/tetrapus

Run the Headless Server

No GPU required. Exposes QUIC (4433), WebSocket (9800), and REST (9801) endpoints.

Bash

docker pull registry.tetrapus.com/tetrapus-server

docker run -d --name tetrapus-server \
  -p 4433:4433/udp \
  -p 9800:9800 \
  -p 9801:9801 \
  registry.tetrapus.com/tetrapus-server

Use the CLI

Schema registration, debugging, and diagnostics.

Bash

docker pull registry.tetrapus.com/nerve

docker run --rm registry.tetrapus.com/nerve --help
docker run --rm registry.tetrapus.com/nerve schema list --format json

Available Images

Image	Description
registry.tetrapus.com/tetrapus	Desktop GUI (eframe/egui + WGPU)
registry.tetrapus.com/tetrapus-server	Headless server (QUIC + WS + REST)
registry.tetrapus.com/nerve	CLI tool for schemas & diagnostics
registry.tetrapus.com/nerve-bridge	WAL → ClickHouse bridge
registry.tetrapus.com/scene-server	Octree tile HTTP server
registry.tetrapus.com/tile-deriver	Derived tile HTTP server

Self-Hosted Enterprise Quick Start

Running on Kubernetes? The official Helm chart bundles the control plane, gateway, operator, CRDs, and RBAC. Install in one command and bring your own Postgres + TLS Secret refs.

Bash

helm repo add tetrapus https://charts.tetrapus.io
helm repo update

helm install tetrapus tetrapus/tetrapus \
    --namespace tetrapus-system \
    --create-namespace \
    --version 1.0.0 \
    --values my-values.yaml

See the full Helm chart reference for every values.yaml knob, common production / dev patches, and what gets installed in the cluster.

Next Steps

Questions?

Reach out for help with integration, deployment, or custom domain codecs.

Get Started Request a Demo