01
Operating system
Ubuntu 22.04 or newer, or Debian 12 or newer. Ubuntu 24.04 LTS is the recommended production host.
Get started
A Linux server, a domain, and the installer.
On a fresh Ubuntu or Debian server, download the installer and run it as root. The menu covers install, update, status, backup, and uninstall.
Jump to installBefore you install
What you need on the box.
02
What the installer adds
Node 20, pnpm, MariaDB, Redis with a password, nginx, and a Let's Encrypt certificate. You do not install Node yourself.
03
Game nodes
FeatherWings, with Docker, on every machine that hosts games. That can be the panel host, other machines, or both.
Install · Three steps
Run the installer on your server.
DNS first, then the two commands, then FeatherWings where the games actually run.
spirit.sh
- 01
Point DNS first
Point the panel domain at the server before you install, so certbot can issue a certificate.
- 02
Download the script, then run it
Save the installer to a file. Do not pipe curl into bash under sudo — process substitution breaks that way.
spirit.sh
curl -fsSL https:/
/ raw.githubusercontent.com/ SpiritFramework/ SpiritPanel/ main/ scripts/ spirit.sh -o / tmp/ spirit.sh sudo bash /
tmp/ spirit.sh curl -fsSL https://raw.githubusercontent.com/SpiritFramework/SpiritPanel/main/scripts/spirit.sh -o /tmp/spirit.sh sudo bash /tmp/spirit.sh
- 03
Add FeatherWings where the games run
The panel never runs game workloads. Each server is a Docker container managed by FeatherWings. One panel can use a same-box daemon and remote nodes together.
Same box
127.0.0.1:8080
nginx proxies the console websocket at /wings/.
Remote node
HTTPS hostname
Use HTTPS on that machine’s own hostname. No trailing slash on the remote URL.
API_URL in the panel environment must match the remote value in the FeatherWings config exactly: HTTPS, with no trailing slash.
After install
Keep going in the docs.
This page only gets you to the installer. Production detail, updates, and day-to-day operation live in the docs and on GitHub.