Choose an agent installation
Find the installation procedure for your game runtime, host, or container platform.
Install one agent per server record. Choose the runtime below, then follow its complete installation guide.
Before you begin
You need owner or admin access, an active organization subscription, and an available server slot. Create a record in Servers and open its Setup page for downloads and the agent key.
Paper and Bukkit
Paper, Purpur, Folia, Spigot, and Bukkit plugins.
Minecraft proxies
Velocity, BungeeCord, and Waterfall.
Hytale
Install and register the Hytale plugin.
Standalone hosts
Linux, macOS, and Windows executables.
Docker
Run the image with Docker Engine access.
Podman
Rootless API access and a Quadlet service.
Kubernetes
Choose read-only or full cluster access explicitly.
Choose the access you need
A plugin runs inside its game process. A standalone binary runs with its operating-system user's permissions. Mounting a container socket or giving cluster credentials extends that access to the container platform.
| Platform | Supported operations | External requirements |
|---|---|---|
| Docker | Containers, networks, volumes, Compose, Swarm | Docker Engine API; Compose CLI for Compose actions |
| Podman | Containers, pods, kube actions, Quadlet, Buildah | Libpod API; host tools and systemd for relevant actions |
| Kubernetes | Inventory, YAML comparison, workloads, exec, Helm | RBAC; metrics API for metrics, Helm CLI for releases, kubectl for maintenance actions |
YAML comparison is native. It does not require kubectl. Quadlet and Buildah are supported where their host tools are available.
Read container platform requirements before granting access. An agent container only sees tools and sockets available inside its own environment.
After installation
Confirm Online, then open a live panel and check a real result. An online badge proves registration; a live panel proves the browser can use the agent.
For an existing installation, use update, rotate, move, or remove an agent. For configuration precedence and defaults, use agent configuration.
Was this page helpful?
Send a quick note if anything is missing or unclear.
Last updated on