Skip to content

Installation ​

Installation is a panel-administrator task, not a VPS-user task. Read the Requirements and the instructions included with your exact release before running any installer.

Before You Start ​

  1. Obtain your customer package and valid license through Krapple Studios.
  2. Confirm that the release supports your panel, PHP, Blueprint and Proxmox versions.
  3. Install any PHP loader required by that release for both web and command-line PHP.
  4. Back up the panel database, files and configuration, and verify your restore procedure.
  5. Schedule a maintenance window and avoid overlapping installation with active VPS operations.

Store backups and unpacked release files outside the public web directory. A panel backup is not a backup of the data inside your VPSs.

Customer Release Installer ​

If your supplied customer release includes this installer, run it from the trusted release directory using the panel path for your server:

bash
sudo bash /path/to/customer-release/install.sh --panel /var/www/pterodactyl

Replace both example paths as needed. Enter the license key at the installer's prompt, not on the command line, where it may appear in shell history or process listings. Never post the key in a ticket or public log.

Use only the options documented for your release. Do not substitute an installer from a source repository or assume that another release uses the same procedure. If a prerequisite check fails, resolve it before continuing.

Blueprint Package ​

Use this method only when your release instructions supply pterocloud.blueprint and direct you to install it with Blueprint. Make the package available as those instructions describe, then run from the panel directory:

bash
blueprint -install pterocloud

The package identifier is lowercase. Do not run both installation methods unless your release explicitly requires it. Follow its licensing and service setup steps.

After Installing ​

Confirm that the release's queue workers, scheduler and any required console service are running. From the panel directory, using the PHP executable and service account specified by your installation, run:

bash
php artisan pterocloud:compatibility
php artisan pterocloud:verify
php artisan pterocloud:health

Review failures and warnings rather than assuming installation is complete. Initial provider and resource setup may still be needed; continue in Admin > PteroCloud > Setup Assistant and follow Quick Start. Navigation and available actions vary by release and permissions.

If Installation Fails ​

Keep the installer error and log location. Do not repeatedly rerun an installer, remove data or change permissions broadly without checking the release guidance. See Troubleshooting or contact [email protected] with reviewed, private diagnostics. Never send license keys, passwords, API tokens or unredacted configuration files.

Documentation and setup guides for Krapple Studio products.