top of page

Installing Xtreme1 using Docker — A Beginner’s Guide

Updated: Nov 30, 2022

Xtreme1 is the next gen platform for Multisensory Training Data. After going open source, we’ve been praised by many engineers and have been inspired to share the knowledge of how to contribute to our project. Please support us by “starring” our GitHub repo:

Since going open source, we found some people in our community are not familiar with Docker installation. In this guide we’ll learn step-by-step how to install Xtreme1 on your computer.

You can find our 3 minutes video guide here:

The first step before contributing to Xtreme1 is learning how to use Xtreme1. This guide will be part of a series of Xtreme1 tutorials. Stay tuned for our future releases covering the latest features.

1. Installation Environment Requirements

a. Hardware

  • Mac, Windows and Linux systems are supported

  • It is recommended to use an AMD64 or ARM64 CPU with more than 2GB of memory and 10GB of available hard disk space

b. Software

2. Download the Installation Package

Click Code -> Download ZIP in the Xtreme1 GitHub repository to download; unzip the package in your computer’s file explorer.

Or download and unzip through the terminal:

unzip -d xtreme1-v0.5.1

3. Installation

Run the command prompt (Win+R) or macOS terminal.

Then change directory to the unzipped file directory and execute the following line in your command prompt to start all services:

Docker compose up

compose up terminal command result
What you should see after executing ‘Docker compose up’

On the Container page of Docker, there are 6 images including front end, back end, MySQL, Redis, Minio, and Nginx. When all images are running, this means that installation has been successful.

successful installation image
All 6 images should be in ‘running’ status

Visit the following address to enter the Xtreme1 platform (Chrome browser recommended)


Register, sign in then proceed to the ‘Dataset’ page

Dataset Page
Dataset Page

The Xtreme1 platform has been successfully installed through Docker. Feel free to play around with the datasets.

4. Additional Notes

Some Docker images, such as MySQL, do not natively support ARM architecture (such as Apple’s M1 chip). If your computer is using an ARM CPU, you need to add the following content to docker-compose.override.yml:

platform: linux/amd64

Model services can only be enabled on Linux servers with NVIDIA Driver and NVIDIA Container Toolkit and must have Nvidia Tesla T4 or similar Nvidia GPU.

Enter the following in Command Prompt to download and start the image related to the model:

docker compose -- profile model up

Be sure to install the official Nvidia Driver and Nvidia Container Toolkit.

In our next blog, we will introduce 2D & 3D fusion annotation for the Xtreme1 platform. Stay tuned!

Please support us by “starring” our GitHub repo:

Join our community! Xtreme1’s Slack channel:

206 views0 comments
bottom of page