🛳️Adding a node

Learn how to create a node for servers to be deployed to.

Introduction

In order to create subservers, you need to have nodes configured. Each node can have a configurable amount of servers running at the same time. A node can be the same machine that you host your BungeeCord on, or any other machine connected to the internet.

Instructions

Download Docker

For PlayerServers to be created, you need to have Docker installed on each of your nodes.

For a quick install of Docker CE, you can execute the command below:

curl -sSL https://get.docker.com/ | CHANNEL=stable bash

Alternative approach

If you have issues with the command above, you may want to try the following one as well (Debian based systems only):

sudo apt install docker.io

If you would rather do a manual installation, please reference the official Docker documentation for how to install Docker CE on your server. Some quick links are listed below for commonly supported systems.

• Ubuntu

• CentOS

• Debian

Start Docker on Boot

If you are on an operating system with systemd (Ubuntu 16+, Debian 8+, CentOS 7+) run the command below to have Docker start when you boot your machine.

systemctl enable --now docker

Download Daemon

In order to create a node, you'll need to download the latest Daemon.

6MB

PlayerServersDaemon.zip

archive

Download the latest daemon (shipped with v3.1-RC1)

After downloading it, put it in a separate folder and extract it, preferably out of your BungeeCord folder. This is not a plugin, but a separate software made for handling server requests.

Now run the Daemon with the following command:

Command to start Daemon

java -Xmx500M -jar PlayerServeshersDaemon.jar

After running it, type exit to stop your Daemon.

Now, edit your config.toml generated inside Daemon folder to your preference and make sure to use the same token as in config.toml when creating a new node.

Create node in-game

The last step would be to add the node to PlayerServers. To do so, type the following command:

/psadmin node create <nodename> <ip> <port> <minPort> <maxPort> <maxOnline> <token>

• NodeName is any name you want to give to your node

• IP is the ip of the machine the node is located on

• Port is the port, configurable in config.toml of your Daemon.

• MinPort and MaxPort represent the port range in which your servers are going to be created on. For example, if you put 30000 and 30100 as min and max port respectively, your servers will get a random port between those two numbers when created on this node.

• MaxOnline is the max number of online instances at once on this node.

• Token is the token configured in Daemon's config.toml

If everything was done correctly, your node is ready to start accepting new subservers. However, make sure to have at least one template configured for it (default). Learn more below on how to do so.