Quick start

Install FeatherPanel with the installer script, create the admin account, add a FeatherWings node and start your first game server in one sitting.

This page takes you from an empty server to a running game server. It uses the defaults everywhere; the linked pages explain the alternatives.

You need:

• A Debian 11-13 or Ubuntu 22.04+ server for the panel (see Requirements).
• A second server for game servers (it can be the same machine for testing).
• A domain pointing at each server if you want HTTPS (optional for a home lab).
• Root access.

1. Install the panel

Run the installer as root:

curl -sSL https://get.featherpanel.com/installer.sh | bash

In the menus pick:

1. [1] Panel (Web Interface)
2. [1] Install Panel
3. [1] Docker Mode. Source mode exists for developers; see Source install.
4. A release type: [1] Stable Release for production.
5. An access method:

The installer installs Docker if needed, downloads docker-compose.yml to /var/www/featherpanel, starts the containers and, for nginx or Apache, writes the site config and offers a Let’s Encrypt certificate. The full walkthrough is in Docker installation.

2. Create the administrator

Wait about five minutes for the first start, then open the panel URL and register.

When the administrator opens the admin area of a fresh install, the panel sends them to the setup wizard (/setup). Its steps are:

1. Welcome: the panel URL and name.
2. Time and language: timezone and default language.
3. Mail: SMTP, optional but needed for password resets and verification mails.
4. Modules: game servers, VDS and web hosting.
5. Security basics: who can register and how admins sign in.
6. Location and node: your first location and node (the next two steps below do the same by hand).

You can choose to finish later; a banner reminds you. Everything is editable afterwards in Admin → Settings.

3. Add a location and a node

1. Admin → Locations → Create. Pick the game server type. Nodes can only be added to a location of the matching type.
2. Admin → Nodes → Create. Enter a name, the node’s FQDN (or IP), the location, whether the node uses SSL, and the memory and disk the node may hand out. Keep the daemon type FeatherWings (it cannot be changed after creation) and the ports at their defaults (API 8080, SFTP 2022) unless you have a reason.
3. Open the node’s Wings configuration. The Quick setup box shows two commands.

4. Install FeatherWings on the node

On the game node, run step 1 (it installs FeatherWings only):

curl -sSL https://get.featherpanel.com/installer.sh | env FP_COMPONENT=wings FP_ACTION=install FP_WINGS_SKIP_CONFIGURE=true bash

Then run step 2, the setup wizard, exactly as the panel shows it. It looks like this:

featherwings configure --join-data '<value from the panel>' --override --install-service

The wizard connects to the panel, checks DNS, issues an SSL certificate when the node needs one, writes /etc/featherpanel/config.yml and starts the featherwings service. Back in the panel the node turns green within a few seconds. Details and the manual path are in Install Wings.

5. Add allocations

Open the node’s Allocations tab and add the IP and ports that servers may use, for example 0.0.0.0 with ports 25565-25575.

6. Create a server

1. Admin → Servers → Create.
2. Pick the owner, the node, an allocation, a realm and spell (FeatherPanel’s names for nest and egg), and the CPU, memory and disk limits.
3. Save. Wings pulls the Docker image and runs the install script; follow it on the server’s console.

Open Servers in the user area, start the server and connect.

Next steps

• Put the panel behind HTTPS: Web server and SSL.
• Coming from Pterodactyl? Migrate from Pterodactyl.
• Set up mail so password resets work: Notifications and mail.
• Back up the panel: Panel backups.
• Offer web hosting: Install FeatherQuilld.