Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Download links added
  • Loading branch information
peterbanda committed Jan 20, 2016
1 parent b26a544 commit ace46d0
Showing 1 changed file with 33 additions and 16 deletions.
49 changes: 33 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,26 @@ If you wish to collaborate in the development of this project contact me at `ban

Here we provide a step-by-step guide showing how COEL can be deployed locally to Linux-based OS such as Ubuntu and partially to Mac OS (not tested). For Windows you can still use this guide but you need to adjust the os-specific parts such as settings of environmental variables. This guide applies to the most recent COEL release - 0.8.3.

#### 1. Set up the environmental variables
#### 1. Install Java 1.7

* Download the file or copy paste the following:
* Install OpenJDK or Oracle JDK version 1.7 manually or by using the package manager:
```
sudo apt-get install openjdk-7-jdk
```
or
```
sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java7-installer
```
* Be sure that your `JAVA_HOME` points to the installation! For instance:
```
JAVA_HOME=/usr/lib/jvm/java-7-openjdk-amd64
```

#### 2. Set up the environmental variables

* Download the [file](http://peterbanda.net/coel/0.8.3/environmental_setting) or copy paste the following:
```
export COEL_DBUSER=coeladmin
export COEL_DBPASSWORD=CHANGE_ME
Expand All @@ -52,48 +69,48 @@ export COEL_EMAIL_PASSWORD=CHANGE_ME
* Override the variable values, especially those marked with `CHANGE_ME`.

* Copy the settings to the central init script such as `/etc/environment` (recommended), `.bashrc`, or `.bash_profile`.
Note that to load these variables, a new login or restart might be required.
Note that to load these variables a new login or restart might be required.

#### 2. Set up database
#### 3. Set up database

* Download and install PostgreSQL db server from [here](http://www.postgresql.org/download/) or using Ubuntu package manager as:</br>
`sudo apt-get install postgresql-9.4`

Note that we use the version 9.3 but any 9.x version should work.

* Download a zip containing COEL db init scripts and dump from [here](http://peterbanda.net) and unpack it.
* Download a zip containing COEL db init scripts and dump from [here](http://peterbanda.net/coel/0.8.3/db_init_scripts.zip) and unpack it.

* Open `create_db_and_user.sql` and set the password of the COEL db user. This must match the environmental settings from the step 1. Run `create_db_and_user.sh`.
* Open `create_db_and_user.sql` and set the password of the COEL db user. This must match the environmental settings from the step 2. Run `create_db_and_user.sh`.

* Run `restore_init_dump.sh`.

#### 3. Set up application server (Tomcat)
#### 4. Set up application server (Tomcat)
There are two options how to prepare Tomcat's app server hosting COEL app:

* All-in-one:
* Download a preconfigured Tomcat **including** the COEL prebuilt war from [here](https://peterbanda.net).
* Download a preconfigured Tomcat **including** the COEL prebuilt war from [here](https://peterbanda.net/coel/0.8.3/apache-tomcat-7.0.56_with_coel_0.8.3.zip).

* Tomcat and war separately:
* Download Tomcat 7.x.x version from [here](https://tomcat.apache.org/download-70.cgi).

* Download a prebuilt COEL app war from [here](https://peterbanda.net).
* Download a prebuilt COEL app war from [here](https://peterbanda.net/coel/0.8.3/coel-web-0.8.3.war).

* Move/copy the war to apache-tomcat-7.x.x/webapps and rename it to `ROOT.war`.
* Move/copy the war to `apache-tomcat-7.x.x/webapps` and rename it to `ROOT.war`.

#### 4. Set up GridGain computational fabric (optional)
#### 5. Set up GridGain computational fabric (optional)

The COEL app already comes with the GridGain lib and the technology is well integrated, however, if you want to spread the grid to several other nodes it is required to configure a standalone GridGain instance per each node.
The COEL app already comes with the GridGain lib and the technology is well integrated, however, if you want to spread the grid over several other nodes it is required to configure a standalone GridGain instance per each node.

* Download a preconfigured GridGain app and unzip. Note that we use the version 6.5.0 (community edition), which is freely available.
* Uncomment the GridGain environmental setting (step 1) and adjust the path accordingly
* Uncomment the GridGain environmental setting (step 2) and adjust the path accordingly
```
# uncomment and adapt the path if you installed gridgain
# export GRIDGAIN_HOME=/opt/gridgain-fabric-os-6.5.0
```
* Once the server hosting the master node is up (step 5) you can launch a new computational node by running
* Once the server hosting the master node is up (step 6) you can launch a new computational node by running
```
/gridgain-fabric-os-6.5.0/bin/start.sh
```
#### 5. Launch the application
#### 6. Launch the application

* Go to the Tomcat's bin folder such as `apache-tomcat-7.0.56/bin` and launch `startup.sh`. To stop the app run `startup.sh`.
* Go to the Tomcat's bin folder such as `apache-tomcat-7.0.56/bin` and launch `startup.sh`. To stop the app run `shutdown.sh`.

0 comments on commit ace46d0

Please sign in to comment.