System requirements
Before installing the HyperFileLens Community control plane, an Agent, a Proxy, or a Private Data Gateway, verify that each host meets the applicable platform, resource, and runtime requirements below.
Community control plane
| Item | Minimum | Recommended |
|---|---|---|
| Operating system | Ubuntu 20.04, 22.04, or 24.04 | Ubuntu 22.04 or 24.04 |
| Architecture | amd64 | amd64 |
| CPU | 4 cores | 8 or more cores |
| Memory | 8 GiB | 16 GiB or more |
Free space on /opt | 20 GiB | 40 GiB |
| Docker Engine | 24.0.0 | 24.0.0 or later |
| Docker Compose | 2.20.0, Compose V2 | 2.20.0 or later |
The control plane is installed in /opt/hyperfilelens. The installer checks free space and reports insufficient CPU, memory, or swap. Use the recommended configuration for regular operation.
Component platforms
- Platforms
- Linux amd64/arm64, macOS amd64/arm64, and Windows amd64
- Resources
- 2 or more CPU cores, 2 GiB or more memory, and 10 GiB or more free space
- Platform
- Ubuntu 20.04, 22.04, or 24.04 on amd64
- Resources
- 2 or more CPU cores, 4 GiB or more memory, and 50 GiB or more free space
- Platform
- Ubuntu 20.04, 22.04, or 24.04 on amd64
- Resources
- 2 or more CPU cores, 4 GiB or more memory, and 50 GiB or more free space
Before installation
- The Community host has
sudoaccess andcurlinstalled. - Docker Engine is running and can start containers.
- The host can reach GitHub, the container registry, and Ubuntu package repositories.
- Hosts used for online installation or component registration can resolve the required domains, establish HTTPS connections, and keep accurate system time.
- The required paths between the control plane, components, and storage are allowed. See Network and Ports.