Installing using Docker Image

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

Docker into a docker container from docker hub:

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

Alternatively if you want the latest build that is updated more regularly then you can use the snapshot tag, be warned this is not always as “tested” as the latest version.

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

An example docker-compose.yml file for a more repeatable installation process:

mycustodian:
  image: entitystream/custodian:latest
  entrypoint: java -Dswarm.http.port=80 -jar /entitystream/EntityStream-thorntail.jar 
  hostname: myhost
  restart: always
  ports: 
    - "80:80"
  environment:
    - dbLoc=/data/EntityStream
  volumes:
    - /entitystream/:data/EntityStream/

Volume Mapping: dbLoc is a key environment variable and it represents the location of all the EntityStream files on the container (including the database). The example maps the docker directory path to a path on the host located at /entitystream – you will be able to see the files on the host at this path.

To start the docker using the compose file (in the current directory):

 docker-compose up -d 

Upgrading

If you use the docker-compose.yml then you should follow these steps on the container host:

docker-compose pull
docker-compose down
docker-compose up -d

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.