UI Guide

Cluster Management

Invite peers, join a cluster, and manage federated FlatRun servers from the UI.

The Cluster page connects this FlatRun server to others so you can view deployments across a whole fleet. For the concepts behind it, see Clustering & Federation.

Status Overview

The top of the page summarizes this node:

  • Server name — how this node identifies itself to peers
  • Peer count — number of connected servers
  • Agent version

Peer List

Connected peers appear in a table:

  • Name and URL
  • Statusactive, peered, pending, or unreachable
  • Connected and Last seen times
  • Actions — remove the peer

Inviting a Peer

  1. Click Generate Invite.
  2. Copy the token from the dialog. It expires in one hour and works once.
  3. Hand the token and this server's URL to whoever administers the other server.

Joining a Cluster

  1. On the server that received an invite, click Join Cluster.
  2. Enter the peer server URL (the server that issued the invite).
  3. Paste the invite token.
  4. Click Connect. The two servers exchange API keys and the peer appears in both lists.
One token, one join. Each invite is consumed on use. If a join fails after the one-hour window, generate a fresh invite and try again.

Removing a Peer

  1. Find the peer in the list and click its remove action.
  2. Confirm. The peer is disconnected immediately.

Reconnecting a removed peer requires a new invite.

Permissions

Generating invites, joining, and removing peers require the cluster:write permission. Users without it can view cluster status but not change membership.

Star us on GitHub