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: README.md
+38-18Lines changed: 38 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,39 +22,59 @@ A `development container` (or dev container for short) allows you to use a cont
22
22
- Custom PS1 (terminal shell);
23
23
</details>
24
24
25
-
## Devcontainers installation
25
+
<divalign="center">
26
+
<imgsrc="https://github.com/user-attachments/assets/6c085018-0b43-4f0e-9316-20bac5d0d4c1"alt="Fully loaded interface with the VNC client and multiple terminals on the bottom panel"style="text-align:center; width:70%">
27
+
<br>
28
+
Fully loaded interface with the VNC client and multiple terminals on the bottom panel.
29
+
</div>
30
+
31
+
## How to use?
26
32
33
+
### To develop locally, using `devcontainers` (local VScode)
34
+
35
+
<details>
36
+
<summary> Recommended for local development, with X11 sharing, etc.</summary>
- Verify the compose file used in the container used in `.devcontainer/devcontaoiner.json`, given your operative system:
40
+
```json
41
+
"dockerComposeFile": [
42
+
"../compose_linux_host.yaml"# or can be also "../compose_macos_host.yaml" if you use MacOS
43
+
],
44
+
```
27
45
- Open folder with VScode using the dev containers plugin (https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
46
+
-`control + shift + p`
47
+
- Write `Dev Containers: Reopen in Container` or `Dev Containers: Rebuild and Reopen in Container`
28
48
29
-
## Quick usage
49
+
<divalign="center">
50
+
<imgsrc="https://github.com/user-attachments/assets/784b06f7-8225-4be8-a2b7-e6e96b8cc376"alt="Fully loaded interface with the VNC client and multiple terminals on the bottom panel"style="text-align:center; width:70%">
51
+
<br>
52
+
How to open the repo using the Dev Containers plugin in VScode.
53
+
</div>
54
+
</details>
30
55
31
-
### Start devcontainer on VScode or use `docker compose`
32
56
33
-
- When the host is a linux-based machine:
34
-
```
35
-
BUILDKIT_PROGRESS=plain docker compose -f compose_linux_host.yaml up --build
36
-
```
57
+
### Headless run with `docker compose` (remote Jetson headless)
37
58
38
-
- When the host is a macos-based machine:
39
-
```
40
-
BUILDKIT_PROGRESS=plain docker compose -f compose_macos_host.yaml up --build
41
-
```
59
+
<details>
60
+
<summary>Recommended for remote development, as for example, deploying a dev machine on the robot.</summary>
-`BUILDKIT_PROGRESS=plain docker compose -f compose_jetson_host.yaml up --build`
42
65
43
66
`BUILDKIT_PROGRESS=plain` helps to visualize step by step output of each of the commands.
67
+
</details>
44
68
45
-
### Usage
69
+
### Access to services
70
+
71
+
Once the container is up, the you can access the services via:
46
72
47
73
- VNC: http://localhost:3080
48
74
- VScode: http://localhost:3081
49
75
- SSH: `ssh ubuntu@localhost -p 3022`
50
76
- user: `ubuntu`
51
77
- pass: `ubuntu`
52
-
53
-
<divalign="center">
54
-
<imgsrc="https://github.com/user-attachments/assets/6c085018-0b43-4f0e-9316-20bac5d0d4c1"alt="Fully loaded interface with the VNC client and multiple terminals on the bottom panel"style="text-align:center; width:70%">
55
-
<br>
56
-
Fully loaded interface with the VNC client and multiple terminals on the bottom panel.
0 commit comments