- Docker Engine
- Docker Compose
- A Neo4j Enterprise Licence
- GraphAware Hume Commercial Licence ( Licence file and Docker Registry credentials )
# Additional info for running in the cloud
If you'll be running Hume on a cloud instance (Azure, EC2, etc.), there are some additional considerations:
- If you'll be running a large Neo4j graph on the same instance, we recommend following the best practice of attaching a disk, rather than using the OS disk. Many cloud providers limit OS disk size, and a large graph (especially with large text values typical for NLP use cases) can quickly outgrow them
- Your server should have a static IP address. Both Hume and Neo4j will need an advertised port to be remotely available, be sure to provision a static IP address to your server.
# What is included ?
- The standard Hume package running on port
8081(from now on, "Hume Core Services")
- The Hume Alerting Services package (optional)
publicdirectory accessible under the path
/datawhere you can place files to be used in Hume.
Since Alerting Services are optional, the following instructions will help you to install Hume with or without alerting capabilities.
# Download the Hume Installer
Download the Hume Installation Package and unzip it :
wget -O hume-2.9.11.zip https://hume-public.s3.eu-central-1.amazonaws.com/hume-2.9.11.zip unzip hume-2.9.11.zip cd hume-2.9.11
# Install Hume
Login to the GraphAware docker registry and enter your credentials:
docker login docker.graphaware.com
# Run Hume Core Services
Download the Hume docker images :
If you're running Hume on a remote instance, edit the included
.env file to set the appropriate advertised address to your static IP:
HUME_ADVERTISED_ADDRESS=[YOUR IP ADDRESS], and make sure the line is uncommented.
Moreover, if you need to enable alerting features , you'll have to edit the set the
.env file, by setting the flag
Otherwise, keep it
The Hume installation package includes the a Neo4j Enterprise container (Hume doesn't provide a Neo4j Enterprise licence), make sure you don't have a local Neo4j running on port 7474 and 7687.
If you'd prefer Hume not to run Neo4j, edit the
docker-compose.yml file and remove the
Postgres database runs by default on port 5432.
Set your docker resources at least for 6 GB memory.
docker-compose up -d
After a minute or two, Hume will be ready on port 8081
# Run Alerting Services
Most of the work has already been done. There are still a few steps to complete to spin up alerting features:
.env fileand enable alerting features by setting
If you had already spun up the core components with the above-mentioned flag set to
false, just run
docker-compose up -d api, otherwise nothing to do.
Run Hume Alerting Services by running this command.
docker-compose -f docker-compose-alerting.yml up -d
After a couple of minutes, you'll be able to play with alerting features.
# Install the licence
Head to http://localhost:8081 (opens new window) , the interface will prompt you to install your licence
# Create the Administrative User
You now need to create the Hume Administrative account - just provide a name, email and password and then click on Sign Up.
After this, you can log into Hume with the same account and follow one of our Getting Started Tutorials.