Getting started

Set up a proxy route between a public VPS and the host running your game server.

01

What you need

  • A public VPS with a routable IP address, a DNS hostname pointing to it, and TCP 443 available for workspace setup.
  • A game host, at home or rented, running your game server.
  • Both running Linux with systemd, on x86_64 or ARM64. GameRail checks host prerequisites before installation.
  • sudo on each machine.
02

Install on the VPS

Run the installer on the machine that will own your workspace state.

VPS · shell
$ curl -fsSL https://gamerail.app/install | sh
03

Connect your workspace

Open the link printed by the installer and sign in. Create your workspace and provide the VPS hostname when prompted. The dashboard completes secure enrollment.

installer output
https://dashboard.gamerail.app/#bootstrap=...
04

Choose machine roles

  • Open Network.
  • Select the VPS.
  • Enable the Networking module and follow the dashboard setup prompts.
05

Pair the game host

Run the same installer on your game host. Open its browser link, sign in, and select the workspace you just created.

game host · shell
$ curl -fsSL https://gamerail.app/install | sh

After it joins the workspace, enable the Networking module for the game host in the dashboard and follow the setup prompts.

The game host connects out to the workspace authority, so it does not need an inbound port open for pairing.

06

Build the route

Back in the dashboard, with both machines online, set up the proxy route.

  • Choose the VPS as the public proxy and the game host as its target.
  • Confirm the public IP, local interface and tunnel endpoint shown in the setup.
  • Select the TCP/UDP ports you want to publish.
  • Review and approve the planned changes, then check the connection status.

When the route is active, players connect to your VPS on the public port and GameRail forwards the traffic across the WireGuard overlay to your game host. Point your server's DNS record to the VPS public IP, or share the VPS public IP and public port with players.

07

Reference

To inspect the installed version, run gamerail-v2 version. Stable installations enable gamerail-v2-update.timer; an administrator can start gamerail-v2-update.service to check for an update immediately.