Skip to content

Commit 7f699a8

Browse files
Dr.SnowbirdDr.Snowbird
authored andcommitted
update README.md
1 parent 698336d commit 7f699a8

File tree

1 file changed

+50
-9
lines changed

1 file changed

+50
-9
lines changed

README.md

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ This image contains [Oracle JDK 8](http://www.oracle.com/technetwork/java/javase
1111
The idea is to use Docker with VNC/noVNC to aggregate all the needed and related Developments tools/IDEs within a single Docker as an agile way to stand up specific collections of tools quick within a Container quick computing needs, e.g.,
1212
* REST Development (this GIT) to cover end-to-end needs from JSON/XML, REST connection, Swagger, Mongodb, Test, etc.
1313
* NLP/Semantic Development (coming soon)
14-
* ... and more per your imaginations or needs in your business application domains, e.g, bio-science, etc.
14+
* ... and more per your imaginations or needs in your business application domains, e.g, bio-science, finance, IoT, etc.
15+
16+
**The use-cases of this kind of VNC/noVNC docker container is just limited by your imaginations and your device or networking limitations. Virtually it's accessbile ubiquitously from Your favorite smartphones, tablets, e.g., iPad, SurfacePro, Amazon Fire tablet, Chrome PC, Desktop PC, etc. (Hmmm! in theory, if you can read tiny screens, you can even use your Apple iWatch to use KNIME, Eclipse Photon, IntelliJ, etc. as long as it can display HTML-5 Web Browsers!**
1517

16-
**The use-cases of this kind of VNC/noVNC docker container is just limited by your imaginations and your device or networking limitations. Virtually it's accessbile ubiquitously from Your smartphones, tablets, SurfacePro, Amazon Fire tablet, Chrome PC, Desktop, etc. (Hmmm! in theory, you can even use your Apple iWatch to use KNIME, Eclipse Photon, IntelliJ, etc. with any device can run HTML-5 Web Browsers!**
1718
# REST Tools / Components
18-
The followings are available now for REST Development:
19+
The followings are available now for REST Development and more will be added either as default or optional under the "**./components**" directory:
1920
```
2021
./components
2122
├── app-postman.sh
@@ -52,10 +53,45 @@ If needed again, you just run each needed component setup script, e.g.,
5253
# Note:
5354
This project mainly adopt the [ConSol docker-headless-vnc-container](https://github.com/ConSol/docker-headless-vnc-container) implementation.
5455

55-
# Run
56-
```bash
56+
# Run (recommended for easy-start)
57+
It's highly recommended to change tvnc password to prevent others usign the default password to get into your container, modify the file "**./docker.env**" as below and save the filw before you hit, "./run.sh":
58+
```
59+
(./docker.env) file:
60+
61+
#### ---- VNC Password ----
62+
VNC_PW=MySuperStrongPassword
63+
```
64+
* Once the above build is done, you can run IntelliJ now using the command below.
65+
```
5766
./run.sh
5867
```
68+
The run.sh command will auto-generate the docker run arguments as below:
69+
```
70+
docker run --rm -it
71+
--name=rest-dev-vnc-docker
72+
--restart=no
73+
-e VNC_RESOLUTION=1920x1080
74+
-e VNC_PW=vncpassword
75+
-v /home/user1/data-docker/rest-dev-vnc-docker/.eclipse:/home/developer/.eclipse
76+
-v /home/user1/data-docker/rest-dev-vnc-docker/eclipse-workspace:/home/developer/eclipse-workspace
77+
-p 5901:5901
78+
-p 6901:6901
79+
openkbs/rest-dev-vnc-docker
80+
```
81+
82+
# Deployment over Openshift or Kubernetes
83+
You need to manually provide the environment variables for deployment (since run.sh automatically aggregate all the needed variables for running the PyCharm docker container to ensure the persistent information stayed with the host directories even you delete the container instances.
84+
Here is what you need to setup in Openshift "deployment" configuration GUI or YAML template (from docker-compose.yaml file below):
85+
```
86+
volumes:
87+
-v <Your File Directory>/data:/home/developer/data
88+
-v <Your File Directory>/workspace:/home/developer/workspace
89+
-v <Your File Directory>/data-docker/rest-dev-vnc-docker/.eclipse:/home/developer/.eclipse
90+
-v <Your File Directory>/data-docker/rest-dev-vnc-docker/eclipse-workspace:/home/developer/eclipse-workspace
91+
-p 5901:5901
92+
-p 6901:6901
93+
```
94+
5995

6096
## Connect to VNC Viewer/Client or noVNC (Browser-based VNC)
6197
* connect via VNC viewer localhost:5901, default password: vncpassword
@@ -93,9 +129,10 @@ VNC_PW, default: vncpassword , e.g., change to MySpecial!(Password%)
93129
Two ways to change Screen resolutions.
94130

95131
## 1.) Modify ./run.sh file
132+
(file ./
96133
```
97134
#VNC_RESOLUTION="1280x1024"
98-
VNC_RESOLUTION="1920x1280"
135+
VNC_RESOLUTION=1920x1280
99136
```
100137

101138
## 2.) Customize Openshift or Kubernetes container run envionrment
@@ -204,23 +241,27 @@ However, for larger complex projects, you might want to consider to use Docker-b
204241
* [Running GUI apps in Docker containers using VNC](http://blog.fx.lv/2017/08/running-gui-apps-in-docker-containers-using-vnc/)
205242
* [Docker-headless-VNC-Container](https://github.com/DrSnowbird/docker-headless-vnc-container)
206243

207-
# See also similar docker-based IDE
244+
# See also X11 and VNC/noVNC docker-based IDE collections
208245
* [openkbs/docker-atom-editor](https://hub.docker.com/r/openkbs/docker-atom-editor/)
209246
* [openkbs/eclipse-oxygen-docker](https://hub.docker.com/r/openkbs/eclipse-oxygen-docker/)
247+
* [openkbs/eclipse-phonto-vnc-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/eclipse-photon-vnc-docker)
210248
* [openkbs/eclipse-photon-docker](https://hub.docker.com/r/openkbs/eclipse-photon-docker/)
211249
* [openkbs/eclipse-photon-vnc-docker](https://hub.docker.com/r/openkbs/eclipse-photon-vnc-docker/)
212250
* [openkbs/intellj-docker](https://hub.docker.com/r/openkbs/intellij-docker/)
213251
* [openkbs/intellj-vnc-docker](https://hub.docker.com/r/openkbs/intellij-vnc-docker/)
214-
* [openkbs/knime-vnc-docker](https://hub.docker.com/r/openkbs/knime-vnc-docker/)
252+
* [openkbs/knime-vnc-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/knime-vnc-docker)
253+
* [openkbs/mysql-workbench-vnc-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/mysql-workbench-vnc-docker)
215254
* [openkbs/netbeans10-docker](https://hub.docker.com/r/openkbs/netbeans10-docker/)
216255
* [openkbs/netbeans](https://hub.docker.com/r/openkbs/netbeans/)
217256
* [openkbs/papyrus-sysml-docker](https://hub.docker.com/r/openkbs/papyrus-sysml-docker/)
218257
* [openkbs/pycharm-docker](https://hub.docker.com/r/openkbs/pycharm-docker/)
258+
* [openkbs/pycharm-vnc-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/pycharm-vnc-docker)
219259
* [openkbs/rapidminer-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/rapidminer-docker)
220260
* [openkbs/scala-ide-docker](https://hub.docker.com/r/openkbs/scala-ide-docker/)
221261
* [openkbs/sublime-docker](https://hub.docker.com/r/openkbs/sublime-docker/)
222262
* [openkbs/webstorm-docker](https://hub.docker.com/r/openkbs/webstorm-docker/)
223-
* [openkbs/webstorm-vnc-docker](https://hub.docker.com/r/openkbs/webstorm-vnc-docker/)
263+
* [openkbs/webstorm-vnc-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/webstorm-vnc-docker)
264+
* [openkbs/rest-dev-vnc-docker](https://cloud.docker.com/u/openkbs/repository/docker/openkbs/rest-dev-vnc-docker)
224265

225266
# See Also - Docker-based SQL GUI
226267
* [Sqlectron SQL GUI at openkbs/sqlectron-docker](https://hub.docker.com/r/openkbs/sqlectron-docker/)

0 commit comments

Comments
 (0)