Skip to content

Commit 42e2d4d

Browse files
committed
update readme and ci condition
1 parent 393af5b commit 42e2d4d

3 files changed

Lines changed: 71 additions & 1 deletion

File tree

.github/workflows/envbase.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ name: Basic Env Docker Build and Publish
33
on:
44
push:
55
branches: [ "master" ]
6+
paths:
7+
- "docker/Dockerfile"
8+
- "docker/Dockerfile.full"
9+
- ".github/workflows/envbase.yaml"
610
workflow_run:
711
workflows: [ "envbase" ]
812
branches: [ "master" ]

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@ This repository contains everything needed to set up the Picker tool's complete
1414
│ ├── build-scripts/ # Automated build utilities
1515
│ └── compose/ # (Optional) Docker-compose files
1616
├── tutorials/ # Workshop materials
17-
│ ├── ppt/ # Presentation slides
17+
│ ├── README.md # ** IF YOU ARE IN TUTORIAL, READ THIS FIRST**
18+
│ ├── slides/ # Presentation slides
1819
│ └── code-samples/ # Demo scripts
1920
├── LICENSE
2021
└── README.md # This document
2122
```
2223

24+
**If you are in the tutorial, please read the [README.md](./tutorials/README.md) in the tutorials directory first.**
25+
2326
## 🚀 Getting Started
2427

2528
### Pre-built Docker Images 💿

tutorials/README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# README for Tutorial Audience
2+
3+
## Download the Docker Image
4+
5+
### Local Laptop
6+
7+
If you want to run the image locally, it is recommended to use our local Wireless Hotspot to download the image, due to the internet connection speed. The Image is about 1GB, so it may take a while to download.
8+
9+
You can connect to the wifi hotspot with the following credentials:
10+
- **SSID**: `UnityChip`
11+
- **Password**: `UnityChip2025`
12+
13+
Once connected, you can run the following command to download the image:
14+
```sh
15+
wget -O - http://192.168.100.2/envfull.tar.gz
16+
gzip -d envfull.tar.gz
17+
docker load -i envfull.tar
18+
```
19+
20+
### Remote Server
21+
22+
If you are using a remote server, you can download the Docker image from the GitHub Container Registry.
23+
```sh
24+
docker pull ghcr.io/xs-mlvp/envfull:latest
25+
```
26+
27+
## Run the Docker Image
28+
29+
### Shell Access
30+
31+
If shell access is enough for you, run the image with the following command:
32+
```sh
33+
docker run -it --network host ghcr.io/xs-mlvp/envfull:latest
34+
```
35+
36+
If you want to use ssh or vscode remote development, run this command in the container:
37+
```sh
38+
sudo service ssh start
39+
```
40+
and go to the next section for SSH access. (no need to docker run again)
41+
42+
### SSH Access
43+
44+
If you want to use ssh or vscode remote development, run the image with the following command:
45+
```sh
46+
docker run -itd --network host ghcr.io/xs-mlvp/envfull:latest sudo /usr/sbin/sshd -D
47+
```
48+
49+
Then, SSH into the container (security reason: /etc/ssh/sshd_config is set to only listen to localhost):
50+
```sh
51+
ssh -p 51202 user@localhost # password: user
52+
```
53+
54+
If you are running the container on a remote server, you can use the following command for port forwarding when connecting to the remote server:
55+
```sh
56+
ssh -L 51202:localhost:51202 <your-server-user>@<your-remote-server-ip>
57+
```
58+
> Note: This step is optional if you are running the container on your local machine, it's map server port to localhost for security reason.
59+
60+
### VSCode Remote Development
61+
62+
If you want to use VSCode remote development, just use remote-ssh extension to connect to the container.
63+

0 commit comments

Comments
 (0)