Skip to content

Quick Start ​

Complete Installation first. The setup sections below are for panel administrators; VPS users can skip to Using Your VPS. Use only the actions available in your installed release and permitted by your host.

Open the Setup Assistant ​

Sign in as a panel administrator and open Admin > PteroCloud > Setup Assistant. Follow the checks and prompts shown by your release. Resolve missing prerequisites before accepting customer workloads.

Connect Proxmox ​

  1. Add a provider with a recognizable name and the Proxmox HTTPS endpoint.
  2. Enter the dedicated API token details and configure trusted TLS as described in Proxmox Setup.
  3. Run the connection test and review permission warnings.
  4. Synchronize the provider to refresh panel inventory, then select or import the nodes you intend to use where the setup interface offers that action.

Synchronization updates inventory; it does not automatically assign existing VMs to customers. To manage an existing VM, use the separate import guidance if supported by your release.

Prepare Resources ​

  • Create or select a location for the service.
  • Check that the chosen storage is online and has adequate free capacity.
  • Configure the intended network bridge and an IP pool using addresses assigned to you.
  • Check the subnet, gateway and reserved addresses with your network provider; never use documentation example addresses for a live service.
  • Make a supported OS image available for the selected location and storage.
  • Review the provisioning defaults offered by the Setup Assistant.

Create a Plan ​

Define the CPU, memory and disk resources you intend to offer. Review any network or additional-resource limits exposed by your release before making the plan available.

For a test, a plan might offer 2 vCPU, 4 GB RAM and a 40 GB disk, provided the image requirements and your infrastructure allow it. These are example values, not sizing recommendations or guarantees of available capacity. See Plans.

Create and Verify a Test VPS ​

Use a non-production account or test workload. Create the VPS through the action offered by your release, selecting the intended owner, plan, location and OS image. If customer creation is not enabled, the panel administrator or host must arrange it.

  1. Submit the request once and follow its task.
  2. Confirm that the VPS appears in the correct customer's account with the expected resources.
  3. Check boot, networking and an available console or SSH connection.
  4. Verify that ordinary controls are visible only to the intended user and permissions.

From the panel directory, the administrator can check setup and service health:

bash
php artisan pterocloud:setup:verify
php artisan pterocloud:health

Review remaining warnings. Do not retry a failed creation until you have checked whether the original VPS exists. Use Troubleshooting if needed.

Using Your VPS ​

Sign in to your host's panel and open the assigned VPS. Use only the controls available to your account; their availability depends on the installed release, your plan and host permissions. Keep backups before any destructive operation. Contact your host for unavailable plans, missing access or failed operations.

Documentation and setup guides for Krapple Studio products.