Self-hosting
Self-hosting
Run the Platinum control plane and your own sandbox hosts on machines you control.
Self-hosted Platinum runs the same API, SDKs and console on your own machines. Every sandbox is a micro-VM on a KVM host you enroll.
How it fits together
An install has two parts, on separate machines.
| Control plane | Sandbox host | |
|---|---|---|
| Runs | Postgres, migrations, the API server, Caddy (TLS), and optionally an S3-compatible store and the web console | The host agent, Cloud Hypervisor, the edge proxy, and your sandboxes |
| Installed with | Docker Compose, from infra/compose | The install command the control plane prints |
| Count | One | One or more |
Running both on one machine is not supported.
Check the requirements
| Control plane | Sandbox host | |
|---|---|---|
| CPU | linux/amd64 (the published images are amd64 only) | x86_64 with hardware virtualization exposed as /dev/kvm |
| OS | Linux with Docker Engine and the Compose plugin | Ubuntu 24.04 on bare metal |
| Network | Ports 80 and 443 reachable, a DNS name for the API | Reaches the control plane; reachable from it on :80 and :18048 |
| Other | A machine you can reboot: the installer reboots it once |
Object storage is optional for one host and needed for more. See Object storage.
Set up
- Installation: start the control plane.
- Sandbox hosts: enroll a KVM machine.
- Console: create the first account and an API key.
Reference
- Hardware: what a sandbox host needs, and how the installer uses its disks.
- Configuration: the settings in
.env. - Domains & TLS: HTTPS for the API, preview URLs and the console.
- Object storage: templates across hosts, volumes, backups.
- Building templates: the default template and your own.
Operate
- Upgrades: new versions, migrations and rollback.
- Backups: what to keep and how to restore it.
- Hardening: firewalls, sign-ups and secrets.
- Troubleshooting: match an error to its fix.