System requirements
Hardware, operating system and network requirements for the Orchestrator, the Robot, Studio and the Python SDK.
This page lists what each VeloPhex component needs. Check it before you install anything.
Orchestrator (on-premises)#
The Orchestrator ships as one container image and runs with Docker Compose on a single host.
| Resource | Minimum |
|---|---|
| Operating system | Linux x86-64 |
| CPU | 4 vCPU |
| Memory | 8 GB RAM |
| Disk | 40 GB, plus the space your published packages need (each package version is stored once) |
| Container runtime | Docker Engine 27 or later with Compose v2 (docker compose version) |
| Database | PostgreSQL 18, either the container in the Compose stack or a managed PostgreSQL 18 with the pg_trgm extension allowed |
| Cache | Redis (bundled container). If only Redis is down, the Orchestrator keeps working in a degraded state |
A Windows Server host with Docker Desktop works for an evaluation, not for production.
Network for the Orchestrator#
- One DNS name for the Orchestrator, for example
orchestrator.example.com, pointing at the host. - TCP 443 reachable from users, Studio and every Robot.
- TCP 80 reachable from the internet if you want the bundled Caddy to obtain a Let's Encrypt certificate automatically. For an internal name, use Caddy's internal CA or your own certificate instead.
- Outbound SMTP from the host if you want invitation and notification email. Without it, invitation links are written to the api log.
Blob storage#
Package files live in one of:
- a local folder on the host (the
velophex_datavolume), - an S3-compatible bucket (AWS S3, MinIO, Cloudflare R2, Wasabi, Ceph RGW),
- an Azure Blob Storage container.
The choice cannot change once the store holds files, so decide before you publish the first package.
Robot#
| Resource | Requirement |
|---|---|
| Operating system | 64-bit Windows 10, Windows 11, or Windows Server 2019 or later |
| .NET | None to install; the Robot is self-contained |
| Disk | About 350 MB for the program files, plus the package cache and per-attempt work folders under %ProgramData%\VeloPhex\Robot |
| Free space | At least 1,024 MiB free beyond twice the size of the package being prepared, or the Robot refuses the job with DISK_FULL |
| Account | Local administrator rights to install and enrol. The service runs as LocalSystem; unattended jobs run as a robot account (a standard Windows user is enough) |
| Identity | A unique Windows MachineGuid. Sysprep cloned images, or every clone enrolls as the same machine |
Network for the Robot#
- Outbound HTTPS (443) to the Orchestrator's public address, directly or through an HTTP proxy. The Robot never needs an inbound port.
- By default the Robot uses the machine's WinHTTP proxy (
netsh winhttp show proxy). You can set an explicit proxy, a bypass list and proxy credentials withVeloPhex.Robot.Service.exe configure --proxy .... - Because the service runs as LocalSystem, the proxy settings a person sees in a browser on the machine do not apply to it.
- Python automations restore their packages with
uvand may need access to a Python package index.
Desktop and browser automation#
- UI automation needs an interactive Windows session: the signed-in person's desktop for attended runs, or a console or RDP session of the robot account for unattended runs.
- Browser automation needs Microsoft Edge or Google Chrome with the VeloPhex extension, plus the browser host that Setup installs by default.
Studio#
| Resource | Requirement |
|---|---|
| Operating system | Windows 10 version 1809 (build 17763) or later, Windows 11, or Windows Server 2019 or later, x64. ARM64 is not supported |
| .NET | None to install; Studio is self-contained |
| Account | Local administrator rights to install; Studio is installed for all users together with the Robot |
| Disk | Space for the package cache in %USERPROFILE%\.velophex\packages |
| Long paths | Recommended: enable the Enable Win32 long paths policy for deep project folders |
Studio runs and debugs workflows through the Robot's User Host on the same machine, so it is always installed with the Robot (the Developer profile). It needs HTTPS access to the Orchestrator to sign in and publish. It does not need internet access to create and run projects that use the core activity packs, because Setup installs an offline activity feed.
Python SDK#
| Resource | Requirement |
|---|---|
| Python | CPython 3.12 exactly (==3.12.*) |
| Tooling | uv to create the environment and write uv.lock |
| Dependencies | pydantic, httpx, typer (installed with the SDK); cryptography only if you sign packages |
On the Robot, the Python runtime is a separate component, offered only by Setup builds that include it. Setup downloads it during the install (or takes it from an offline layout), and it brings its own CPython 3.12 and uv. The Robot prepares each automation's environment from uv.lock.
Next steps#
- Choose where to run the Orchestrator in Deployment options.
- Plan firewall rules with Network and firewall.
- Size a larger installation with Sizing guidance.
Orchestrator (on-premises)
Network for the Orchestrator
Blob storage
Robot
Network for the Robot
Desktop and browser automation
Studio
Python SDK
Next steps