Skip to content

Commit 0cf82cd

Browse files
committed
Update docker images part.
1 parent 092c56e commit 0cf82cd

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

docs/env_setup/docker.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: env-setup-docker
3+
title: Docker 环境配置
4+
sidebar_position: 2
5+
---
6+
7+
此界面介绍了如何使用[此仓库](https://github.com/xrobot-org/Docker-Image)中发布的Docker镜像。
8+
9+
提供的Docker镜像总共有五种:
10+
11+
* docker-image: 包含对所有已经支持平台的环境配置
12+
* docker-image-stm32: 针对STM32的docker镜像
13+
* docker-image-esp32: 针对ESP32的docker镜像
14+
* docker-image-linux: 针对Linux的docker镜像
15+
* docker-image-webots: 针对Webots仿真的docker镜像
16+
17+
## ghcr.io
18+
19+
github的容器仓库,推荐在github actions中使用
20+
21+
* docker-image: `docker pull ghcr.io/xrobot-org/docker-image:main`
22+
* docker-image-stm32: `docker pull ghcr.io/xrobot-org/docker-image-stm32:main`
23+
* docker-image-esp32: `docker pull ghcr.io/xrobot-org/docker-image-esp32:main`
24+
* docker-image-linux: `docker pull ghcr.io/xrobot-org/docker-image-linux:main`
25+
* docker-image-webots: `docker pull ghcr.io/xrobot-org/docker-image-webots:main`
26+
27+
## Docker Hub
28+
29+
docker hub的镜像,推荐在本地使用
30+
31+
* docker-image: `docker pull xrimage/xrimage`
32+
* docker-image-stm32: `docker pull xrimage/xrimage-stm32`
33+
* docker-image-esp32: `docker pull xrimage/xrimage-esp32`
34+
* docker-image-linux: `docker pull xrimage/xrimage-linux`
35+
* docker-image-webots: `docker pull xrimage/xrimage-webots`
36+
37+
## 运行Docker镜像
38+
39+
```bash
40+
docker run -it 镜像名
41+
```
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: env-setup-docker
3+
title: Docker Environment Setup
4+
sidebar_position: 2
5+
---
6+
7+
This page introduces how to use the Docker images provided in [this repository](https://github.com/xrobot-org/Docker-Image).
8+
9+
There are five available Docker images:
10+
11+
* `docker-image`: Contains environment setups for all supported platforms
12+
* `docker-image-stm32`: Docker image tailored for STM32 development
13+
* `docker-image-esp32`: Docker image tailored for ESP32 development
14+
* `docker-image-linux`: Docker image tailored for Linux development
15+
* `docker-image-webots`: Docker image tailored for Webots simulation
16+
17+
## ghcr.io
18+
19+
GitHub Container Registry – recommended for use in GitHub Actions
20+
21+
* docker-image: `docker pull ghcr.io/xrobot-org/docker-image:main`
22+
* docker-image-stm32: `docker pull ghcr.io/xrobot-org/docker-image-stm32:main`
23+
* docker-image-esp32: `docker pull ghcr.io/xrobot-org/docker-image-esp32:main`
24+
* docker-image-linux: `docker pull ghcr.io/xrobot-org/docker-image-linux:main`
25+
* docker-image-webots: `docker pull ghcr.io/xrobot-org/docker-image-webots:main`
26+
27+
## Docker Hub
28+
29+
Docker Hub images – recommended for local development
30+
31+
* docker-image: `docker pull xrimage/xrimage`
32+
* docker-image-stm32: `docker pull xrimage/xrimage-stm32`
33+
* docker-image-esp32: `docker pull xrimage/xrimage-esp32`
34+
* docker-image-linux: `docker pull xrimage/xrimage-linux`
35+
* docker-image-webots: `docker pull xrimage/xrimage-webots`
36+
37+
## Running Docker Images
38+
39+
```bash
40+
docker run -it <image-name>

0 commit comments

Comments
 (0)