Skip to content

Latest commit

 

History

History
97 lines (56 loc) · 3.55 KB

running-eiffel-intelligence.md

File metadata and controls

97 lines (56 loc) · 3.55 KB
Raw

Running Eiffel Intelligence

Prerequisites

Eiffel Intelligence is a Spring microservice distributed in a war file.

Eiffel Intelligence release war files can be downloaded from JitPack: jitpack.io and look for the latest version. Now replace the latest version in the link below:

https://jitpack.io/com/github/eiffel-community/eiffel-intelligence/<version>/eiffel-intelligence-<version>.war

Running with Maven Command

If you want to test the latest code in github clone the project and compile it with:

mvn clean install

append -DskipTests if you want to skip the tests since the latest on master always has passed the tests. The war file should now be found under target folder in your cloned project.

If you run from source code, you can run Eiffel-Intelligence front-end with maven command:

mvn spring-boot:run

With properties added to the maven command, e.g:

mvn spring-boot:run -Dlogging.level.com.ericsson.ei=DEBUG -Dspring.data.mongodb.port=27019

Running with Java command

Another option is to run the executable war file with java command. If running from source code, war file is generated and produced by maven command (mvn install command can be used as well):

mvn package -DskipTests

This command should produce an eiffel-intelligence-<version>.war file in target folder, target/eiffel-intelligence-<version>.war.

The war file is executed by the following command and with default configuration:

java -jar eiffel-intelligence-<version>.war

Own configuration can be provided with

java -jar eiffel-intelligence-<version>.war --spring.config.location=<path to own application.properties>

remember to keep the name of the properties file if you are a beginner to Spring. More advanced Spring user can look here for more information about using external configuration.

If a few properties need to be overridden, then use java opts, for example:

java -jar eiffel-intelligence-<version>.war -Dspring.data.mongodb.port=27019

Running in Tomcat Instance

To run Eiffel Intelligence in Tomcat, the war file must be put into the webapp folder in tomcat installation folder, also called catalina home folder:

(catalina home)/webapp/

If Eiffel Intelligence should be run without any context-path in the url address, then overwrite ROOT.war file in webapp folder with eiffel-intelligence-<version>.war:

cp eiffel-intelligence-<version>.war (catalina home)/webapp/ROOT.war

Remove "ROOT" folder in webapp folder:

rm -rf (catalina home)/webapp/ROOT/

Create "config" folder in catalina home folder, if it doesn't exist. Spring and Eiffel Intelligence will look for the application.properties configuration file in config folder:

mkdir (catalina home)/config

Copy the application.properties file into the newly created config folder:

cp application.properties (catalina home)/config

Start Tomcat and Eiffel Intelligence in background/daemon mode by executing command:

(catalina home)/bin/catalina.sh start

To run Tomcat and Eiffel Intelligence with logs printed to console:

(catalina home)/bin/catalina.sh run

Eiffel Intelligence Configurations and Properties

All available Eiffel Intelligence properties can be found in application.properties example file.

More documentation of each Eiffel Intelligence property and configurations can be found in the Configuration page