Getting Started
Pelican runs on a dedicated Linux server, and the recommended way to install it is with Docker. This page gets Docker ready, then you can install the Panel.
You should have some basic familiarity with Linux before you proceed!
You don't need a fresh install. Follow Migrating from Pterodactyl to upgrade your existing Panel and keep all your data.
Requirements
Pelican runs on a wide range of operating systems, so pick whichever you are most comfortable using, as long as it supports Docker Engine.
Docker may not work under OpenVZ, Virtuozzo or LXC virtualization unless your provider has configured it for nested containers.
kvm and bare metal (none) work without issues. To check what your server uses, run:
systemd-detect-virt
If that command isn't available, sudo dmidecode -s system-manufacturer usually tells you as well.
Installing Docker
For a quick install of Docker CE, you can use the command below:
curl -sSL https://get.docker.com/ | CHANNEL=stable sudo sh
If the above command does not work, please refer to the official Docker documentation on how to install Docker CE on your server.
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.
sudo systemctl enable --now docker
Enabling Swap
On most systems, Docker will be unable to setup swap space by default. You can confirm this by running docker info and looking for the output of WARNING: No swap limit support near the bottom.
Enabling swap is entirely optional, but we recommended doing it if you will be hosting for others and to prevent OOM errors.
To enable swap, open /etc/default/grub as a root user and find the line starting with GRUB_CMDLINE_LINUX_DEFAULT. Make
sure the line includes swapaccount=1 somewhere inside the double-quotes.
After that, run sudo update-grub followed by sudo reboot to restart the server and have swap enabled.
Below is an example of what the line should look like, do not copy this line verbatim. It often has additional OS-specific parameters.
GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"
Some Linux distros may ignore GRUB_CMDLINE_LINUX_DEFAULT.
Therefore you might have to use GRUB_CMDLINE_LINUX instead should the above variable not work for you.
Next Steps
Docker is ready. Continue to Installing the Panel.
Prefer to run the Panel directly on your server without Docker? Follow the standalone install instead.