Skip to content

Concepts

  • Operators run the installation: they manage nodes, games, users and platform settings (the Platform section of the sidebar).
  • A tenant is a group with its own servers, members, Steam accounts, API tokens and webhooks. Tenants can’t see each other’s servers, and their game servers are on separate Docker networks.
  • Members belong to a tenant with a role:
Role May
Owner everything in the tenant
Admin everything in the tenant
Member only the servers they are granted, with the permissions granted there
  • A template (shown as a game) describes how to install, start and stop a game: images, the startup command, variables, ports by role, config files, and install or Steam jobs. See Template format.
  • A server is one instance of a template on a node, with its own files, variable values and limits for memory, CPU and disk.
  • A node has a pool of allocations: address and port pairs, for TCP, UDP or both.
  • A template names the ports a game needs by role: game, query, rcon… with a preferred number or an offset from the game port.
  • Creating a server takes one allocation per role from the node’s pool. The game gets the numbers in its startup command and config files.
  • Exposure providers open these ports on a router or cloud firewall while the server exists. See Port forwarding.

Installs, reinstalls and Steam updates run as jobs in their own short-lived containers. Only jobs get secrets such as a Steam password; the game’s container never does. See Steam accounts.

Steam passwords and secret variables are write-only: they can be set or replaced, never read back, and are stored encrypted with a key protected by the panel’s master key.