This document is a step-by-step guide to build Cortex from sources.
The following softwares are required to download and build Cortex.
- Java Development Kit 8 (JDK)
- downloadable from http://www.oracle.com/technetwork/java/javase/downloads/index.html
- git
- Use the system package or downloadable it from http://www.git-scm.com/downloads
- NodeJs with its package manager (NPM)
- downloadable from https://nodejs.org/en/download/
To install the requirements and build Cortex from sources, please follow the instructions below depending on your operating system.
sudo yum -y install git bzip2
sudo yum -y install java-1.8.0-openjdk-devel
Install the EPEL Repository:
You should have the "extras" repository enabled, then:
sudo yum -y install epel-release
Then, you can install NodeJs:
sudo yum -y install nodejs
sudo apt-get install git wget
echo 'deb http://ppa.launchpad.net/webupd8team/java/ubuntu trusty main' | sudo tee -a /etc/apt/sources.list.d/java.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-key EEA14886
sudo apt-get update
sudo apt-get install oracle-java8-installer
sudo apt-get install wget
wget -qO- https://deb.nodesource.com/setup_8.x | sudo bash -
sudo apt-get install nodejs
git clone https://github.com/CERT-BDF/Cortex.git
cd Cortex
./sbt clean stage
It will download all dependencies (could be long) then build the back-end.
This command clean previous build files and create an autonomous package in target/universal/stage
directory. This
packages contains Cortex binaries with required libraries (/lib
), configuration files
(/conf
) and startup scripts (/bin
).
Binaries are built and stored in Cortex/target/universal/stage/
. Install them in /opt/cortex
for example.
sudo cp -r Cortex/target/universal/stage /opt/cortex
Follow the configuration guide to run Cortex.
Follow First start in the Installation guide to start using Cortex.
Building back-end builds also front-end, so you don't need to build front-end separately. This section is useful only for troubleshooting or in order to install front-end in a reverse proxy.
Go to front-end directory:
cd Cortex/www
Install NodeJs libraries (required by building step), bower libraries (javascript libraries downloaded by browser). Then build the front-end :
npm install
npm run build
This step generates static files (html, javascript and related resources) in dist
directory. These files are ready to
be imported in http server.