Graphileon Server edition Docker installation

Docker

Before proceeding with the installation, please install the Docker engine on the system. Instructions on how to install Docker can be found on the official Docker website. Graphileon Docker image was built with Docker version 3.3 and should be compatible with all later versions.

After installing and running Docker, download the Graphileon Docker image and import it with the following command.

docker load -i /path/to/graphileon-<version>-docker.tar.gz

Start Graphileon

Graphileon is then started with the following command:

docker run \
-p $HTTP_HOST_PORT:$HTTP_DOCKER_PORT \
-p $HTTPS_HOST_PORT:$HTTPS_DOCKER_PORT \
-v $LOG:/log \
-v $PERSISTENT:/persistent \
-v $CONFIG:/config \
-v $SSL:/ssl \
graphileon

Where:

• $HTTP_HOST_PORT refers to the port on the host machine that is used to connect to Graphileon.
• $HTTPS_HOST_PORT refers to (optional) the port on the host machine that is used to connect to Graphileon with secure connections.
• $HTTP_DOCKER_PORT is the port on the Docker machine that Graphileon listens to for HTTP requests. You can set this in config.json. Default 3000
• $HTTPS_DOCKER_PORT is the (optional) port on the Docker machine that Graphileon listens to for HTTPS requests. You can set this in config.json. Default 3001
• $LOG: path to a folder on the host machine where Graphileon will put log files
• $PERSISTENT: path to a folder on the host machine where Graphileon will store uploaded files
• $CONFIG: path to a folder on the host machine where Graphileon should store configuration files. Here you will find config.json. Default ~/.config/Graphileon/config/config.json
• $SSL: (optional) path to a folder on the host machine where Graphileon will load SSL key.pem and cert.pem. files from. You need to provide/generate these files

Example Run:

docker run \
-p 3000:3000 \
-v $HOME/graphileon/log:/log \
-v $HOME/graphileon/persistent:/persistent \
-v $HOME/graphileon/config:/config \
graphileon

On success, expect to see output similar to the following:

<info> logger initialized (in graphileon-server.js:47)
<log> app listening on port 3000 (in graphileon-server.js:47)

Stop Graphileon

To stop Graphileon, press Ctrl-C.

How to Configure?

You can find the configuration file config.json in the $CONFIG folder.

You should set:

• port: the $HTTP_DOCKER_PORT port Graphileon server will listen to (inside docker container / vm)

• https port: the $HTTPS_DOCKER_PORT port Graphileon server will listen to, for example:

    "https" {
    	"port": 3001
    }
  

• allowedDomains: a list of requesting domains the server is allowed to respond to. Add here http://$SERVER_ADDRESS:$HTTP_HOST_PORT and https://$SERVER_ADDRESS:$HTTPS_HOST_PORT (where $SERVER_ADDRESS is the domain and/or port of the host machine)

If you change any configuration you need to restart Graphileon: stop and rerun the start command. 

Set up Graphileon

Graphileon is now ready to be set up. To access Graphileon, point your browser to

https://$SERVER_ADDRESS:$HTTPS_HOST_PORT or http://$SERVER_ADDRESS:$HTTP_HOST_PORT where $SERVER_ADDRESS is the ip or domain name of the host machine and $HTTP_HOST_PORT or $HTTPS_HOST_PORT are the ports configured earlier.

Add an application store

Graphileon needs an application store to store its function nodes. [image] Be sure to test the connection before you save your store settings. 

Add additional graph stores

We recommend creating separate stores for storing business data. Using a single store for both Graphileon functions and business data may lead to undesired side effects.

Be sure to test the connection before you save your store settings.

Add user(s)

Users can be added on the Users tab on the Settings page.

You need at least one user with Admin Rights. 

Add the license information to the Settings page.

You can find the license information in Appendix A to the Software license agreement. It has the format:

[BEGIN]
Expires:yyyy-mm-dd
key:XXXXX-XXXXX-XXXXX
Name:[name licensee]
...
[END]

This information, including the [BEGIN] and [END] tag, has to be pasted into the License Information field on the Settings page.

Apply settings

After having set up the application stores, additional data stores, creating users and having provided the license information, click 'Apply Settings'. Graphileon will take you to the login screen.