diff --git a/README.md b/README.md index 8b240de6bbf31badbe5c3993229ae274233f1054..256f39c89c75820047e42d046bee202727e60558 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,11 @@ The following steps were reproduced in that order on a fully updated Ubuntu 15.1 sudo apt-get install openjdk-8-jdk mongodb git maven tomcat8 libgsl0-dev ``` + test if MongoDB is available: + ```bash + mongo + ``` + 2. install a recent version of **nodejs** (the official repositories contain old versions) ```bash curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash - @@ -67,19 +72,41 @@ The following steps were reproduced in that order on a fully updated Ubuntu 15.1 echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p ``` -5. Install **Eclipse EE**. A different Java development IDE (or none at all) can be used, but the Vipra projects are made with eclipse and come with settings and run configurations. Install the M2Eclipse plugin for maven support in eclipse, if not yet installed. The plugin will download the required project dependencies and manage the project configurations, build versioning and packaging. Set up the installed Java EE application server in Eclipse. Add the `vipra-backend` project to the web server. +5. Install and enable ElasticSearch + ```bash + wget https://download.elasticsearch.org/elasticsearch/release/org/elasticsearch/distribution/deb/elasticsearch/2.2.0/elasticsearch-2.2.0.deb + sudo dpkg -i elasticsearch-2.2.0.deb + rm elasticsearch-2.2.0.deb + sudo systemctl enable elasticsearch + sudo systemctl start elasticsearch + ``` + + and test if it is available: + ```bash + curl -XGET 'http://localhost:9200/' + ``` + +6. Install **Eclipse EE**. A different Java development IDE (or none at all) can be used, but the Vipra projects are made with eclipse and come with settings and run configurations. Install the M2Eclipse plugin for maven support in eclipse, if not yet installed. The plugin will download the required project dependencies and manage the project configurations, build versioning and packaging. Set up the installed Java EE application server in Eclipse. Add the `vipra-backend` project to the web server. -6. Clone the project repository and build the projects +7. Clone the project repository and edit the build.sh script ```bash git clone https://somerepo.url/vipra.git cd vipra + nano build.sh + ``` + + make sure the 'TOMCAT_WEBAPPS' path points to the webapps directory of the Tomcat installation, if you want the WAR file to be deployed automatically. + + to build the projects, run: + ```bash ./build.sh ``` - -7. Build **dtm binaries**. The repository was added to the vipra project because the original repository is/was hosted on [Google Code](https://code.google.com/archive/p/princeton-statistical-learning/downloads). Refer to dtm_release/README if problems during the build arise. + + if auto deployment is disabled to the path to the webapps directory is wrong, you need to manually copy `./vipra-backend/target/vipra.war` to your servers web application directory. + + to check if the web application is runnung, run: ```bash - cd dtm_release - make + curl -XGET 'http://localhost:8080/vipra/rest/info' ``` ### Troubleshooting