Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gezp committed Oct 24, 2024
1 parent aae1692 commit dfa7597
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ docker pull gezp/ubuntu-desktop:20.04-cu11.0.3
# docker pull registry.cn-hongkong.aliyuncs.com/gezp/ubuntu-desktop:20.04-cu11.0.3
```

create conatiner
create container
```bash
# create conatiner with nomachine
# create container with nomachine
docker run -d --restart=on-failure \
--name my_workspace \
--cap-add=SYS_PTRACE \
Expand All @@ -73,9 +73,10 @@ docker run -d --restart=on-failure \
-e UID=$(id -u) \
-p 10022:22 \
-p 14000:4000 \
-p 15000:5000 \
gezp/ubuntu-desktop:20.04-cu11.0.3

# create conatiner with kasmvnc/novnc
# create container with kasmvnc/novnc
docker run -d --restart=on-failure \
--name my_workspace \
--gpus all \
Expand All @@ -87,38 +88,42 @@ docker run -d --restart=on-failure \
-e REMOTE_DESKTOP=kasmvnc \
-p 10022:22 \
-p 14000:4000 \
-p 15000:5000 \
gezp/ubuntu-desktop:20.04-cu11.0.3
```
* the default username and password are both ubuntu.

access conatiner by ssh
access container by ssh
```bash
ssh ubuntu@host-ip -p 10022
```
* it's recommended to use vscode + remote ssh plugin

access conatiner by remote desktop (nomachine)
access container by remote desktop (nomachine)

* download and install [nomachine software](https://www.nomachine.com/).
* the ip is host's ip, the port is 14000.

access conatiner by remote desktop (kasmvnc/novnc)
access container by remote desktop (kasmvnc/novnc)

* use browser to access `https://<host-ip>:14000` (chrome is recommended)

> Tip `novnc` option based on [TurboVNC](https://github.com/TurboVNC/turbovnc) + [noVNC](https://github.com/novnc/noVNC), which are free and open-source software.
> Tip `novnc` option based on [TurboVNC](https://github.com/TurboVNC/turbovnc) + [noVNC](https://github.com/novnc/noVNC), which are free and open-source softwares.
features of moachine/kasmvnc/novnc:

* moachine: need client software to access remote desktop, and support audio, uploads, downloads.
* kasmvnc/novnc: provide remote web-based access to desktop, but it doesn't support audio, uploads, downloads, and microphone pass-through.

access container by [code-server](https://github.com/coder/code-server) (VS Code in the browser)

* use browser to access `https://<host-ip>:15000` (chrome is recommended)

## Advanced Usage

#### Custom User Argument

configure by setting environment variables when you create conatiner.
configure by setting environment variables when you create container.

* `REMOTE_DESKTOP`: nomachine (default) , kasmvnc, novnc.
* `VNC_THREADS`: RectThread num for vncserver, only used when `REMOTE_DESKTOP` = kasmvnc. default is 2, set 0 for auto.
Expand Down
9 changes: 8 additions & 1 deletion README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ docker pull gezp/ubuntu-desktop:20.04-cu11.0.3

docker run: 创建并运行容器
```bash
# create container with nomachine
docker run -d --restart=on-failure \
--name my_workspace \
--cap-add=SYS_PTRACE \
Expand All @@ -66,9 +67,10 @@ docker run -d --restart=on-failure \
-e UID=$(id -u) \
-p 10022:22 \
-p 14000:4000 \
-p 15000:5000 \
gezp/ubuntu-desktop:20.04-cu11.0.3

# create conatiner with kasmvnc/novnc
# create container with kasmvnc/novnc
docker run -d --restart=on-failure \
--name my_workspace \
--gpus all \
Expand All @@ -80,6 +82,7 @@ docker run -d --restart=on-failure \
-e REMOTE_DESKTOP=kasmvnc \
-p 10022:22 \
-p 14000:4000 \
-p 15000:5000 \
gezp/ubuntu-desktop:20.04-cu11.0.3
```
* 默认用户名和密码均为ubuntu
Expand All @@ -101,6 +104,10 @@ ssh ubuntu@host-ip -p 10022

* 使用浏览器访问 `https://<host-ip>:14000` (推荐chrome)

访问网页版VS Code (基于[code-server](https://github.com/coder/code-server))

* 使用浏览器访问 `https://<host-ip>:15000` (推荐chrome)

## 3.扩展使用

### 3.1 自定义用户参数
Expand Down

0 comments on commit dfa7597

Please sign in to comment.