Skip to content
This repository was archived by the owner on Jun 5, 2019. It is now read-only.

Back-end

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

Back-end

README.md

Backend

Tested software environment

(With front-end and back-end on the same server) Ubuntu 18.04.1 LTS

default-jdk 2:1.10-63ubuntu1\~02 amd64
default-jdk-headless 2:1.10-63ubuntu1\~02 amd64
openjdk-11-jdk:amd64 10.0.2+13-1ubuntu0.18.04.4 amd64
openjdk-11-jdk-headless:amd64     10.0.2+13-1ubuntu0.18.04.4 amd64
openjdk-11-jre:amd64 10.0.2+13-1ubuntu0.18.04.4 amd64
openjdk-11-jre-headless:amd64 10.0.2+13-1ubuntu0.18.04.4 amd64

kafka_2.12-2.1.0
zookeeper 3.4.10-3--1

mongodb-org 4.0.5 amd64
mongodb-org-mongos 4.0.5 amd64
mongodb-org-server 4.0.5 amd64
mongodb-org-shell 4.0.5 amd64
mongodb-org-tools 4.0.5 amd64

tomcat 8

nodejs 10.15.0

Alternative software environment

(With frontend and back-end on the same server)

  • FreeBSD 13.0-CURRENT
  • openjdk8-8.192.26
  • kafka-2.1.0
  • zookeeper-3.4.12
  • mongodb36-3.6.6_2
  • tomcat9-9.0.13

You will also need node.js 10+ (with npm 6+) to build the frontend modules. Consider using nvm to manage multiple node installations on your system.

Configuration of the webserver

The following setup uses one webserver for both the frontend (the website that the user accesses) and the back-end (the database accessed from the frontend javascript program).

Backend dependencies

1. MongoDB >= 4.0.6

The Mongo service needs to be running and a user account with read/write for all collections and databases as well as a AdinInspector Database and an authentication database under an 'admin' database.

A dump containing all relevant databases and the provided test datasets can be found on this directory under dump/.

To export it you can use the mongorestore utility.

Make sure that the mongo service is running, if not run sudo service mongod start

i.e. run mongorestore -u "ADMINUSER" -p "PASS" on the same directory as the dump/ directory.

2. Kafka 2.1.0

Installation instructions for Kafka can be found here

The programm needs the Kafka server to be up and the Kafka server needs Zookeper to be started.

Navigate to the kafka installation directory.

start zookeper :

sudo bin/zookeeper-server-start.sh config/zookeeper.properties

start Kafka :

sudo bin/kafka-server-start.sh config/server.properties

3. Apache Tomcat server

Installing Tomcat:

see e.g.

https://www.digitalocean.com/community/tutorials/install-tomcat-9-ubuntu-1804

Configuring Tomcat:

This may vary depending on the specific underlying OS. On digital ocean's droplet hooking tomcat up to the systemd demon resulted in the server aborting and restarting in a loop. Starting tomcat manually instead works.

Change to the tomcat base directory (when following the tutorial above from digitalocean, this will be /opt/tomcat).

cd conf
# edit the file catalina.properties to append the following line:
java.security.egd=file:/dev/./urandom

Copy the file Back-end/tomcat-conf/server.xml to /opt/tomcat/conf/server.xml

This file is set up to make use of a certificate in /etc/letsencrypt/ to enable https connections, i.e. SSL encryption. Tomcat will still run without such a certificate, but only http:// connections will be available.

You can get a certificate from e.g. Let's Encrypt.

Building the .jar file (the servlet) from the java source

Fetch the repository, then run the following commands:

cd implementation/Back-end
mvn clean compile assembly:single

This will produce the file target/adininspector-backend-0.0.1-SNAPSHOT-jar-with-dependencies.jar and bundle all necessary dependencies with it.

Installing the webapps/adininspector content

step 1

  • copy adininspector-backend-0.0.1-SNAPSHOT-jar-with-dependencies.jar from implementation/Back-end/target/ to /opt/tomcat/webapps/adininspector/WEB-INF/lib/

  • optional, for testing: copy websockclient2.html to webapps/adininspector/ (this is a tool for low-level testing of the websocket connection to the server and the database access)

step 2

/opt/tomcat/webapps/implementation/frontend
/opt/tomcat/webapps/implementation/login-frontend

step 3

Adjust the following two files to use the correct address for your host: in frontend/src/stores/user.js the line

wsEndpointURL = "wss://adininspector.currno.de/adininspector/adinhubsoc2";

and in login-frontend/src/components/UserForm.js the line

placeholder = "wss://adininspector.currno.de/adininspector/adinhubsoc2";

(the path '/adininspector/adinhubsoc2' should stay unchanged.)

If you are using the http protocol (i.e. if you haven't set up a ssl certificate) you also have to replace wss: with ws: in those two lines.

step 4

now, as root, run these two scripts:

frontend/bin/redeploy-login.sh
frontend/bin/redeploy-main-frontend.sh

to build and bundle the javascript source code.

Starting the Apache Tomcat server

If tomcat only uses ports > 1024 (e.g. 8080) you can run it as user tomcat:

sudo -u tomcat bash
cd /opt/tomcat
./bin/catalina.sh start

otherwise (when using the default http and https ports) run it as root:

sudo bash
cd /opt/tomcat
./bin/catalina.sh start

To check if it started successfully, check the main log file, ./logs/catalina.out , for a line like this:

18-Feb-2019 19:50:36.430 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in [81,226] milliseconds

to stop the tomcat server:

./bin/catalina.sh stop

Notes on dependencies and configuration files

In order to run this code there are 2 dependencies that need to met.

  1. MongoDB 4.0.6

The Mongo service needs to be running and a user account with read/write for all collections and databases as well as a AdinInspector Database and an authentication database under an 'admin' database.

A dump containing all relevant databases and the provided test datasets can be found on the root directory of the implementation under dump/. To export it you can use the mongorestore utility

  1. Kafka 2.1.0

Installation instructions for Kafka can be found here

The programm needs the Kafka server to be up and the Kafka server needs Zookeper to be started.

Notes On how to build

To build the back-end, use maven with build goals "clean compile assembly:single". This should produce the file target/adininspector-backend-0.0.1-SNAPSHOT-jar-with-dependencies.jar and bundle all necessary dependencies with it.

For more details please refer to the documents repository.

  1. Tomcat

Templates for tomcat configuration files are in tomcat-conf. See tomcat-conf/README.md

For the complete setup instructions, please see https://github.com/DHSTTOS/documents/blob/master/implementation/deployment.md

Credits

Mario Gonzalez - Database Management storage, provision and communication with Kafka

Philipp Mergenthaler - Client-Server Communication, Data Visualization