Run the server
Blitz Relay needs one UDP port for game traffic. The HTTP administration API is optional and uses a separate TCP port.
-
Choose a release
Download a build for your operating system from GitHub Releases.
- Slim builds require the .NET 10 runtime.
- Standalone builds include the runtime and are trimmed.
- Native builds are ahead-of-time compiled, self-contained executables.
-
Set the connection secrets
Every relay connection uses
BLITZ_RELAY_CONNECTION_KEY. The HTTP API also requiresBLITZ_RELAY_HTTP_ADMIN_TOKEN.Terminal window export BLITZ_RELAY_CONNECTION_KEY="replace-with-a-long-random-key"export BLITZ_RELAY_HTTP_ADMIN_TOKEN="replace-with-a-different-random-token"Terminal window $env:BLITZ_RELAY_CONNECTION_KEY = "replace-with-a-long-random-key"$env:BLITZ_RELAY_HTTP_ADMIN_TOKEN = "replace-with-a-different-random-token" -
Start the relay
Terminal window BlitzRelayThe defaults are UDP
7770for relay traffic and TCP7771for the HTTP API. -
Check the HTTP listener
Terminal window curl -i http://127.0.0.1:7771/healthA running API responds with
200 OK. This endpoint does not require authentication.
Use different ports
Section titled “Use different ports”BlitzRelay --port 9000 --http-port 9001Open the selected relay port for inbound UDP traffic. Open the HTTP port for inbound TCP traffic only from networks that should reach the administration API.
What to configure in Unity
Section titled “What to configure in Unity”Your transport must use the same relay address, UDP port, and connection key. Continue with the Netcode for GameObjects guide or Fish-Networking guide.