Budapest HU
Sydney AU
London UK

Custodian Downloads

INSTALLATION INSTRUCTIONS

Generally we have made the product available to download in many forms, all these forms are based on the same code base and all functionality is similar between them. It is best to use the 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.
 

DOCKER INSTALLATION INSTRUCTIONS

You can install custodian from docker onto your own hardware in a docker container, or you can install into a google compute engine, both options are shown here. If you prefer you can also use the Azure platform – please search the Microsoft marketplace for a “EntityStream Custodian” or contact us for a direct link.
 

Docker into a docker container from docker hub:

docker pull entitystream/custodian:latest
docker run -p 8080:8080

Create a google compute engine from the google container repository:

 

docker pull gcr.io/entitystream-custodian/custodian:latest
docker run -p 8080:8080 gcr.io/entitystream-custodian/custodian:latest

 

Starting the Custodian Console interface – navigate to the following link on the install machine – http://localhost: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 (ESSServer) again to be able to complete the registration.

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

QUICK INSTALLATION INSTRUCTIONS

Download Links

Simply download the EntityStream v1.1 distributions – available at this links below – other required components will be installed automatically for you.

 
For other platform distributions, such as Linux or UNIX – then please contact us, we will supply you with compressed archives for the install.
 

Installing

  1. First download the installer for your operating system
  2. Run the installer (double click the file you downloaded and accept any messages)
  3. Notes: Also you will need to specify how much memory you allow EntityStream to run – it defaults to 1024m, but in installations with millions of records managed this will need to be bigger ie 8000m – ideally choose 50% of the available physical memory available on the server.

Running

At the end of the installation process the server will now be running.

To start it and stop it depends on your operating system –

Windows: use the services control panel to start and stop the ESS Server and ESS File Listener Services

MAC OSX: use the commands startESS.command and stopESS.command from the installation directory.

Starting the Custodian Console interface – navigate to the following link on the install machine – http://localhost: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 (ESSServer) again to be able to complete the registration.

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.

ADVANCED INSTALLATION

 

Advanced Pre-Requisities

 

To install EntityStream – depending on how much control you wish to have over the installation you will need some third party components, if you want us to use your chosen versions of them these need to be installed prior to attempting to install EntityStream.

  1. MongoDB 3.6 (community) or above – if we do not find it running on the same machine, we will automatically download and start it for you – to download load it for yourself it is available from this link. If you do choose to install it for yourself, on the same machine or another machine on the same network, then you need to let us know where it has been installed. During the installation you will be asked for its port:host location of the server – ie localhost:27017. If the server is not running at the time the server starts up – then we will assume you want us to run a mongo DB for you, and we will start it on the same machine as EntityStream.
  2. Java JDK 1.8 available from this link. You can install any 1.8 version of Java, we will check to see if Java is installed during the installation – if we can’t find it we will ask you if you would like us to download and install it for you.
All other instructions are as above.