Requirements
Proxmox VE
- Proxmox VE 8.x, reachable over its API.
- An API token Planeon can use to read cluster/node/storage inventory and manage the lifecycle (clone, start/stop, delete) of VMs in the pools you assign to it.
Control plane
Planeon's control-plane services (API, worker, web console, gateway) need:
- PostgreSQL 16 or newer — the platform's system of record.
- Redis 7 or newer — job queue, caching, and short-lived connection tokens.
- A host, VM, or Kubernetes cluster to run the control-plane services. As a starting baseline, 2 vCPU and 4 GB RAM is enough for a small deployment; size up with the number of concurrent sessions and pools you run.
Network paths
| From | To | Protocol / port | Purpose |
|---|---|---|---|
| Administrators and users | Web console | HTTPS | Operator console and self-service desktop portal |
| Administrators and users | API | HTTPS | REST API backing the web console |
| Users (browser desktop sessions) | Gateway | WebSocket (WSS) | Tunnels the browser-based desktop session |
| Gateway | guacd | Guacamole protocol, port 4822 | Proxies the browser session to the target desktop |
| guacd | Desktop VMs | RDP, port 3389 | Remote desktop protocol to the guest OS |
| Control plane | Proxmox VE API | HTTPS, port 8006 | Inventory sync and VM lifecycle operations |
Put a TLS-terminating reverse proxy in front of the web console, API, and
gateway in any production deployment. The browser desktop tunnel in
particular needs a secure context (https:// / wss://) for full
functionality, including clipboard access.
Browser support
Current versions of Google Chrome, Microsoft Edge, and Mozilla Firefox are supported for the operator console and the self-service desktop portal. For in-browser desktop sessions, Chromium-based browsers (Chrome, Edge) can additionally capture browser-reserved shortcuts (such as Ctrl+W or the Windows key) while in fullscreen and forward them to the remote desktop; sessions in Firefox work without that capture — those shortcuts stay with the browser. Ctrl+Alt+Del cannot be intercepted by a web page in any browser and is always available through a dedicated on-screen toolbar button instead.
Template operating systems
Desktop pools clone from a Proxmox VE template that you prepare. Supported guest operating systems:
- Windows 10, Windows 11
- Windows Server
- Mainstream Linux distributions, with xrdp installed for desktop sessions
Every template needs the QEMU guest agent installed and enabled so Planeon can detect the OS, configure the hostname, and check guest health during provisioning.
Next steps
Continue to the installation guides once your environment meets these requirements.