RTLS Studio - Docker

Newly, ready-made Docker container with RTLS Studio 2.3 is available for selected early adopters.

There are two ways to run Docker container depending on Windows version. 

Firstly please check the version in Windows settings → System → About.

Windows 10 (1909 and below)

Docker for this version of Windows uses Hyper-V functionality which is available only for Pro, Education and Enterprise edition. This means that Docker won't run on Home Windows 10 edition.

By following this guide and installing Docker on this version of Windows you will enable Hyper-V feature which causes that VirtualBox won't be able to run. If you want to run Docker and VirtualBox at the same time, consider updating Windows 10 to version 2004 and use second option for installing Docker.

Install Docker for Windows

  1. Download installer from: https://hub.docker.com/editions/community/docker-ce-desktop-windows/
  2. Run installer
  3. Check "Enable Hyper-V functionality"
  4. Install Docker and reboot PC

Turn on file sharing in Docker

  1. Run Docker Desktop app
  2. Open Docker setting
  3. Go to the Resources → File Sharing
  4. Add root directory of drive where you will store file of RTLS Studio. In case you have files on drive C you need to share this drive.
  5. Apply and restart.

Windows 10 (2004 and above)

This tutorial runs on all editions of 64 bit Windows 10

Install Docker for Windows

  1. Download installer from: https://hub.docker.com/editions/community/docker-ce-desktop-windows/
  2. Run installer
  3. Check "Enable WSL 2 Windows Feature"
  4. Install Docker and reboot PC
  5. If you see alert like in picture below, then follow optional step Install WSL 2 kernel.

Optional: Install WSL 2 kernel

  1. Download kernel from: https://aka.ms/wsl2kernel
  2. Install downloaded file
  3. Reboot PC

Check if WSL 2 is set in Docker

  1. Run Docker Desktop app
  2. Open Docker Settings
  3. See if "Use the WSL 2 based engine" is checked


Ubuntu

This guide is for Ubuntu based system. Installation was tested on Ubuntu 18.04.

Install Docker

  1. Open Linux terminal
  2. Install required packages using following commands:

    sudo apt update
    sudo apt install gnupg2 pass docker.io docker-compose
  3. Start Docker service and set to automatically start after system boot.

    sudo systemctl enable docker.service 
    sudo systemctl start docker.service

Optional: Add user into group Docker

By processing this part you will add user into group Docker to be able to use Docker without root permissions (sudo) for the that specific user.

  1. Open Linux terminal
  2. Run following commands:

    sudo usermod -aG docker $USER
  3. Close terminal (CTRL + D)

Running RTLS Studio in Docker

This part is focused on Windows users. For Linux users it is very similar with a difference of using terminal instead of Windows command line and File Explorer.

  1. Download Docker release of RTLS Studio from Portal.
  2. Unzip downloaded archive.
  3. Contact us through ticket created by Portal to get access tokens needed to download rest of files.

  4. Move in File Explorer to unpacked folder - directory docker.
  5. Open command line by typing cmd in address line.

  6. Type in command:

    # Use your login tokens from part 3.
    docker login -u <YOUR_TOKEN> -p <YOUR_PASSWORD> registry.gitlab.com/sewio/studio/rtls-studio
    
    # Command for downloading required images
    docker-compose -f docker-compose.core.yml pull
    
    # Command for starting RTLS Studio  
    docker-compose -f docker-compose.core.yml up -d
  7. Open RTLS Studio on localhost address http://127.0.0.1.

Stopping RTLS Studio

To stop RTLS Studio in Docker run in command line from docker directory:

docker-compose -f docker-compose.core.yml down

docker-compose -f docker-compose.core.yml down -v # To clean RTLS Studio database

Known limitations

UDP sync

One of the advantages of Docker containers is that they have their own network separated from the others. Unfortunately, this feature causes that UDP broadcast cannot reach the anchors so UDP synchronization cannot work and therefore, it is necessary to use TCP synchronization.

Manager's verification of correct network configuration

RTLS Studio Manager cannot verify if the anchor has configured correct RTLS Studio IP address. This limitation is due to fact that dockerized RTLS Studio cannot access the network configuration of the host machine. The manager shows always correct network configuration in the status bar.

Firmware upgrade for bootloader v0.3

Anchors with bootloader version 0.3 or below cannot be upgraded by RTLS Studio in Docker. Firmware upgrade of anchors with these versions of bootloader uses UDP broadcast, which is blocked in docker deployment so it cannot leave the private network of Docker container.

Backup restore through GUI

Restore feature is disabled in RTLS Studio running on Docker. Restore of backup in RTLS Studio requires changes to the different services which are in Docker separated by containers, but one container does not have permission to directly modify files in another container. However, restore of backup can be done manually from the host machine.


Possible issues

Most of the issues with running RTLS Studio on Docker for Windows are caused by firewall. If you can run Studio but have problems with accessing it from the outside (e.g. anchors are not shown in Studio), try to turn off firewall in your PC.