Blueprint's extension ecosystem you know and love, in 🐳 Docker.

🐳 Blueprint in Docker

What is the difference between docker-compose.yml and classic-docker-compose.yml?

• classic-docker-compose.yml stays as close to the stock Pterodactyl compose file as possible
  • This means it still has the obsolete "version" attribute, has no health checks, and does not use a .env file for configuration
  • This file is simpler to look at and understand, mostly because it doesn't give you the same level of control and information at the recommended docker-compose.yml file
• docker-compose.yml (recommended) can and has been improved over time
  • If you are using this version, download and configure the .env file as well; most if not all configuration can be done through the .env file

Uploading extensions

Extensions must be placed/dragged into the extensions folder.

Interacting with Blueprint

By default, you can only interact with Blueprint by going through the Docker command line, i.e.

docker compose exec panel blueprint (arguments)

We recommend setting an alias so you can interact with Blueprint the same way you would in the non-Docker version (If you have your compose file in a different place, adjust accordingly:

# Set alias for current session
alias blueprint="docker compose -f /srv/pterodactyl/docker-compose.yml exec panel blueprint"
# Append to the end of your .bashrc file to make it persistent
echo 'alias blueprint="docker compose -f /srv/pterodactyl/docker-compose.yml exec panel blueprint"' >> ~/.bashrc

Example of installing an extension

Here's a quick example showcasing how you would go about installing extensions on the Docker version of Blueprint. Note that your experience can differ for every extension.

1. Find an extension you would like to install and look for a file with the .blueprint file extension.
2. Drag/upload the example.blueprint file over/onto to your extensions folder, i.e. by default /srv/pterodactyl/extensions.
3. Install the extension through the Blueprint command line tool:

    docker compose exec panel blueprint -i example

   Alternatively, if you have applied the alias we suggested above:

    blueprint -i example

So, you installed your first extension. Congratulations! Blueprint is now keeping persistent data inside the pterodactyl_app volume, so you'll want to start backing that volume up regularly.

First, we'll install Restic to handle backups

Make a directory and script for backups

mkdir -p /srv/backups/pterodactyl
restic init --repo /srv/backups/pterodactyl
cat <<'EOF' > /srv/backups/backup.sh
#!/bin/bash

docker compose -f /srv/pterodactyl/docker-compose.yml down
restic backup /var/lib/docker/volumes/pterodactyl_app/_data --repo /srv/backups/pterodactyl
docker compose -f /srv/pterodactyl/docker-compose.yml up -d
EOF
chmod +x /srv/backups/backup.sh

Set a crontab to back up your panel (choose a time when it will be least likely to be being used)

(crontab -l 2>/dev/null; echo "59 23 * * * /srv/backups/backup.sh") | crontab -

Well, great. I have daily backups now, and they're set to keep at most 30 backups at a time. How can I restore from one of them?

You can list snapshots with restic snapshots --repo /srv/backups/pterodactyl You're looking for a value for ID that looks something like 46adb587. Time will be right next to each ID, so you can see what day your backups are from.

Once you've determined which snapshot you want to restore, stop your compose stack, restore your data, and start your stack again

docker compose -f /srv/pterodactyl/docker-compose.yml down
# Clear the directory so the restoration will be clean
rm -rf /var/lib/docker/volumes/pterodactyl_app/_data
# Remember to replace "46adb587" with your actual ID of the snapshot you want to restore
restic restore 46adb587 --repo /srv/backups/pterodactyl --target /var/lib/docker/volumes/pterodactyl_app/_data
docker compose -f /srv/pterodactyl/docker-compose.yml up -d

Updating Blueprint in Docker

Option 1: Only update Blueprint

• If you have set the alias we suggested earlier

  blueprint -upgrade

• If you have not

  docker compose -f /srv/pterodactyl/docker-compose.yml exec panel blueprint -upgrade

Option 2: Update both Blueprint and Pterodactyl Panel

• This guide operates under the assumption that individual extension/theme authors have chosen to store any persistent data such as settings in the database. If they have not done this... there isn't any specific place extension data is meant to be stored, so the data could be anywhere. You'll need to ask them if there is any persistent data stored anywhere that you have to back up before updating.
• Go to the directory of your docker-compose.yml file

• docker compose down -v

• The -v tells it to delete any named volumes, i.e. the app volume we use. It will not delete data from bind-mounts. This way the new image's app volume can take place.
• Change the tag in your panel's image (i.e. to upgrade from v1.11.5 to v1.11.7, you would change ghcr.io/blueprintframework/blueprint:v1.11.5 to ghcr.io/blueprintframework/blueprint:v1.11.7.

• docker compose pull

• docker compose up -d

• Lastly, install your extensions again. Refer to the examples.
• Blueprint will support installing multiple extensions at once in the future, making updates significantly easier. The syntax showcased was blueprint -i extension1 extension2 extension3. Documentation here will be updated when that comes out, but for now you'll have to install each extension again every update. Feel free to automate this with a simple bash script:
  • Create the script

  • cd /srv/pterodactyl && echo -e '#!/bin/bash\n\nfor extension in "$@"\ndo\n    docker compose exec panel blueprint -i "$extension"\ndone' > bulk-install.sh && chmod +x bulk-install.sh

  • The script will be located in the assumed root folder for your compose stack, /srv/pterodactyl. You can use it while in that folder with as many extensions as you want with:

  • ./bulk-install.sh extension1 extension2 extension3``

    
    
    

    $\color{#4b4950}{\textsf{© 2024 Emma (prpl.wtf) and Loki}}$