Skip to content

Installation

This section is the operator guide to installing, activating, verifying, upgrading, repairing and removing PteroCloud.

License activation runs FIRST

The installer verifies a valid license before it copies files, applies patches, runs migrations, registers routes, installs the console gateway or creates services. On any failure the installer stops with a normalized reason and makes no changes. There is no --skip-license.

Order of operations

Step Page What happens
1 License activation The installer gate activates/resumes the signed lease and verifies it.
2 Install the extension Files, migrations, caches and (optionally) the production stack.
3 Console gateway The dedicated WebSocket service that brokers VM consoles.
4 Verification pterocloud:verify, :health, :compatibility, :setup:verify.
5 Upgrade Safe update procedure and rollback.
6 Repair Reinstall from an official signed package.
7 Uninstall Remove the extension without touching customer workloads.

What the installer guarantees

  • Fail closed. No valid license means no install; no valid signed runtime lease means the control layer is locked. A missing class, an HTTP/JSON/ signature failure, a missing cache or an exception never results in "allowed".
  • No partial install. A failure at any gate leaves the installation unchanged.
  • Infrastructure is never collateral. Licensing never deletes or destroys customer VMs, disks, backups or IPs. Only the PteroCloud control layer locks.

Requirements at a glance

  • Pterodactyl Panel 1.x on PHP 8.2 or 8.3.
  • MySQL/MariaDB or PostgreSQL; Redis recommended.
  • A provider: Proxmox VE with an API token, or a native KVM host.

See Compatibility for how each component is judged.