Installation | Pterodactyl

# cloudflare specific configuration

If you’re using Cloudflare’s Flexible SSL you should set TRUSTED_PROXIES to contain their IP addresses(opens new window).
Below is an example of how to set this.

# database updates

You’ll also need to update your database schema for the newest version of Pterodactyl. Running the command below
will update the schema and ensure the default eggs we ship are up to date (and add any new ones we might have). Just
remember, never edit core eggs we ship! They will be overwritten by this update process.

# exit maintenance mode

Now that everything has been updated you need to exit maintenance mode so that the Panel can resume accepting
connections.

Final Step: Upgrade Wings

# installing nodejs

NodeJS is also super easy to install! Simply run the command below to make the package accessible to your system.

# manual upgrade

If you prefer not to perform the automatic self-upgrade, or need to reference any upgrade steps you can follow
the documentation below.

# nginx specific configuration

For Pterodactyl to properly respond to an NGINX reverse proxy, the NGINX location config must contain the following lines:

# panel version requirements

Each version of Pterodactyl Panel also has a corresponding minimum version of Wings that
is required for it to run. Please see the chart below for how these versions line up. In
most cases your base Wings version should match that of your Panel.

# self upgrade

If your version of Pterodactyl Panel is 1.3.2 or higher, you can simply run the following command to perform a
self-upgrade of the Panel. This will download all of the necessary files and perform all of the actions listed
in this upgrade documentation.

Note: You must have php-posix extension for the self-upgrade to detect file ownership.

Final Step: Upgrade Wings

# start docker on boot

If you are on an operating system with systemd (Ubuntu 16 , Debian 8 , CentOS 7 ) run the command below to have Docker start when you boot your machine.

# using s3 backups

AWS S3 (or compatible storage) can be used to store remote or cloud-based backups. The following configuration options have to be set in the .env file or as environment variables in order to enable it:

Contributors ✨

Copyright (C) 2022 — 2022, Vilhelm Prytz, vilhelm@prytznet.se

Created and maintained by Vilhelm Prytz.

Thanks to the Discord moderators sam1370, Linux123123 and sinjs for helping on the Discord server!

And special thanks to Linux123123 for frequently contributing to the project with bug reports, feature requests, pull requests, and more!

Features

• Automatic installation of the Pterodactyl Panel (dependencies, database, cronjob, nginx).
• Automatic installation of the Pterodactyl Wings (Docker, systemd).
• Panel: (optional) automatic configuration of Let’s Encrypt.
• Panel: (optional) automatic configuration of firewall.

Help and support

For help and support regarding the script itself and not the official Pterodactyl project, you can join the Discord Chat.

Supported installations

List of supported installation setups for panel and Wings (installations supported by this installation script).

Supported wings operating systems

* Ubuntu 16 and Debian 8 no longer supported since Pterodactyl does not actively support it.

Testing the script locally

To test the script, we use Vagrant. With Vagrant, you can quickly get a fresh machine up and running to test the script.

If you want to test the script on all supported installations in one go, just run the following.

If you only want to test a specific distribution, you can run the following.

Replace name with one of the following (supported installations).

• ubuntu_jammy
• ubuntu_focal
• ubuntu_bionic
• debian_bullseye
• debian_buster
• debian_stretch
• centos_8
• centos_7

Then you can use vagrant ssh <name of machine> to SSH into the box. The project directory will be mounted in /vagrant so you can quickly modify the script locally and then test the changes by running the script from /vagrant/install_panel.sh and /vagrant/install_wings.sh respectively.

# update dependencies

• PHP 7.4 or 8.0 (recommended)
• Composer 2.X

Previous versions of Pterodactyl allowed for you to be running PHP 7.3. However, due to dependency updates and
the fact that 7.3 is now EOL we have bumped the minimum acceptable PHP version to 7.4 — PHP 8 is recommended. You
will also need to be using Composer v2.

Before continuing, please ensure that your system and web server configuration has been upgraded to at least PHP 7.4 by running php -v and Composer 2 by running composer —version. You
should see an output similar to the result below.

# configuring recaptcha

While we provide a global Site Key and Secret Key by default, we highly recommend changing it for your own setup.

# dependencies

Pterodactyl’s Daemon requires the following dependencies be installed on your system in order for it to operate.

• Docker
• Nodejs (v10, v12, higher versions likely work, but are untested)
• node-gyp
• tar
• unzip
• make, gcc (gcc-c on CentOS), g
• python