Merge pull request #85 from delphi-hub/feature/deploy_script

Deployment script for Linux added

Author: johannesduesing

Delphi_install.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+####DELPHI INSTALLATION#####
+#########################
+
+LOGFILE=$HOME/`date "+%F_%T"`\_$SUDO_USER.log
+sudo touch $LOGFILE
+sudo chown $SUDO_USER $LOGFILE
+
+echo " Starting installation of Delphi Application"
+echo " Logs can be found at: $LOGFILE"
+
+
+sudo -u $SUDO_USER bash -c "git clone --progress https://github.com/delphi-hub/delphi.git --recurse-submodules>> $LOGFILE"
+echo " **Cloning of Delphi Repositories completed**"
+
+
+#######Docker Setup######
+#########################
+# Testing purposes:
+# sudo apt-get purge docker-ce
+# sudo rm -rf /var/lib/docker
+# sudo rm -rf /etc/docker
+# sudo groupdel docker
+
+
+## Installing Images and Creating Volumes
+    
+echo " Building Delphi Images. This step might take several minutes"
+sudo -u $SUDO_USER bash -c "sbt docker:publishLocal &>> $LOGFILE"
+echo " Delphi-Registry Image built" 
+sudo -u $SUDO_USER bash -c "(cd ./delphi/delphi-webapi;sbt docker:publishLocal) &>> $LOGFILE"
+echo " Delphi-WebApi Image built" 
+sudo -u $SUDO_USER bash -c "(cd ./delphi/delphi-webapp;sbt docker:publishLocal) &>> $LOGFILE"
+echo " Delphi-WebApp Image built" 
+sudo -u $SUDO_USER bash -c "(cd ./delphi/delphi-crawler;sbt docker:publishLocal) &>> $LOGFILE"
+echo " Delphi-Crawler Image built" 
+sudo -u $SUDO_USER bash -c "(cd ./delphi/delphi-management;sbt docker:publishLocal) &>> $LOGFILE"
+echo " Delphi-Management Image built"
+bash -c "docker images >> $LOGFILE"
+
+
+echo " **Docker Images for all the components built successfully**"
+
+
+#########Finished########
+#########################
+
+echo " For more information regarding the application, please have a look at the Readme file found at: https://github.com/delphi-hub/delphi-registry/blob/master/README.md"
+
+
+

README.md

@@ -20,17 +20,24 @@ The Delphi registry is a server that provides access to all information and oper
 ## Requirements
 In order to compile or execute the instance registry, you must have the latest version of the *Scala Build Tool* (SBT) installed. You can get it [here](https://www.scala-sbt.org/).
 
-The Delphi registry requires a docker host to deploy containers to. The following images must be registered at the docker registry:
+The Delphi registry requires a docker host to deploy containers. The following images must be registered at the docker registry:
 * The Delphi Crawler ( ```delphi-crawler:1.0.0-SNAPSHOT``` )
 * The Delphi WebApi ( ```delphi-webapi:1.0.0-SNAPSHOT``` )
 * The Delphi WebApp ( ```delphi-webapp:1.0.0-SNAPSHOT``` )
 
-To obtain these images, checkout the respective repositories ([here](https://github.com/delphi-hub/delphi-crawler), [here](https://github.com/delphi-hub/delphi-webapi) and [here](https://github.com/delphi-hub/delphi-webapp)) and execute the command 
+For Windows users, to obtain these images, checkout the respective repositories ([here](https://github.com/delphi-hub/delphi-crawler), [here](https://github.com/delphi-hub/delphi-webapi) and [here](https://github.com/delphi-hub/delphi-webapp)) and execute the command 
 
 ```
 sbt docker:publishLocal
 ```
-inside their root directory. This will build the docker images and register them directly at the local docker registry.
+inside their root directory. This will build the docker images and register them directly at the local docker registry. <br /> 
+
+For Linux users, checkout Delphi Registry repository and execute the command
+
+```
+sudo bash ./Delphi_install.sh
+``` 
+inside the registry's root directory. This installation script will create the required repositories, build the docker images, and register them directly at the local docker registry. 
 The registry requires an initial instance of ElasticSearch to be running.
 
 ## Authorization
@@ -111,8 +118,8 @@ There are two ways of running the registry application. You can either run the a
 ### Run the registry directly
 If you want to execute the registry directly on your local machine, simply go to the root folder of the repository and execute ```sbt run```. The application will stream all logging output to the terminal. You can terminate any time by pressing *RETURN*.
 ### Run the registry in Docker
-For building a docker image containing the registry, go to the root folder of the repository and execute ```sbt docker:publishLocal```. This will build the application, create a docker image named ```delphi-registry:1.0.0-SNAPSHOT```, and register the image at your local docker registry.
-
+For Windows users, to build a docker image containing the registry, go to the root folder of the repository and execute ```sbt docker:publishLocal```. This will build the application, create a docker image named ```delphi-registry:1.0.0-SNAPSHOT```, and register the image at your local docker registry.<br />
+For Linux users, the installation script mentioned in **Requirements** section will create docker image for registry named ```delphi-registry:1.0.0-SNAPSHOT```, and registers the image at your local docker registry.
 
 ## Contributing
 
@@ -134,3 +141,4 @@ chat for a more interactive experience.
 The Delphi registry is open source and available under Apache 2 License.
 
 [![GitHub license](https://img.shields.io/github/license/delphi-hub/delphi-registry.svg)](https://github.com/delphi-hub/delphi-registry/blob/master/LICENSE)
+