Updating the Panel
This documentation covers the process for updating the panel portion of Pelican.
Updating from Pterodactyl works differently, follow Migrating from Pterodactyl instead.
Before updating, check the release notes on GitHub. See Versioning & Releases for what can change between versions.
Version Requirements
Each version of Pelican 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.
| Panel Version | Wings Version | Supported | PHP Version |
|---|---|---|---|
| 1.x | 1.x | ✅︎ | 8.5/8.4 |
Updating
You have two options for updating: use the automatic update script (recommended) or do the update steps manually.
- Docker
- Update script (recommended)
- Manual update
A Docker install updates by pulling the new image. From the directory containing your compose.yml, run:
docker compose pull
docker compose up -d
Database migrations run automatically when the new container starts.
Simply run the command below and the update script will guide you through the process:
sudo bash -c "$(curl -fsSL https://pelican.dev/update-panel.sh)"
The script checks your PHP version, extensions, and disk space and verifies the download before it touches the panel.
Your .env, storage, plugins, and database are kept, and a backup is saved to a backup_<timestamp> folder inside the panel directory.
To run it without prompts, for example from automation, pass --yes (and --dir if the panel is not in /var/www/pelican):
sudo bash -c "$(curl -fsSL https://pelican.dev/update-panel.sh)" update-panel --yes --dir /var/www/pelican
Enter Maintenance Mode
Whenever you are performing an update you should be sure to place your Panel into maintenance mode. This will prevent users from encountering unexpected errors.
cd /var/www/pelican
sudo php artisan down
Download Update
The first step in the update process is to download the new panel files from GitHub. The command below will download the release archive for the most recent version of Pelican, save it in the current directory and will automatically unpack the archive into your current folder.
curl -L https://github.com/pelican/panel/releases/latest/download/panel.tar.gz | sudo tar -xzv
To verify the archive before extracting it, download it together with its checksum.txt release asset instead:
sudo curl -fLO https://github.com/pelican/panel/releases/latest/download/panel.tar.gz
sudo curl -fLO https://github.com/pelican/panel/releases/latest/download/checksum.txt
sudo sha256sum -c checksum.txt && sudo tar -xzvf panel.tar.gz && sudo rm panel.tar.gz checksum.txt
Once the archive is downloaded and extracted we need to set the correct permissions on the cache and storage directories to avoid any webserver related errors.
sudo chmod -R 755 storage/* bootstrap/cache
Update Dependencies
sudo COMPOSER_ALLOW_SUPERUSER=1 composer install --no-dev --optimize-autoloader
Even though composer might tell you that you have outdated dependencies, do not run composer update!
Create storage symlinks
sudo php artisan storage:link
Cache components
sudo php artisan optimize:clear
sudo php artisan filament:optimize
Update Database
You'll also need to update your database schema. 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.
sudo php artisan migrate --seed --force
Themes
If you previously had any themes installed you need to manually build the panel assets again:
yarn install
yarn build
Set Permissions
The last step is to set proper ownership of the files. In most cases this
is www-data but can vary from system to system — sometimes being nginx, caddy, apache, or even nobody.
- NGINX/ Apache/ Caddy
- Rocky Linux NGINX
- Rocky Linux Apache
sudo chown -R www-data:www-data /var/www/pelican
sudo chown -R nginx:nginx /var/www/pelican
sudo chown -R apache:apache /var/www/pelican
Restart Queue Workers
After every update you should restart the queue worker.
sudo php artisan queue:restart
Exit Maintenance Mode
Now that everything has been updated you need to exit maintenance mode.
sudo php artisan up