Calagopus

Appearance

Package Wings Installation ​

Please see the Minimum Requirements section in the Wings Overview documentation.

With the APT/RPM repository, you can directly install Calagopus from your package manager. Select your package manager below:

Install Docker ​

The Calagopus Wings Daemon requires Docker to be installed and running on the host machine to manage game server containers. You can validate your Docker installation by running:

bash
docker --version

If Docker is not installed, please refer to the official Docker installation guide for your operating system. In many cases running Dockers installation script is the easiest way to get started:

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

Add the repository ​

The first step to install Wings is to add the Calagopus APT repository. If the APT repository is already added, you can skip this step. To do so, on your server run theses commands:

bash
curl -fsSL https://packages.calagopus.com/pub.gpg -o /usr/share/keyrings/calagopus-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/calagopus-archive-keyring.gpg] https://packages.calagopus.com/deb stable main" | sudo tee /etc/apt/sources.list.d/calagopus.list
apt update

Install Calagopus Wings ​

Now that the repository has been added, you need to download and install the Wings package. You can do this by running the following commands:

bash
apt install -y calagopus-wings

This will download the latest version of Wings for your architecture and make it executable using calagopus-wings. To test that the installation was successful, you can run:

bash
calagopus-wings version

Add alias (optional) ​

By default, to interact with Wings, you need to add calagopus- infront of wings, which can be annoying sometimes. You can instead make a symbolic link for Wings to allow using wings instead of calagopus-wings. To do so, run theses commands:

bash
ln -s $(whereis -b calagopus-wings | awk '{print $2}') /usr/local/bin/wings

If Wings is installed somewhere else than /usr/local/bin/, make sure to replace that to the directory where Wings is installed.

Configure Wings ​

Before starting Wings, you need to configure it to connect to your Calagopus Panel. To do this, create the Node on the Panel using this guide here. Then, paste the copied configuration command into your terminal, which will look something like this:

bash
calagopus-wings configure --join-data xxxxxx

To test the configuration, you can run:

bash
calagopus-wings

This will start Wings in the foreground, and you should see it connecting to the Panel.

Install Wings as a Service ​

To ensure that Wings starts automatically on system boot, you can install it as a systemd service. Create a new service file by running:

bash
calagopus-wings service-install

This will also start the service and enable it to start on boot. To check the status of the Wings service, you can run:

bash
systemctl status wings

Node Allocations ​

Allocation is a combination of IP and Port that you can assign to a server. The allocation would be the IP address of your network interface, such as 65.20.69.420, or when behind NAT, an internal IP.

To create allocations, go to Nodes, then click on your node, and click on the Allocation tab.

Then, click on the Create button and a popup should come up:

To find the IP to be used for the allocation, type hostname -I | awk '{print $1}' on your terminal. Alternatively, you can type ip addr | grep "inet " to see all your available interfaces and IP addresses, or use 0.0.0.0 as the IP to bind all the available interfaces.

WARNING

You can use 127.0.0.1 for allocations if you don't want the server to be exposed via the internet. This is useful for internal services that are hosted locally on the same server.

The IP Alias can be set to anything, as this value is shown to the user in the console, the network tab, etc. This is useful for people who are behind NAT and/or don't want to show their IP directly.

The Port Ranges value is what you'll use to connect to your server. It can either be a single port 10000, or a range 10000-11000.

Once you're done filling theses 2-3 values, click on the Create button, and you should now be able to assign allocations to servers!