Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update vast.ai and runpod.io template description
  • Loading branch information
asyafiqe authored Aug 12, 2024
1 parent 6bf1819 commit 3c9a15f
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@
This is a docker for running [**Rope**](https://github.com/Hillobar/Rope) using [**headless VNC environments**](https://github.com/ConSol/docker-headless-vnc-container). Useful for running Rope on cloud GPU services like [Runpod.io](https://www.runpod.io/) or [Vast.ai](https://vast.ai/).

The Docker image is installed with the following components:
* [**Rope**](https://github.com/Hillobar/Rope)
* [**Rope**](https://github.com/Hillobar/Rope) Pearl-00
* JupyterLab (default http port `8080`)
* VNC-Server (default VNC port `5901`)
* [**noVNC**](https://github.com/novnc/noVNC) - HTML5 VNC client (default http port `6901`)
* [**noVNC**](https://github.com/novnc/noVNC) 1.5.0 - HTML5 VNC client (default http port `6901`)
* CUDA Toolkit 11.8
* Pytorch 2.0.1+cu118
* Desktop environment [**Xfce4**](http://www.xfce.org)
* Browsers:
* Mozilla Firefox
* Chromium
* [**fiebrowser**](https://github.com/filebrowser/filebrowser) (default http port `8585`)
* Mozilla Firefox

## Usage
- Run command with mapping to local port `5901` (vnc protocol), `6901` (vnc web access), and `8080` (JupyterLab):
- Run command with mapping to local port `5901` (vnc protocol), `6901` (vnc web access), `8080` (JupyterLab), and `8585` (filebrowser):

docker run -d -p 5901:5901 -p 6901:6901 -p 8080:8080 -e VNC_PASSWORDLESS=true asyafiqe/rope_vnc:latest
docker run -d --gpus all -p 5901:5901 -p 6901:6901 -p 8080:8080 -p 8585:8585 -e VNC_PASSWORDLESS=true -e VNC_RESOLUTION=1024x768 asyafiqe/rope_vnc:latest

For more options, please check [ConSol's docker-headless-vnc-container github](https://github.com/ConSol/docker-headless-vnc-container).
- Build an image from scratch:
Expand All @@ -28,7 +27,7 @@ The Docker image is installed with the following components:
Put `asyafiqe/rope_vnc:latest` in image path/tag.
Docker options:
```
-p 5901:5901 -p 6901:6901 -p 8080:8080 -e VNC_PASSWORDLESS=true
-p 5901:5901 -p 6901:6901 -p 8080:8080 -p 8585:8585 -e VNC_PASSWORDLESS=true -e VNC_RESOLUTION=1024x768
```
In Launch Mode select 'Run interactive shell server, SSH'. Check 'Use direct SSH connection'.
On-start Script:
Expand All @@ -38,17 +37,18 @@ The Docker image is installed with the following components:
/dockerstartup/vnc_startup.sh
sleep infinity
```
![vast ai_template](https://github.com/asyafiqe/Rope-docker-headless-vnc-container/assets/51208506/9903a1d4-d73c-45cd-9c16-4c2c1cd809cb)
![vast ai_template](https://github.com/user-attachments/assets/28079139-db32-4f5a-97a8-af99d8d6244a)

- [Runpod.io](https://www.runpod.io/) template:
* Container image: `asyafiqe/rope_vnc:latest`.
* Docker command:
```
-p 5901:5901 -p 6901:6901 -p 8080:8080
-p 5901:5901 -p 6901:6901 -p 8080:8080 -p 8585:8585
```
* Container disk: minimum 20GB
* Container disk: minimum 30GB
* Volume disk: personal preference
* Volume mount path: `/workspace`
* Expose http ports: `5901,6901,8080`
* Expose http ports: `6901,8080,8585`
* Expose TCP ports: `5901`
* Environment Variables: key: `VNC_PASSWORDLESS`, value `true`
![runpod io_template](https://github.com/asyafiqe/Rope-docker-headless-vnc-container/assets/51208506/97b2753e-5e49-4f81-8d44-5e8f4d6fca2d)
![runpod io_template](https://github.com/user-attachments/assets/1e07306a-5958-4c2d-938d-8c80c68b221e)

0 comments on commit 3c9a15f

Please sign in to comment.