Skip to content
Install

Run game servers next to your apps

You do not need a separate machine or a game hosting service to run a game server for your friends or your community. To Orchard, a game server is an app with a public TCP or UDP port and a volume for its world, so it runs next to your websites and databases with the same logs, metrics, alerts, and quotas.

Each template creates a game server with its port and its volume already set.

Template What it runs
Minecraft A Paper, Purpur, Vanilla, Fabric, NeoForge, Forge, or Quilt server, or a CurseForge or Modrinth pack
Valheim A dedicated server with automatic updates and backups
Palworld A dedicated server. It needs at least 8 GB of memory.
Satisfactory A dedicated server with autosave, which pauses when nobody plays
Enshrouded A dedicated server

To browse every template, go to orchard.hackclub.com/templates.

  • A public IP address for your organization, or an instance default. To check, refer to Publish a TCP or UDP port.
  • A layer 4 (L4) load balancer in the cluster.
  • Enough free memory for the game. Each template shows its size before you deploy.

Public game ports do not work in Cloudflare Tunnel mode, because tunnels carry HTTP only.

  1. Open a project.
  2. Select New app.
  3. Search for the game, such as Minecraft Server.
  4. Fill in the parameters, such as the server type, the version, and the memory.
  5. Select the deploy button.
  6. When the app is running, open it and go to Network. The public address is in Ports.
  7. Give the public address to your players.

From the CLI, run orchard template list to find the template ID, then run the following command:

orchard template deploy <template-id> --param appName=minecraft
  • The world is on a volume, so it survives restarts and redeploys.
  • Orchard does not back up app volumes. Copy the world somewhere else from a shell in the container, or use the game’s own backups, such as the Valheim template’s.
  • An app with a volume must use the Recreate update strategy, which stops the app before it updates. Players disconnect for a moment during an update.
  • Size: Set the CPU and memory of the game server so that it cannot use the memory your apps need.
  • Quotas: Cap what each organization and member can use with quotas.
  • Placement: On a cluster with more than one node, put the game server on its own node with a node pool.
  • Idle time: Stop the app when nobody plays. Stopping an app scales it to zero and keeps its world.
  • Crashes: Get a message in Discord, Slack, or email when the server crashes. Subscribe a channel to pod.crashing in notifications.
  • Console: Read the server log and open a shell in the container from the app’s page.

Public TCP and UDP traffic skips the HTTP layer, so app protection does not apply. Use the game’s own allowlist or password to control who joins.