System requirements

  • OS : Linux / Ubuntu 22.04(recommended) or higher required
  • CMake : 3.11 or higher required
  • gcc/g++ : 11.4.0 or higher required
  • ninja-build : 1.10.1 or higher required
  • fmt : 8.0.1 or higher required

  • Docker: 20.10.21 or higher required

    Note For compatibility with other operating systems, we provide Docker support to simplify the installation process.

Using Docker Container

  1. Prepare Docker Container
    Obtain prebuilt container from Docker Hub. Ensure you have a correct repository & tag name, which will be shared as part of the deployment chain.
    Example: 
     # Usage: docker pull <repository name>:<tag name>
 docker pull xcenadev/sdk:latest

    Creating docker container from Dockerfile will be supported in future.

  2. Run Docker Container
    1. Install driver on host

      Skip this step if you’re planning to run emulator

       git clone git@github.com:metisx-dev/mxdriver.git
 cd mxdriver
 ./install.sh
 reboot
    2. Run Docker Container
      To ensure compatibility with the driver, you must run the container in privileged mode. 
       docker run -it --privileged --name xcena_sdk xcena_sdk

      Note If you want to run emulator in Docker, run with KVM support, SYS_ADMIN capability, and user option (--device /dev/kvm, --cap-add=SYS_ADMIN, -e USER=$USER).
      Example:

       docker run -it --name xcena_sdk --device=/dev/kvm --cap-add=SYS_ADMIN -e USER=$USER xcena_sdk

Table of contents