Skip to content

Commit 7284acb

Browse files
author
Tyler Jewell
authored
Added build by using Docker container.
1 parent d027706 commit 7284acb

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,30 +58,49 @@ Che will be available at ```localhost:8080```.
5858
### Build Submodules
5959
Building `/assembly` pulls already-built libraries for `/core`, `/plugins`, and `/dashboard` from our Nexus repository.
6060

61-
To build core:
61+
To build the Che core:
6262
```sh
6363
# Install maven-patch-plugin as an additional dependency.
6464
cd che/core
6565

6666
# Windows: maven-patch-plugin does not work, so skip tests when building:
6767
# See: https://maven.apache.org/plugins/maven-patch-plugin/faq.html#Why_doesnt_this_work_on_Windows
68-
mvn -DskipTests=true -Dfindbugs.skip=true -Dskip-validate-sources clean install
68+
mvn -DskipTests=true -Dfindbugs.skip=true -Dskip-validate-sources clean install
6969
```
7070

71-
To build plugins:
71+
To build Che plugins:
7272
```sh
7373
cd che/plugins
7474
mvn clean install
7575
```
7676

77-
To build dashboard:
77+
To build the Che dashboard:
7878
```sh
7979
# You need NPM, Bower, and Gulp installed.
8080
# See setup in /dashboard
8181
cd che/dashboard
8282
mvn clean install
8383
```
8484

85+
### Build Che Using Docker
86+
If you want to avoid setting up the dependencies to compile Che core, plugins and the dashboard, we provide a Docker image that has all dependencies necessary to compile Che. You can have Che source code on your host and compile it within the container.
87+
88+
```sh
89+
# For Mac + Linux:
90+
docker run -it --rm --name build-che
91+
-v "$HOME/.m2:/home/user/.m2"
92+
-v "$PWD":/home/user/che-build
93+
-w /home/user/che-build
94+
codenvy/che-dev
95+
mvn -DskipTests=true
96+
-Dfindbugs.skip=true
97+
-Dgwt.compiler.localWorkers=2 -T 1C
98+
-Dskip-validate-sources
99+
clean install
100+
101+
# For Windows, replace $HOME with location of Maven repository and $PWD with the directory where Che source code is installed.
102+
```
103+
85104
### Run Che as a Server
86105
If you want to run Che as a server where non-localhost clients connect, there are additional flags that you may need to configure. Please see the [usage documentation](https://eclipse-che.readme.io/docs/usage).
87106

@@ -119,6 +138,7 @@ These repositories are for the core project hosted at `http://github.com/eclipse
119138
### Other Repositories
120139
These are external repositories that provide additional tools for Eclipse Che.
121140
```
141+
http://github.com/codenvy/Dockerfiles # Defines the images referenced by stacks in Che
122142
http://github.com/codenvy/che-installer # Creates the Windows and JAR installer packages
123143
http://github.com/codenvy/che-tutorials # SDK examples and tutorials (needs updating)
124144
http://github.com/che-samples # GitHub organization with sample repos used in Che

0 commit comments

Comments
 (0)