-
-
Notifications
You must be signed in to change notification settings - Fork 41
Installation
This comprehensive guide walks you through setting up Pyrodactyl using Docker, from scratch to a fully functional system.
Important
For Pyrodactyl-specific issues, please use Pyrodactyl GitHub Discussions instead of Pterodactyl or Pelican support channels.
Warning
Always make sure you take a backup of your Pterodactyl database and other relevant data.
If you already have Pterodactyl running in Docker, simply update your panel image in your docker-compose.yml file:
-image: ghcr.io/pterodactyl/panel:latest
+image: ghcr.io/pyrohost/pyrodactyl:mainYou can swap back whenever you'd like.
Note
The latest NodeJS LTS is required to be installed to migrate.
If you have Pterodactyl running without Docker, follow the manual Pterodactyl updating guide. However, on the Download the Update step, use these commands instead:
git clone https://github.com/pyrohost/pyrodactyl.git /var/www/pterodactyl --depth=2
npm ci && npm run ship
chmod -R 755 storage/* bootstrap/cache/- Linux system with root access
- Docker expertise and basic system administration skills
-
Docker Engine and Docker Compose installed
- Consider Portainer for easier Docker management
- Avoid using Snap-based Docker installations on Ubuntu
- Enable Docker auto-start on boot
Note
Windows is currently only supported for development purposes.
-
Download and configure the docker-compose.example.yml
- Modify placeholder variables under
x-common - Adjust exposed ports if needed
- Modify placeholder variables under
-
Create a new folder (e.g.
pyrodactyl-panel) on your server in a safe location, and move or upload your edited compose file into it. Rename the file todocker-compose.yml -
In terminal,
cdinto the directory, and run the following command to start the panel:docker compose up -d
-
Run the command below, and go through its prompts to create an admin user:
docker compose exec panel php artisan p:user:make -
Check that the panel is accessible using the IP address or domain of your server
-
Access the panel via your server's IP/domain and login to your previously created user
-
Navigate to admin panel (three dots menu → Admin)
-
Navigate to Locations, make a new location. It can have any name
-
Navigate to Nodes, create a new node
-
FQDN is the domain or IP address (if you're not using HTTPS) of the server you're going to use as a backend
-
You should make sure the daemon ports are free on your backend server
-
-
On the new node, go to the:
-
Configuration tab: Copy the contents to
/etc/pterodactyl/config.ymlon your backend server -
Allocation tab: Add some allocations to use for your servers. The IP should be
0.0.0.0. If you want to show a different IP in the UI (e.g. a subdomain), add an alias. You can input a range of ports like25565-26000
-
Configuration tab: Copy the contents to
In addition to the Pyrodactyl panel, you'll need Pterodactyl Wings as a backend for your servers, which we will also use Docker for. You can have multiple Wings instances on different servers, but for now, we're setting up just one.
-
Run the commands below to setup the compose for Wings:
mkdir pyrodactyl-wings && cd pyrodactyl-wings wget https://github.com/pterodactyl/wings/raw/develop/docker-compose.example.yml -O docker-compose.yml
-
Run the following command to start Wings:
docker compose up -d -
Verify Wings status:
docker ps | grep wings
For user password reset emails, etc, you'll need an SFTP server. For this, you can use:
Configure in Admin Panel → Settings
If you're planning to have your server publicly accessible, your server could be vulnerable to DDoS attacks. Although not covered here due to its complexity, consider using:
The goal is to not have your server's IP address on any of your known domains.
If issues arise:
- Test with vanilla Pterodactyl by changing panel image to
ghcr.io/pterodactyl/panel:latest - Debug issues
- Switch back to Pyrodactyl image when resolved