zyzz1989 / pelican-installer

Unofficial Pelican Panel installer with full automation

Pelican Installer

🚧 Pelican Panel is in beta so this script may not work if breaking changes are made, this script will also be recoded to use Docker Compose in the coming days 🚧

Welcome to the Pelican Installer repository! This installer is a hard fork of ForestRacks's Pterodactyl Installer and is specifically designed for people to easily install and set up the Pelican Panel on Debian-based or RHEL-based machines. If you encounter any issues during the installation process, our troubleshooting section has some helpful tips.

Read more about Pelican here. This script is not associated with the official Pelican Project.

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 <(curl -Ss https://raw.githubusercontent.com/pelican-installer/pelican-installer/Production/install.sh || wget -O - https://raw.githubusercontent.com/pelican-installer/pelican-installer/Production/install.sh) auto

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 that illustrates the installation process.

Features

• Automatic installation of the Pelican Panel (dependencies, database, cronjob, nginx).
• Automatic installation of the Pelican 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 Pelican project, create a Github Issue.

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	16.04	🔴
	18.04	🔴 *
	20.04	✅	8.3
	22.04	✅	8.3
	24.04	✅	8.3
Debian	8	🔴 *
	9	🔴 *
	10	✅	8.3
	11	✅	8.3
	12	✅	8.3
CentOS	6	🔴
	7	🔴 *
	8	🔴 *
Rocky Linux	8	✅	8.3
	9	✅	8.3
AlmaLinux	8	✅	8.3
	9	✅	8.3

* Indicates an operating system and release that previously was supported by this script.

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.

Production & Ops

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.

vagrant up

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

vagrant up <name>

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

• ubuntu_noble
• ubuntu_jammy
• ubuntu_focal
• debian_bullseye
• debian_buster
• debian_bookworm
• almalinux_8
• almalinux_9
• rockylinux_8
• rockylinux_9

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/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 for reference.

Sponsors ✨

I would like to extend my sincere thanks to the following sponsors for helping fund Pelican Installer's development. Interested in becoming a sponsor?

Company	About
ForestRacks	Looking for a place to host your Pelican Panel? Try out a ForestRacks VPS, ForestRacks is a US-based 5-Star hosting provider offering services globally since 2019.

Contributors ✨

We would like to thank the following contributors for their work in maintaining and creating this installer:

1. Matthew Jacob
2. Vilhelm Prytz
3. Linux123123
4. ImGreen
5. Neon
6. sam1370
7. Linux123123
8. sinjs

Copyright (C) 2018 - 2024, Vilhelm Prytz Copyright (C) 2021 - 2024, Matthew Jacob