Installing Pterodactyl Wings

Installing Docker

To install Docker using a one-liner, run the following command:

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

If you prefer to manually install Docker, follow the official Docker documentation for your OS:

• Ubuntu (opens in a new tab)
• Debian (opens in a new tab)
• CentOS (opens in a new tab)

Start Docker on Boot

To start Docker when your system starts, run the following command:

sudo systemctl enable --now docker

Enabling Swap

Docker may be unable to set up swap space on most systems. To confirm this, run docker info and look for a line that says WARNING: No swap limit support near the bottom of the output.

NOTE: Swap is not required but recommended by the Pterodactyl Team if you will be hosting for others.

To enable swap, open /etc/default/grub as the root user and find the line starting with GRUB_CMDLINE_LINUX_DEFAULT. Edit the value of swapaccount to 1, like so swapaccount=1.

Next, run sudo update-grub and sudo reboot or systemctl reboot to restart the server and enable swap.

The following line is an example of what the line should look like:

GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"

Installing Wings

Ensure you have the required directory structure. Create the following directory to ensure Wings works correctly:

sudo mkdir -p /etc/pterodactyl
curl -L -o /usr/local/bin/wings "https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_$([[ "$(uname -m)" == "x86_64" ]] && echo "amd64" || echo "arm64")"
sudo chmod u+x /usr/local/bin/wings

Configure

Once the installation of Wings and the required components is complete, you can create a node on your previously installed Panel. Go to your Panel's Administrative View, select Nodes on the left, and click Create New.

• Under the Basic details section, fill in the following fields:

  • Name: Enter a name for your node. This can be anything you like.
  • Description: Enter a description for your node. This can also be anything you like.
  • Location: This should reflect the physical location of your server, e.g., ca.bc.local.
  • FQDN: Enter the Fully Qualified Domain Name of your server. This should be the domain name that points to you server's IP address.
  • Communicate Over SSL: When using a FQDN, this should be set to Use SSL Connection. If you are using an IP address, this should be disabled.
  • Behind Proxy: If you are using a proxy, this should be set to Behind Proxy, otherwise set it to Not Behind Proxy.

• Moving to the right side under the Configuration section, fill in the following fields:

  • Daemon Server File Directory: Leave this as the default value, unless you have a specific reason to change it.
  • Total Memory: Enter the total amount of memory available on your server.
  • Memory Over-Allocation: This is the amount of memory that can be over-allocated to servers. If you wish to with to not allow over-allocation, set the value to 0. If you wish to not check for over-allocation, set the value to -1, otherwise set it to the desired amount.
  • Total Disk Space: Enter the total amount of disk space available on your server.
  • Disk Over-Allocation: The same as memory over-allocation, but for disk space.
  • Daemon Port: This is the port that Wings will use to communicate with the Panel. For SSL connections, and when using a FQDN, use 443. For non-SSL connections, you may use the default value of 8080.
  • Daemon SFTP Port: This is the port that Wings will use for SFTP connections. The default value is 2022. We recommend using the default.

After creating a node, navigate to the Configuration tab. Copy the contents of the code block and paste it into a new file called config.yml in /etc/pterodactyl, then save it.

An alternative and easier way is to click on the Generate Token button on the right of the screen and paste the command into your Wings' terminal.

Starting Wings

To start Wings, run the following command. This command starts the Wings process in debug mode. Look through the logs and ensure there are no errors. Once you have confirmed that everything is running smoothly, exit the process using CTRL+C.

sudo wings --debug

Daemonizing (using systemd)

Much like the pteroq.service we created in this guide, we will create a service for Wings.

This is done to run the service in the background. First, create a file called wings.service in the /etc/systemd/system directory:

sudo nano /etc/systemd/system/wings.service

Next, copy and paste the following block into the new file:

[Unit]
Description=Pterodactyl Wings Daemon
After=docker.service
Requires=docker.service
PartOf=docker.service
 
[Service]
User=root
WorkingDirectory=/etc/pterodactyl
LimitNOFILE=4096
PIDFile=/var/run/wings/daemon.pid
ExecStart=/usr/local/bin/wings
Restart=on-failure
StartLimitInterval=180
StartLimitBurst=30
RestartSec=5s
 
[Install]
WantedBy=multi-user.target

Then, run the following command to reload systemd and start the Wings service:

sudo systemctl enable --now wings

Node Allocations

To connect to a node in-game, you must assign an Allocation to it. This is done under the Allocation tab, still under Nodes, in the Node you created.

• IP Address: Enter the IP address of your server.
• IP Alias: This is optional and can be left blank, unless you have a FQDN for that specific IP, or multiple IPs.
• Ports: Enter the ports you wish to use for the server. The default port for Minecraft is 25565.

For more information, please see the official Pterodactyl documentation (opens in a new tab)