Skip to content

Commit 67024c6

Browse files
authored
Merge pull request #2905 from JdeRobot/update-new-user-guide
Update user guide
2 parents 0e5f484 + 9e07b02 commit 67024c6

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

_pages/user_guide.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_label: "TOC installation"
1010
toc_icon: "cog"
1111
---
1212

13-
**Robotics Academy** supports Linux (Ubuntu 18.04, 20.04, 22.04 and other distributions), MacOS and Windows.
13+
**Robotics Academy** supports Linux (Ubuntu 18.04, 20.04, 22.04, 24.04 and other distributions), MacOS and Windows.
1414

1515

1616
<a name="installation"></a>
@@ -28,15 +28,16 @@ The installation of ROS, Gazebo, etc. has been greatly simplified, as all the re
2828

2929
1. Download [Docker](https://docs.docker.com/get-docker/) **(minimum version of docker-py: 5.0.3)**.
3030

31-
2. Pull the current distribution of RoboticsBackend **(currently version 4.6.14)**:
31+
2. Pull the current distribution of Robotics Academy and of Robotics Academy Database **(currently version 5.4.3)**:
3232

3333
```bash
34-
docker pull jderobot/robotics-backend:latest
34+
docker pull jderobot/robotics-database:latest
35+
docker pull jderobot/robotics-academy:latest
3536
```
3637

3738
- In order to obtain optimal performance, Docker should be using multiple CPU cores. In case of Docker for Mac or Docker for Windows, the VM should be assigned a greater number of cores.
3839

39-
- It is recommended to use the latest image. However, older distributions of RoboticsBackend can be found [here](https://hub.docker.com/r/jderobot/robotics-backend/tags).
40+
- It is recommended to use the latest image. However, older distributions of Robotics Academy can be found [here](https://hub.docker.com/r/jderobot/robotics-academy/tags).
4041

4142
## Windows Users
4243

@@ -50,42 +51,56 @@ Windows users should choose WSL 2 backend Docker installation if possible, as it
5051

5152
![WSL integration](/RoboticsAcademy/assets/images/user_guide/wsl-integration-docker.png)
5253

53-
4. Pull the current distribution of RoboticsBackend **(currently version 4.6.12)**:
54+
4. Pull the current distribution of Robotics Academy and of Robotics Academy Database **(currently version 5.4.3)**:
5455

5556
```bash
56-
docker pull jderobot/robotics-backend:latest
57+
docker pull jderobot/robotics-database:latest
58+
docker pull jderobot/robotics-academy:latest
5759
```
5860

5961
- In order to obtain optimal performance, Docker should be using multiple CPU cores. In case of Docker for Mac or Docker for Windows, the VM should be assigned a greater number of cores.
6062

61-
- It is recommended to use the latest image. However, older distributions of RoboticsBackend can be found [here](https://hub.docker.com/r/jderobot/robotics-backend/tags).
63+
- It is recommended to use the latest image. However, older distributions of Robotics Academy can be found [here](https://hub.docker.com/r/jderobot/robotics-academy/tags).
6264

6365
## MacOs (PLACEHOLDER!)
6466

65-
* Remember to add minium docker version to run a RoboticsBackend.
67+
* Remember to add minium docker version to run a Robotics Academy.
6668

6769
<a name="launch"></a>
68-
# 2. How to launch a RoboticsBackend container?
70+
# 2. How to launch a Robotics Academy container?
71+
72+
* Launch databases
73+
74+
```bash
75+
docker run --hostname my-postgres --name academy_db -d\
76+
-e POSTGRES_DB=academy_db \
77+
-e POSTGRES_USER=user-dev \
78+
-e POSTGRES_PASSWORD=robotics-academy-dev \
79+
-e POSTGRES_PORT=5432 \
80+
-d -p 5432:5432 \
81+
jderobot/robotics-database:latest
82+
```
83+
6984

7085
* Start a new docker container of the image and keep it running in the background:
7186
* The priority order is: NVIDIA -> Intel -> Only CPU
7287

7388
```bash
74-
docker run --rm -it $(nvidia-smi >/dev/null 2>&1 && echo "--gpus all" || echo "") --device /dev/dri -p 7164:7164 -p 6080:6080 -p 1108:1108 -p 7163:7163 jderobot/robotics-backend
89+
docker run --rm -it $(nvidia-smi >/dev/null 2>&1 && echo "--gpus all" || echo "") --device /dev/dri -p 6080:6080 -p 1108:1108 -p 7163:7163 -p 7164:7164 --link academy_db jderobot/robotics-academy:latest
7590
```
7691

7792
## Advanced Instructions on Linux
7893

7994
- **NVIDIA:** For NVIDIA GPUs, acceleration can be achieved by [installing the nvidia-container-runtime package](https://docs.docker.com/config/containers/resource_constraints/#gpu), and then running the **auto** command above.
8095

81-
- **Only Intel:**
96+
- **Integrated GPU**
8297
```bash
83-
docker run --rm -it --device /dev/dri -p 7164:7164 -p 6080:6080 -p 1108:1108 -p 7163:7163 jderobot/robotics-backend
98+
docker run --rm -it --device /dev/dri -p 6080:6080 -p 1108:1108 -p 7163:7163 -p 7164:7164 --link academy_db jderobot/robotics-academy:latest
8499
```
85100

86101
- **Only CPU:**
87102
```bash
88-
docker run --rm -it -p 7164:7164 -p 6080:6080 -p 1108:1108 -p 7163:7163 jderobot/robotics-backend
103+
docker run --rm -it -p 6080:6080 -p 1108:1108 -p 7163:7163 -p 7164:7164 --link academy_db jderobot/robotics-academy:latest
89104
```
90105

91106
## Windows

0 commit comments

Comments
 (0)