Skip to main content

Docker Environment Setup

This page introduces how to use the Docker images provided in this repository.

There are five available Docker images:

  • docker-image: Contains environment setups for all supported platforms
  • docker-image-stm32: Docker image tailored for STM32 development
  • docker-image-esp32: Docker image tailored for ESP32 development
  • docker-image-linux: Docker image tailored for Linux development
  • docker-image-webots: Docker image tailored for Webots simulation

ghcr.io​

GitHub Container Registry – recommended for use in GitHub Actions

  • docker-image: docker pull ghcr.io/xrobot-org/docker-image:main
  • docker-image-stm32: docker pull ghcr.io/xrobot-org/docker-image-stm32:main
  • docker-image-esp32: docker pull ghcr.io/xrobot-org/docker-image-esp32:main
  • docker-image-linux: docker pull ghcr.io/xrobot-org/docker-image-linux:main
  • docker-image-webots: docker pull ghcr.io/xrobot-org/docker-image-webots:main

Docker Hub​

Docker Hub images – recommended for local development

  • docker-image: docker pull xrimage/xrimage
  • docker-image-stm32: docker pull xrimage/xrimage-stm32
  • docker-image-esp32: docker pull xrimage/xrimage-esp32
  • docker-image-linux: docker pull xrimage/xrimage-linux
  • docker-image-webots: docker pull xrimage/xrimage-webots

Running Docker Images​

docker run -it <image-name>