Requirements
To ensure a smooth and fully functional installation of the NuvlaBox Engine (NBE), please make sure you comply with the following system requirements.
OS Requirements
The NuvlaBox Engine is compliant with any OS that officially and fully supports Docker. We recommend one of the following:
- Ubuntu
- CentOS
- Debian (and Debian variants like Raspbian and Raspberry Pi OS)
Other Docker-compliant Linux distributions should also work, but the NuvlaBox functionality will be subject to the level of Docker support the OS provides.
Functionalities like the automatic discovery and categorization of peripherals are not ensured for macOS and Windows.
Hardware Requirements
In order to install the NBE and ensure its smooth execution over time, your device should have at least:
- 1GB of RAM
- 2GB of free disk space
Software Requirements
Before you can install the NBE, please make sure you have:
- Docker Engine (version 18 or higher), running in Swarm mode
- Docker Compose (version 1.27.4 or higher)
Network Requirements
You need an internet connection.
The NBE requires the following ports to be opened:
Port | Reason |
---|---|
3636 | Used by the system-manager to publish the internal NB dashboard |
5000 | Used by the compute-api as the relay endpoint for Docker |
5001 | Used by the management-api for the NB remote management REST API |
1194 | (optional) outgoing UDP connections to vpn.nuvlabox.com must be allowed on this port in case you’d like to remotely connect to the edge device, via the VPN Client |