Configuration Builder

You can use the tool below to generate a configuration for your Pocket Relay server

Server Connection

Usually you won't need to change this, this is the local network interface IP that the server will bind on and accept connections from. If you don't know what this is you should probably leave it as 0.0.0.0. Must be a valid IP address

This is the port the server will bind to, if you change this you will also need to include the new port in the server connection URL

Dashboard

Any accounts created using this email address (Including Origin/EA accounts) will be granted the super admin role giving them permission to control the server from the dashboard (You should set this to your email if you are the server owner)

Disable creating accounts through the dashboard

Galaxy at War

In the default server configuration your Galaxy At War progress will not decay at all, this is because "decay" is set to 0.0 which doesn’t decay at all.

Logging

The level of logs the server will output. You will probably want to leave this on Info unless the developer is requesting logs to solve an issue then you may be asked to use the Debug level

Retriever

Allow fetching data from the official servers is allowed or not. Disabling this will not allow the server to retrieve data from the official servers (Authenticating Origin/EA accounts and loading their player data)

Allow authenticating EA/Origin accounts using the official servers. Disabling this will prevent anyone using EA/Origin from playing on your server without Unlinking their account..

Allow loading player data of EA/Origin players from the official servers, disable this if you don't want existing player data to be loaded.

QoS

The type of QoS configuration you would like, using "Official" can be good if you want players who have Open NAT types to directly connect to each other.
The Hamachi is specifically for virtual LAN type networks.
The recommended choice is "Official" combined with the "Stricter" tunneling option

Tunneling

Choose when the server is allowed to tunnel connections. "Stricter" will likely only work if you have a valid QoS server configured

This is the port the UDP tunnel server will bind to

This is the external facing port for the UDP tunnel, ensure this is the same as the UDP tunnel port, if you are using a reverse proxy or binding a different docker port this should be the external facing port used by your reverse proxy / docker port binding

Allow disabling the UDP tunnel entirely

API

Allow the games API to be publicly accessible, you can enable this if you want to create a bot or something and want to access the games list API without requiring authentication

info

Below is your generated config

config.json
{
  "host": "0.0.0.0",
  "port": 80,
  "reverse_proxy": false,
  "dashboard": {
    "disable_registration": false
  },
  "qos": {
    "type": "local"
  },
  "menu_message": "<font color='#B2B2B2'>Pocket Relay</font> - <font color='#FFFF66'>Logged as: {n}</font>",
  "galaxy_at_war": {
    "decay": 0,
    "promotions": true
  },
  "logging": "info",
  "retriever": {
    "enabled": true,
    "origin_fetch": true,
    "origin_fetch_data": true
  },
  "tunnel": "stricter",
  "udp_tunnel": {
    "port": 9032,
    "external_port": 9032,
    "enabled": true
  },
  "api": {
    "public_games": false,
    "public_games_hide_players": true
  }
}