Installing on Unix

Generally we have made the product available to download in many forms and on many device types, all these forms are based on the same code base and all functionality is similar between them. It is best to use the snapshot docker installation as this will be updated much faster than the file downloads, but eventually they will be the same (within the hour). Also docker provides you with the ability to contain the product within the container and ensure that it doesn’t eat your memory and cpu time. 

Download here https://entitystream.com/resources/downloads/

This will save a file called EntityStream-thorntail.jar to your current directory, please move the file to somewhere more appropriate on your disk, such as in a folder named /usr/local/entitystream/

If you wish to control the location of the data (monsterDB database) on the machine then you can use the following environment variable to do this:

bash> export dbLoc=C:\entitystream

Next download and install java 1.8 – which can be downloaded from the oracle website here: https://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html

Finally start the Custodian server using the following command from a shell prompt

bash> java -jar EntityStream-thorntail.jar

The server will take between 1-2 minutes to start and finally once you see the messages below you can be sure it has started sucessfully:

2019-11-28 08:57:46,080 INFO  org.jboss.as.server WFLYSRV0010: Deployed "EntityStream.war" (runtime-name : "EntityStream.war")

2019-11-28 08:57:46,097 INFO  org.wildfly.swarm THORN99999: Thorntail is Ready

Starting the Custodian Console interface – navigate to the following link on the install machine – http://youripaddress:8080

You will be required on first use to register your installation using your google or linked in account – if you do not complete this process within one hour of the server starting then the server will shutdown and you will need to start it again to be able to complete the registration.

You will see in the terminal the following messages to indicate this:

*** SITE IS RUNNING A UNREGISTERED LICENSE AND IS NOT OPERATIONAL ***
*** SITE MUST BE REGISTERED WITHIN 1 HOUR ELSE IT WILL SHUTDOWN   ***

Starting as a daemon

On Linux environments it is easily possible to start Custodian when the server starts and to control it using the systemd service, here are some example son how this should be done.

Systemd service unit

First, we need to create a systemd startup script custodian-server.service and place it into /etc/systemd/system/ directory. You can find the example of such systemd startup script below:

[Unit]
After=monsterdb.service

[Service]
ExecStart=/usr/local/bin/custodian-server.sh

[Install]
WantedBy=default.target

After: Instructs systemd on when the script should be run.

ExecStart: This field provides a full path the actual script to be execute

WantedBy: Into what boot target the systemd unit should be installed

The above is an absolute minimum that our systemd service unit should contain in order to execute our script at the boot time. For more information and options to be used see systemd.service manual page:

$ man systemd.service

Startup shell scripts

Next, we create our custom shell script to be executed during systemd startup. The location and script name is already defined by service unit as /usr/local/bin/entitystream-server.sh. The content of the script can be simple as:

#!/bin/bash
set dbHost=localhost:27018
mv es.log es-1.log
java -jar entitystream-thorntail.jar > /usr/local/entitystream/logs/es.log

You probably need to define a monsterDB service too:

[Unit]
After=network.target

[Service]
ExecStart=/usr/local/bin/monsterDB-server.sh

[Install]
WantedBy=default.target

And also the shell script to start MonsterDB – monsterDB-server.sh

#!/bin/bash
set dbLoc=/usr/local/entitystream
java -jar monsterDB.jar -p 27018 -s -db ./one -n 0 > /usr/local/entitystream/logs/mdb.log

YOU ARE DOWNLOADING AN UNSUPPORTED INSTALLATION: IF YOU WISH FOR YOUR INSTALLATION TO BE SUPPORTED BY US, THEN YOU MUST PURCHASE A PAID SUPPORT PLAN.