Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pterodactyl-installer/pterodactyl-installer
:bird: Unofficial installation scripts for Pterodactyl Panel
https://github.com/pterodactyl-installer/pterodactyl-installer
bash pterodactyl pterodactyl-installer
Last synced: 6 days ago
JSON representation
:bird: Unofficial installation scripts for Pterodactyl Panel
- Host: GitHub
- URL: https://github.com/pterodactyl-installer/pterodactyl-installer
- Owner: pterodactyl-installer
- License: gpl-3.0
- Created: 2018-07-29T12:30:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-08T20:59:43.000Z (13 days ago)
- Last Synced: 2025-01-09T06:05:25.457Z (13 days ago)
- Topics: bash, pterodactyl, pterodactyl-installer
- Language: Shell
- Homepage: https://pterodactyl-installer.se
- Size: 962 KB
- Stars: 1,464
- Watchers: 32
- Forks: 587
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# :bird: pterodactyl-installer
[](LICENSE)
[](https://pterodactyl-installer.se/discord)
[](https://www.gnu.org/software/bash/)
Unofficial scripts for installing Pterodactyl Panel & Wings. Works with the latest version of Pterodactyl!
Read more about [Pterodactyl](https://pterodactyl.io/) here. This script is not associated with the official Pterodactyl Project.
## 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.
- Uninstallation support for both panel and wings.
## Help and support
For help and support regarding the script itself and **not the official Pterodactyl project**, you can join the [Discord Chat](https://pterodactyl-installer.se/discord).
## Supported installations
List of supported installation setups for panel and Wings (installations supported by this installation script).
### Supported panel and wings operating systems
| Operating System | Version | Supported | PHP Version |
| ---------------- | ------- | ------------------ | ----------- |
| Ubuntu | 14.04 | :red_circle: | |
| | 16.04 | :red_circle: \* | |
| | 18.04 | :red_circle: \* | |
| | 20.04 | :white_check_mark: | 8.3 |
| | 22.04 | :white_check_mark: | 8.3 |
| | 24.04 | :white_check_mark: | 8.3 |
| Debian | 8 | :red_circle: \* | |
| | 9 | :red_circle: \* | |
| | 10 | :white_check_mark: | 8.3 |
| | 11 | :white_check_mark: | 8.3 |
| | 12 | :white_check_mark: | 8.3 |
| CentOS | 6 | :red_circle: | |
| | 7 | :red_circle: \* | |
| | 8 | :red_circle: \* | |
| Rocky Linux | 8 | :white_check_mark: | 8.3 |
| | 9 | :white_check_mark: | 8.3 |
| AlmaLinux | 8 | :white_check_mark: | 8.3 |
| | 9 | :white_check_mark: | 8.3 |
_\* Indicates an operating system and release that previously was supported by this script._
## Using the installation scripts
To use the installation scripts, simply run this command as root. The script will ask you whether you would like to install just the panel, just Wings or both.
```bash
bash <(curl -s https://pterodactyl-installer.se)
```
_Note: On some systems, it's required to be already logged in as root before executing the one-line command (where `sudo` is in front of the command does not work)._
Here is a [YouTube video](https://www.youtube.com/watch?v=E8UJhyUFoHM) that illustrates the installation process.
## Firewall setup
The installation scripts can install and configure a firewall for you. The script will ask whether you want this or not. It is highly recommended to opt-in for the automatic firewall setup.
## Development & Ops
### Testing the script locally
To test the script, we use [Vagrant](https://www.vagrantup.com). 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.
```bash
vagrant up
```
If you only want to test a specific distribution, you can run the following.
```bash
vagrant up
```
Replace name with one of the following (supported installations).
- `ubuntu_jammy`
- `ubuntu_focal`
- `debian_bullseye`
- `debian_buster`
- `debian_bookworm`
- `almalinux_8`
- `almalinux_9`
- `rockylinux_8`
- `rockylinux_9`
Then you can use `vagrant ssh ` 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/installers/panel.sh` and `/vagrant/installers/wings.sh` respectively.
### Creating a release
In `install.sh` github source and script release variables should change every release. Firstly, update the `CHANGELOG.md` so that the release date and release tag are both displayed. No changes should be made to the changelog points themselves. Secondly, update `GITHUB_SOURCE` and `SCRIPT_RELEASE` in `install.sh`. Finally, you can now push a commit with the message `Release vX.Y.Z`. Create a release on GitHub. See [this commit](https://github.com/pterodactyl-installer/pterodactyl-installer/commit/90aaae10785f1032fdf90b216a4a8d8ca64e6d44) for reference.
## Contributors ✨
Copyright (C) 2018 - 2025, Vilhelm Prytz, , and contributors!
- Created by [Vilhelm Prytz](https://github.com/vilhelmprytz)
- Maintained by [Linux123123](https://github.com/Linux123123)
Thanks to the Discord moderators [sam1370](https://github.com/sam1370), [Linux123123](https://github.com/Linux123123) and [sinjs](https://github.com/sinjs) for helping on the Discord server!
contributors