Merge pull request #17 from Coding/tanhehe/add_docker_support

add docker support

Author: tanhe123

.dockerignore

@@ -0,0 +1,10 @@
+*/.idea/
+*/*.iml
+*.orig
+*/target/
+*.env
+**/*.db
+*/*.ipr
+*/*.iws
+.DS_Store  
+

Dockerfile

@@ -0,0 +1,19 @@
+FROM ksimple/java8-mvn-nodejs-npm-python3
+MAINTAINER tanhe123 from Coding IDE Team <[email protected]>
+
+EXPOSE 8080
+
+# Add user `coding`
+
+RUN useradd --create-home --home-dir /home/coding --shell /usr/bin/bash coding \
+	&& echo "coding:coding" | chpasswd \
+	&& adduser coding sudo \
+	&& echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+
+USER coding
+
+ADD . /opt/coding/WebIDE
+
+RUN sudo chown -R coding /opt/coding/WebIDE
+
+CMD ["/opt/coding/WebIDE/ide.sh", "build", "run"]

README-zh.md

@@ -1,5 +1,7 @@
 # Coding WebIDE
 
+README: [English](https://github.com/Coding/WebIDE/blob/master/README.md) | [中文](https://github.com/Coding/WebIDE/blob/master/README-zh.md)
+
 ![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/import.png)
 
 ![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/workspace.png)
@@ -10,6 +12,7 @@ Coding WebIDE(https://ide.coding.net) 是 Coding 自主研发的在线集成开
 
 请诸位把 issues 提到对应的项目下，这样可以得到更及时的处理。前端请到 [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend/issues)，后端请到 [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend/issues).
 
+
 ## 功能特色
 
 1. *全功能 Web Terminal*
@@ -23,34 +26,83 @@ Coding WebIDE(https://ide.coding.net) 是 Coding 自主研发的在线集成开
 本项目是为了能够一键启动 `WebIDE` 开源版而创建的，以 git 子模块的形式引用了另外的三个项目，分别是 WebIDE-Frontend、WebIDE-Frontend-Webjars、WebIDE-Backend。
 
 
-
 ## 模块说明
 
-> **WebIDE-Frontend:** WebIDE 前端项目
-> **WebIDE-Frontend-Webjars:** webjar 项目，用于将 WebIDE 前端打包成 webjar
-> **WebIDE-Backend:** WebIDE 后端项目
-
-## Clone 项目
-
-首先 clone 本项目到本地，然后拉取子项目:
-
-> git submodule init
-> git submodule update
+* [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend) WebIDE 前端项目
+* [WebIDE-Frontend-Webjars](https://github.com/Coding/WebIDE-Frontend-Webjars) webjar 项目，用于将 WebIDE 前端打包成 webjar
+* [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend) WebIDE 后端项目
 
-即可拉取子项目到本地。
 
 ## 运行环境
 
-**WebIDE Frontend 依赖 npm 做包管理，wepack 和 babel 做构建工具**
-**WebIDE-Frontend-Webjars & WebIDE-Backend 项目依赖 maven**
+WebIDE Frontend 依赖 **npm** 做包管理，**webpack** 和 **babel** 做构建工具
+WebIDE-Frontend-Webjars & WebIDE-Backend 项目依赖 **maven3** 和 **java8**
 
 在编译、运行项目前，请保证环境依赖已被正确配置。
 
 ## 编译、打包、运行
 
+### 克隆项目
+
+从 Coding 克隆项目：
+```
+git clone [email protected]:coding/WebIDE.git
+```
+
+从 Github 克隆项目：
+```
+git clone [email protected]:Coding/WebIDE.git
+```
+
+拉取子项目：
+```
+git submodule init
+git submodule update
+```
+
+### 本机版
+
 本项目提供了一个脚本 `ide.sh`，用于编译、打包、运行项目：
 
-> **./ide.sh build:** 编译并打包前端项目
-> **./ide.sh run:** 启动项目
+```
+./ide.sh build   # 编译并打包前端项目  
+./ide.sh run     # 启动项目
+```
+启动完成后，默认端口为 8080，访问 localhost:8080 即可。打开浏览器访问 http://localhost:8080
+
+### Docker 版
+
+#### 通过使用 ide.sh
+
+```
+./ide.sh docker build  # 创建 docker 镜像
+./ide.sh docker run    # 创建并启动 container
+./ide.sh docker stop   # 停止 container
+./ide.sh docker attach # attach container
+./ide.sh docker logs   # 查看 container log
+./ide.sh docker exec   # 进入 container
+```
+
+#### 通过使用 docker 命令
+
+如果在使用脚本的过程中遇到了困难，可以直接使用 docker 的命令。
+
+```
+# 创建 docker 镜像
+docker build -t coding/webide
+
+# 创建并启动 container
+docker run -p 8080:8080 -v $HOME/.m2:/home/coding/.m2 -v $HOME/.coding-ide-home:/home/coding/.coding-ide-home --name webide coding/webide
+
+# 停止 container
+docker stop webide
+
+# attach container
+docker attach webide
+
+# 查看 container log
+docker logs webide
 
-启动完成后，默认端口为 8080，访问 localhost:8080 即可。
+# 进入 container
+docker exec -it webide bash
+```

README.md

@@ -1,5 +1,7 @@
 # Coding WebIDE
 
+README: [English](https://github.com/Coding/WebIDE/blob/master/README.md) | [中文](https://github.com/Coding/WebIDE/blob/master/README-zh.md)
+
 ![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/import.png)
 
 ![](https://raw.githubusercontent.com/Coding/WebIDE/gh-pages/screenshots/workspace.png)
@@ -10,6 +12,7 @@ Coding WebIDE(https://ide.coding.net) is a cloud-based IDE developed by Coding T
 
 Please submit issues to corresponding projects, that'll help us make issues tracking easier so that we can provide timely help to you. Submit frontend issues at [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend/issues) and backend issues at [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend/issues).
 
+
 ## Features
 
 1. *Built-In Terminal*
@@ -20,45 +23,89 @@ Please submit issues to corresponding projects, that'll help us make issues trac
 6. *VIM／Emacs Mode*
 7. *Previews*
 
-[中文 README](https://github.com/Coding/WebIDE-Workspace/blob/master/README-zh.md)
-
 This is the entry point to setup and run the WebIDE Community Edition project. It includes other 3 repos as git submodules.
 
 
+## Modules
+
+* [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend) contains frontend code.
+* [WebIDE-Frontend-Webjars](https://github.com/Coding/WebIDE-Frontend-Webjars) packs frontend to webjar.
+* [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend) contains backend code.
 
 
-## Modules
+## Environment
+
+WebIDE Frontend uses **npm** for package management, **webpack** and **babel** for building.
+Frontend Webjars & WebIDE Backend use **maven3** and **java8**.
+
+Please ensure you have corresponding tools installed in your environment before build and run the project.
 
-> [WebIDE-Frontend](https://github.com/Coding/WebIDE-Frontend) contains frontend code.
-> [WebIDE-Frontend-Webjars](https://github.com/Coding/WebIDE-Frontend-Webjars) packs frontend to webjar.
-> [WebIDE-Backend](https://github.com/Coding/WebIDE-Backend) contains backend code.
 
+## Build and run
 
-## How to clone
+### Clone the repo
 
-Clone this git repo to local. Then do:
+Clone from coding.net:
+```
+git clone [email protected]:coding/WebIDE.git
+```
+Clone from github.com:
+```
+git clone [email protected]:Coding/WebIDE.git
+```
 
+Init and pull submodules:
 ```
 git submodule init
 git submodule update
 ```
-
 This will also clone the other 3 repos via git submodule mechanism.
 
 
-## Environment
+### Run on a normal host
 
-WebIDE Frontend uses `npm` for package management, `webpack` and `babel` for building.
-WebIDE Frontend Webjars & WebIDE Backend use `maven`.
+We provide a shell script `ide.sh` to ease the process for you.
 
-Please ensure you have corresponding tools installed in your environment before build and run the project.
+```
+./ide.sh build   # transpile and pack the frontend to webjars
+./ide.sh run     # start the backend server
+```
+Server runs on port 8080 by default, visit localhost:8080 to check it out.
 
 
-## Build and run
+### Run in a docker container
+
+#### Using `ide.sh`
+
+```
+./ide.sh docker build  # create docker image
+./ide.sh docker run    # create and start a container
+./ide.sh docker stop   # stop container
+./ide.sh docker attach # attach container
+./ide.sh docker logs   # check container's logs
+./ide.sh docker exec   # create a new Bash session in the container
+```
+
+#### Using `docker` CLI
+
+If you encounter any problem using `ide.sh`, try get around it using docker CLI directly.
+
+```
+# create docker image
+docker build -t coding/webide
+
+# create and start a container
+docker run -p 8080:8080 -v $HOME/.m2:/home/coding/.m2 -v $HOME/.coding-ide-home:/home/coding/.coding-ide-home --name webide coding/webide
 
-We provide a shell script `ide.sh` to ease the build and run process
+# stop container
+docker stop webide
 
-> **./ide.sh build:** builds the frontend and packs to webjars
-> **./ide.sh run:** start the backend and server
+# attach container
+docker attach webide
 
-Server runs on port 8080 by default, visit localhost:8080 to check it out. Have fun!
+# check container's logs
+docker logs webide
+
+# create a new Bash session in the container
+docker exec -it webide bash
+```