This page describes how to install our InterActor Community Edition. Although we've done our best to provide a good instruction to get you started, there may always been things we have not covered and which need additional explanation. The best place to look for answers to your questions is our InterActor-users team on Slack. Feel free to send a message to email@example.com so we can send you an invite.
The use of InterActor Community Edition is subject to the InterActor Community Edition End User License Agreement.
STEP 1. Install Neo4j
To use InterActor Community Edition, you need access to a Neo4j graph store. If you don't have one yet, you can download Neo4j from the Neo4j website, or use a cloud service like GrapheneDB or GraphStory. Otherwise, just skip this step.
Once you have verified that your Neo4j instance is running smoothly, keep the following information at hand:
- The address of your Neo4j server
- Port number (Neo4j's default port is :7474)
- Neo4j user name
- Neo4j user password
By default, Neo4j only listens to localhost. If you install InterActor in a way that you need remote access, you have to change the settings in the neo4j.conf file and set the port to which Neo4j is listening.
So, in case you use the default port, change this line in neo4j.conf:
After saving the neo4j.conf file, you need to restart Neo4j.
Firewalls et cetera have to be configured accordingly as well.
For Windows 10: check whether the Firewall is configured correctly, go to Control Panel > System and Security > Windows Firewall > Allowed Apps and look for "neo4j-ce".
If you're on a public network, make sure the "Public" column is checked. On a private network, make sure the "Private" column is checked.
STEP 2. Install and start the Docker Engine
Next step is to install and start the Docker engine on your system. Same here, if you have installed it already and it runs smoothly, skip this step.
Please follow the instructions on the Docker Site. Depending on the configuration of your system, you will need to install the native application, or the Docker Toolbox, which includes a complete Docker environment running in a virtual machine on your computer.
Docker as a native application
If you are running Docker as a native application for your system, you can now go to step 3.
If you use the Docker Toolbox, get the IP-address that Docker is using. If you use Docker's default settings, this is how to do it using the terminal / console
$ docker-machine ip default
STEP 3. Load and run the Interactor Community Edition Docker image
We distribute InterActor as a Docker image. You can install the image in two ways:
- Direct Download: You can get the latest version either by clicking here. Then, in your terminal, navigate to your download directory and type
$ docker load < interactor-community-image-latest.tar.gz
- Docker Hub: You can get the latest version also from Docker Hub, by typing
$ docker pull graphileon/interactor-community
Now run the InterActor image using the following command, which will also create a volume "interactor" where persistent data (the config, and files you upload to InterActor) will be stored.
$ docker run -t -d -p 8000:80 --name interactor -v interactor:/persistent/ graphileon/interactor-community 778a9a7f373fc040e1adb3af446d7f2bfab9d82d15d82e5871c9658b54036a78
Now Docker should return InterActor in its list of running images.
$ docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 778a9a7f373f graphileon/interactor-community "/bin/sh -c 'HOST=$(n" 16 seconds ago Up 15 seconds 443/tcp, 0.0.0.0:8000->80/tcp interactor
To restart a the InterActor docker container, run the commands:
$ docker kill interactor # only necessary if an interactor container is currently running (docker ps). interactor $ docker rm interactor interactor
STEP 4. Go to the InterActor site
The url that InterActor can be accessed at consists of an address and a port.
The address for those who use the native Docker application is
http://localhost, for Docker Toolbox it is the IP address we found in step 2.2.
The port is the one that we specified in the run command to start InterActor. Based on the above, the complete URL would be:
- Docker native: http://localhost:8000
- Docker Toolbox: http://192.168.99.100:8000
When you run InterActor for the first time, you'll be redirected to the InterActor Settings page, where you'll be prompted to enter user credentials that you want to use to access InterActor, as well as the connection settings of your Neo4j instance.
After clicking "Apply Settings", InterActor will do a one-time installation,
creating nodes and relationships in your Neo4j instance. These nodes will
have labels starting with
IA_, which allows you to recognize them easily.
Local machine IP address
If your Neo4j instance runs on the same machine as your Docker instance, the ip address you need enter as Neo4j host may differ from machine to machine. Below are the default IP addresses for the most common operation systems and Docker versions:
|Configuration||IP Address||How to find it|
|Linux/MacOS & Docker Native||172.17.0.2||Run
|Windows & Docker Native||10.0.75.1||In PowerShell (or Command Prompt), run
|MacOS & Docker Toolbox||10.0.2.2||This is the IP address VirtualBox uses to address the host machine from a virtual machine.|
Confirm all settings before clicking 'Apply Settings'. InterActor will then start the installation.
STEP 5. Let's InterAct!
If everything went well, you should see the login dialog.