|
| 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