Installation
Before you start
- Make a backup of your panel folder (usually
/var/www/pterodactyl) and its database. The installer keeps its own backup of the files it replaces, but a full backup is always wise. - Check you're on Pterodactyl 1.15.x: it's shown at the bottom of the admin area.
- You need Node.js 22 or newer and Yarn, like any panel build. Check with
node -vandyarn -v; if Yarn is missing, runnpm i -g yarn.
Install
- Download
bramble-1.0.0.zipfrom BuiltByBit and upload it to the panel's server. - Unzip it and run the installer, pointing it at your panel folder:
unzip bramble-1.0.0.zip
cd bramble-1.0.0
bash install.sh /var/www/pterodactyl
- When it says Bramble 1.0.0 installed, hard-refresh the panel in your browser (Ctrl+Shift+R).
- Open Admin → Theme to make it yours.
The installer:
- backs up every file it replaces to
.bramble-backup/in the panel folder - copies the theme in
- adds the three font packages
- builds the panel (
yarn build:production, a minute or two) - clears Laravel's caches
Note: run it as the user that owns the panel files (often
www-data), or fix ownership afterwards withchown -R www-data:www-data /var/www/pterodactyl.
Updating Bramble
Unzip the new version and run its install.sh the same way. Your settings are kept (they're in the database), and the backup still holds Pterodactyl's original files.
Updating Pterodactyl
A Pterodactyl update replaces the panel's files, which removes the theme. After updating Pterodactyl, run Bramble's install.sh again. Before updating to a new major Pterodactyl version, check the changelog or our Discord to see whether that version is supported yet.
Uninstalling
bash uninstall.sh /var/www/pterodactyl
This puts every original file back and rebuilds the panel. Your Bramble settings stay in the database in case you reinstall. To remove them too, including the encrypted billing API key, run this in your panel's database:
DELETE FROM settings WHERE `key` LIKE 'bramble::%';
Troubleshooting
| Problem | Fix |
|---|---|
| "No Pterodactyl panel found" | Pass the right folder: the one with the artisan file in it. |
| "This theme is made for Pterodactyl 1.15.x" | You're on a different version. Installing anyway may work but isn't supported. |
| The build runs out of memory | Run export NODE_OPTIONS=--max-old-space-size=4096 and install again. |
| The panel looks unchanged | Hard-refresh the browser (Ctrl+Shift+R), and clear any Cloudflare cache. |
| A white page after installing | Run php artisan view:clear && php artisan route:clear in the panel folder, and check storage/logs. |