Skip to content

INSTALL.md

Latest commit

 

History

History
65 lines (58 loc) · 3.22 KB

INSTALL.md

File metadata and controls

65 lines (58 loc) · 3.22 KB

Installing MiRo Docker

Note: Follow the linked instructions provided at each step precisely.

Quality-of-Life

Ubuntu

  1. Install Docker Engine.
  2. Hardware acceleration (optional). Depending on your graphics card, install one of the following:
  3. Run the test containers (both docker and GPU, if present) to make sure the system is setup correctly.
  4. Follow the Quick Start instructions on the main README page.

Windows

Option 1.1 (recommended): Docker Desktop on Windows with WSL2 backend

The following simplified diagram represents the intended layered environment:

flowchart LR
    A["Host OS <br> (Windows 10 or 11)"] --> D["Docker Desktop <br> (Docker-WSL integration)"]
    B --> C["MiRo Docker image <br> (Ubuntu 20.04)"]
    A --> B["WSL distro <br> (e.g. Ubuntu 24.04)"]
    D --> B
    D --> C
Loading

Host OS

  1. Install WSL2 (the terms WSL2 and WSL are used interchangeably).
  2. Install a Linux distro inside WSL. Ubuntu 24.04 is recommended, which you can get in a number of ways:
    • By running wsl --install -d Ubuntu-24.04.
    • Downloading from Windows Store.
    • Or downloading directly from Canonical.
  3. Launch your chosen distro via WSL and set up your UNIX account and password.
  4. Install Docker Desktop on your host OS.
  5. In Docker Desktop settings, enable both "Use the WSL 2 based engine" and WSL integration with your WSL distro.

WSL distro

Inside the running WSL distro, do the following:

  1. sudo apt update && sudo apt upgrade && sudo apt autoremove.
  2. sudo apt install mesa-utils x11-xserver-utils
  3. Append export LIBGL_ALWAYS_SOFTWARE="1" to your ~/.bashrc file. This will enable software rendering for GUI apps.
  4. Unless you want to look into hardware rendering, you can now follow the Quick Start instructions on the main README page.

Hardware acceleration for GUI apps

The following assumes you have a fairly modern GPU card, e.g. NVIDIA RTX series.

Host OS
  1. Ensure your dGPU is always used (profile set to performance or manually select).
  2. Install the latest graphics drivers.
WSL distro
  1. Add the following to your ~/.bashrc:
export LIBGL_ALWAYS_SOFTWARE=0
export LIBGL_ALWAYS_INDIRECT=0
export MESA_LOADER_DRIVER_OVERRIDE='d3d12'
export GALLIUM_DRIVER='d3d12'

...

Sound

...

Option 1.2: Windows with WSL2 (without Docker Desktop)

  1. Follow the steps 1-3 described in option 1.1 under Host OS
  2. Then, follow the steps in the Ubuntu section inside your WSL Ubuntu distro.

Mac

Follow the Ubuntu instructions above (skipping hardware acceleration).