Back up your server before an update

An update can fail halfway. With a backup made just before it, you can go back in minutes. This guide uses Pterodactyl as the example, but the same four parts (database, configuration with secrets, application files, data) apply to most web apps.

Store the backup on another machine, not only on the server itself: a backup on the same disk is gone when the disk or the server is.

What to back up#

Check your own paths: the data folder of Wings is the data setting under system in /etc/pterodactyl/config.yml.

Back up the panel#

Run these on the panel server. The commands below write to /root; use any folder only root can read.

1. Put the panel in maintenance mode, so nothing changes during the backup:

   Copier

   cd /var/www/pterodactyl
   sudo php artisan down
   

2. Dump the database:

   Copier

   sudo mysqldump --single-transaction --routines --triggers --result-file=/root/panel-backup.sql panel
   

   If your database is not called panel, look it up in .env without showing the rest of the file:

   Copier

   sudo grep '^DB_DATABASE=' /var/www/pterodactyl/.env
   

   If the command asks for a password, add -u root -p (or the database user from .env).

3. Copy the .env file:

   Copier

   sudo cp /var/www/pterodactyl/.env /root/panel-backup.env
   

4. Pack the panel folder:

   Copier

   sudo tar -czf /root/panel-backup-files.tar.gz -C /var/www/pterodactyl .
   

5. Protect the files, because they contain passwords:

   Copier

   sudo chmod 600 /root/panel-backup.sql /root/panel-backup.env /root/panel-backup-files.tar.gz
   

6. Copy them to another machine, for example with scp from your own computer:

   Copier

   scp root@your-server:/root/panel-backup* .
   

   If you cannot log in as root, first copy the files to your own user's home folder on the server with sudo cp, give them to your user with sudo chown, and copy them from there. Delete that extra copy afterwards.

Leave the panel in maintenance mode if you go on with the update. Otherwise, run sudo php artisan up.

Back up the server data on a node#

The files of game servers change while the servers run. For a consistent copy, stop the servers first (in the panel, or tell your players), or make the copy at a quiet moment.

1. Copy the Wings configuration:

   Copier

   sudo cp /etc/pterodactyl/config.yml /root/wings-config.yml
   sudo chmod 600 /root/wings-config.yml
   

2. Pack the server data. This keeps the owner and rights of every file:

   Copier

   sudo tar -czf /root/wings-volumes.tar.gz -C /var/lib/pterodactyl volumes
   

   This can be large. Check the free space first with df -h and the size of the data with sudo du -sh /var/lib/pterodactyl/volumes. If there is not enough room, write the archive straight to another disk or machine.

The panel's own backups (on the Backups tab of each server) are stored by Wings in /var/lib/pterodactyl/backups by default, or in S3 storage if you set that up. They are useful, but they are not a copy of the whole node.

Put the panel back#

Do this if an update failed and you want to return to the state of the backup.

1. Put the panel in maintenance mode: sudo php artisan down (if that fails, go on).

2. Put back the panel files. Move the broken folder aside instead of deleting it:

   Copier

   sudo mv /var/www/pterodactyl /var/www/pterodactyl-broken
   sudo mkdir /var/www/pterodactyl
   sudo tar -xzf /root/panel-backup-files.tar.gz -C /var/www/pterodactyl
   

3. Put back the .env:

   Copier

   sudo cp /root/panel-backup.env /var/www/pterodactyl/.env
   

4. Put back the database. To get exactly the state of the backup, empty the database first, so tables that a failed update added are gone too. The database user keeps its rights:

   Copier

   sudo mysql -e 'DROP DATABASE panel; CREATE DATABASE panel;'
   sudo sh -c 'mysql panel < /root/panel-backup.sql'
   

5. Set the owner, clear the caches, restart the queue worker and leave maintenance mode:

   Copier

   cd /var/www/pterodactyl
   sudo chown -R www-data:www-data /var/www/pterodactyl/*
   sudo php artisan view:clear
   sudo php artisan config:clear
   sudo php artisan queue:restart
   sudo php artisan up
   

Put the server data back on a node#

1. Stop the game servers you restore, and stop Wings:

   Copier

   sudo systemctl stop wings
   

2. Unpack the archive in place:

   Copier

   sudo tar -xzf /root/wings-volumes.tar.gz -C /var/lib/pterodactyl
   

3. Start Wings again:

   Copier

   sudo systemctl start wings
   

Files from the archive overwrite the current ones, but files that were added after the backup stay. To get back exactly the state of the backup for one server, move its folder aside first.

Test your backup#

A backup you have never restored is a guess. Once in a while, restore it on a test machine and check that the panel starts and shows your servers.

Next: update Pterodactyl Panel and Wings.