You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _pages/user_guide.md
+28-13Lines changed: 28 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ toc_label: "TOC installation"
10
10
toc_icon: "cog"
11
11
---
12
12
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.
14
14
15
15
16
16
<aname="installation"></a>
@@ -28,15 +28,16 @@ The installation of ROS, Gazebo, etc. has been greatly simplified, as all the re
28
28
29
29
1. Download [Docker](https://docs.docker.com/get-docker/)**(minimum version of docker-py: 5.0.3)**.
30
30
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)**:
32
32
33
33
```bash
34
-
docker pull jderobot/robotics-backend:latest
34
+
docker pull jderobot/robotics-database:latest
35
+
docker pull jderobot/robotics-academy:latest
35
36
```
36
37
37
38
- 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.
38
39
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).
40
41
41
42
## Windows Users
42
43
@@ -50,42 +51,56 @@ Windows users should choose WSL 2 backend Docker installation if possible, as it
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)**:
54
55
55
56
```bash
56
-
docker pull jderobot/robotics-backend:latest
57
+
docker pull jderobot/robotics-database:latest
58
+
docker pull jderobot/robotics-academy:latest
57
59
```
58
60
59
61
- 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.
60
62
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).
62
64
63
65
## MacOs (PLACEHOLDER!)
64
66
65
-
* Remember to add minium docker version to run a RoboticsBackend.
67
+
* Remember to add minium docker version to run a Robotics Academy.
66
68
67
69
<aname="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
+
69
84
70
85
* Start a new docker container of the image and keep it running in the background:
71
86
* The priority order is: NVIDIA -> Intel -> Only CPU
-**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.
0 commit comments