Version: ≥4.3.x
Welcome to EDDI!
This article will help you to get started with EDDI.
You have two options to run EDDI, The most convenient way is to run EDDI with Docker. Alternatively, of course, you can run EDDI also from the source by checking out the git repository and build the project with maven using either the mvn
command line or an IDE such as eclipse.
There are two ways to use Docker
with EDDI, either with docker-compose
or launch the container manually.
Prerequisite: You need an up and running Docker
environment. (For references, see: https://docs.docker.com/learn/)
Checkout
the docker-compose
file from Github
:https://github.com/labsai/EDDI/blob/master/docker-compose.yml
Run Docker Command:
docker-compose up
Start a MongoDB
instance using the MongoDB
Docker
image:
docker run --name mongodb -e MONGODB_DBNAME=eddi -d mongo
Start EDDI :
docker run --name eddi -e "EDDI_ENV=production" --link mongodb:mongodb -p 7070:7070 -d labsai/eddi
Checkout
from Github
Java 11
Maven 3
MongoDb
Download and Install MongoDB
(Version >= 3.x)
Run MongoDB
on default port 27017 (this step is important before you run EDDI):
mongod --dbpath [ABS_PATH_TO_DATA]
Go to the root directory and execute:
mvn clean install
Important for eclipse users: If you are planning to browse and build EDDI's code from eclipse, you must take in consideration that EDDI uses project Lombok, so you must add it to eclipse classpath, this can be done easily by executing this jar:
.m2\repository\org\projectlombok\lombok\1.16.18\lombok-1.16.18.jar
1 - Launch EDDI's ApiServer class with VM options
-DEDDI_ENV=[development/production]
Example :
-DEDDI_ENV=development
2 - Set the working directory to apiserver
3 - Go to the browser --> http://localhost:7070
You can overwrite all configs within EDDI
either by altering the configs itself or - for convenience reasons (especially when running as the container) - by passing on VM params.
Example:
-DEDDI_ENV=[development/production] **-Dmongodb.hosts=somehost** -Duser.dir=[LOCAL_PATH_TO_EDDI]\apiserver ai.labs.api.ApiServer
1 - launch EDDI's ApiServer
from the packaged ZIP
file apiserver/target/apiserver-4.3-package.zip
with VM options :
-DEDDI_ENV=[development/production] -Duser.dir=[LOCAL_PATH_TO_EDDI]\apiserver ai.labs.api.ApiServeror use .\apiserver\ApiServerStartup.bat resp. ./apiserver/ApiServerStartup.sh
2 - Go to Browser --> http://localhost:7070
Passing it on to a Docker
container (either plain/docker-compose/kubernetes
), every environment variable name starting with "EDDI_JAVA_ENV_
" will be automatically picked up by EDDI.
Example:
EDDI_JAVA_ENV_MONGODB_HOSTS=mongodb.hosts=somehost
Would end up as VM param in EDDI
-Dmongodb.hosts=somehost