Master Configuration

Here we explain how to configure the master instance correctly.

You can customize the master configuration in our dashboard. If, for any reason, it is found to be faulty, you can use the default configuration here or compare it with yours to discover potential errors.

Default master configuration

{
  "communication": {
    "hostname": "1.1.1.1",
    "port": 1510
  },
  "hetzner": {
    "api_token": "your_hetzner_api_token",
    "configureMode": true,
    "location": "nbg1",
    "server_type": "cpx",
    "upscalingAtPercentCapacity": 80,
    "blocked_servers": [],
    "ssh_keys": []
  },
  "haProxyConfigPath": "/etc/haproxy/haproxy.cfg",
  "maxOnlinePlayers": 100,
  "firewall_rules": []
}

Now we will explain step by step what each setting is responsible for and how you can edit them correctly.

Communication

  • Hostname: This setting must correspond to the IP address of your master server. This setting does not take effect in real-time, as it is security-related and is fully applied only when the master instance is started.

  • Port: That is the port for the internal communication of the cloud. This setting does not take effect in real-time, as it is security-related and is also fully applied only when the master instance is started.

Hetzner

  • API Token: The API key of your Hetzner Console account. You can obtain this here.

  • Configure Mode: With this setting, you can enable or disable the configuration mode. When active, no Hetzner servers will be ordered. This mode is used for initial configuration or testing purposes.

  • Location: Sets the location of your Hetzner servers. You can find all locations here.

  • Server Type: Determines the server types used in the system. An overview of all server types can be found here. You only need to enter the prefix there, e.g., cpx or cx.

  • Upscaling At Percent Capacity: With this value, you can determine at what percentage of the total RAM usage of all nodes, a new cloud server should be ordered.

  • Blocked servers: With this, you can block Hetzner servers to prevent them from being ordered. This could be useful if, for example, you want to skip small servers because they have too little performance.

"blocked_servers": [
      "cpx11",
      "cpx21"
]
  • SSH Keys: Enter the names of your license keys that you have uploaded/created in your Hetzner project.

"ssh_keys": [
    "your_ssh_key"
]
  • HAProxy Config Path: The default path to your HAProxy server config. In most cases, this path is correct by default. However, you should still verify it.

  • Maximum Online Players: Sets the limit of the maximum online players. The Wale plugin manages this value. When the server reaches the limit, a custom event is called. We will show you how to handle this here.

  • Firewall Rules: Enter your own firewall rules if necessary. They must adhere to this format:

"firewall_rules": [
    {
      "description": "Allow port 22",
      "direction": "in",
      "port": "22",
      "protocol": "tcp",
      "source_ips": [
        "0.0.0.0/0"
      ]
    },
    {
      "description": "Allow port 123",
      "direction": "out",
      "port": "123",
      "protocol": "udp",
      "source_ips": [
        "123.123.12.123/32"
      ]
    }
  ]

If you have further questions about the configuration, you can contact us via ticket support.

Last updated