Prerequisites¶
Complete the checks on this page before installing any component. Each check takes a few seconds and prevents the most common installation failures.
Hardware¶
Requirements depend on the deployment profile. A standalone deployment runs all components on one machine and therefore requires more resources than a single component in a central deployment.
| Resource | Minimum | Recommended |
|---|---|---|
| CPU cores | 2 | 4 or more |
| Memory | 4 GB | 8 GB or more |
| Free disk space | 20 GB | 50 GB or more |
Disk space requirements increase with the volume of data loaded. The supplied database dump alone requires approximately 10 GB once restored. Where the assistant features are enabled, allow additional memory for the model runtime.
Operating system¶
| System | Supported versions |
|---|---|
| Linux | Ubuntu 20.04 or later, Debian 11 or later, RHEL 8 or later |
| Windows | Windows 10 or 11 with WSL2, Windows Server 2019 or later |
| macOS | macOS 11 or later |
Linux is recommended for permanent installations. Windows and macOS are supported for evaluation and development.
Software¶
Docker Engine and the Docker Compose plugin are required. No other software needs to be installed on the host; all components run in containers.
| Software | Minimum version | Recommended |
|---|---|---|
| Docker Engine | 20.10.0 | 24.0.0 or later |
| Docker Compose plugin | 2.0.0 | 2.20.0 or later |
Verification steps¶
Confirm Docker is installed and running¶
docker --version
docker compose version
docker info
The first two commands must report versions meeting the minimums above. The third must complete without error; a permission or connection error indicates that the Docker service is not running or that the current user lacks access to it.
On Linux, if docker info reports a permission error, add the account to the docker
group and start a new session:
sudo usermod -aG docker "$USER"
Note that docker compose with a space is the current form. The older docker-compose
command may be present but is not covered by these instructions.
Confirm the required ports are free¶
Each component requires specific ports. Check those for the components being installed, as listed in Hosts and ports.
On Linux:
ss -tulpn | grep -E ':(5444|8002|48000|8060|4447|8468)'
On Windows:
netstat -ano | findstr ":5444 :8002 :48000 :8060"
No output means the ports are free. Any output identifies a process already using a required port; either stop that process or change the port assignment, recording the change for use when configuring the remaining components.
Confirm available disk space¶
On Linux:
df -h /var/lib/docker
On Windows and macOS, check available space on the volume holding the Docker data directory, as reported in Docker Desktop under Settings, Resources.
Confirm connectivity, central deployments only¶
From the machine where components will be installed, confirm that the shared infrastructure is reachable. Substitute the current addresses from Hosts and ports.
nc -zv DATA_HOST 5432
nc -zv DATA_HOST 1883
curl -sSf https://cvdlink.simavi.ro/auth/realms/cvdlink/.well-known/openid-configuration > /dev/null && echo "Keycloak reachable"
A failure here indicates a firewall or routing problem that must be resolved before installation, not a problem with CVDLink.
Docker network¶
Components communicate over a shared Docker network, which must exist before the first component starts. Create it once per machine:
docker network create cvdlink-net
If the network already exists, Docker reports an error that can be disregarded.
Confirm it exists:
docker network ls | grep cvdlink-net
Credentials and files required¶
Obtain the following before beginning, as installation cannot be completed without them.
- The database dump file, for standalone deployments
- Database credentials for the environment being installed
- A Django secret key, generated as described in the Metadata installation
- Keycloak client configuration, for central deployments
- Component images, either from the project registry or as exported archives for installations without registry access
Next steps¶
Once every check above passes, proceed to Database installation. Components must be installed in the order given on the documentation home.