1 – Copy files

A download link to a zip file with the exact version will be provided separately. Please contact support@curiosity.software for more information.
Download, transfer and unzip the provided ZIP file to the Linux server.

2 – Install Docker

Test Modeller API and web will be run as docker services.
Install Docker on a supported Linux distribution following the official instructions: https://docs.docker.com/engine/installation/

3 – Install Docker-Compose

Docker Compose is a utility that simplifies the deployment and management of complete stacks. Follow the official instructions for installation:
https://docs.docker.com/compose/install/

4 – Configuring the Test Modeller Services

4.1 Basic configuration

Open the .env file in the in the unzipped folder for editing.
Change the following environment variables:

Variable

Default

Replace with

HOST_ADDRESS

localhost

The machine name of the Linux host machine. This will be the URL that Test Modeller is accessed by in the browser.

HOST_PROTOCOL

*http://*

https:// if SSL is enabled. Default value is usually sufficient.

HOST_PORT

80

443 if protocol is https:// Alternatively, any other port if 80 is not available on the host machine. Default value is usually sufficient.

LIC_OWNER

 

The license owner as provided.

LIC_KEY

 

The license key as provided




Storage on the host machine
The host machine will store the database data for Test Modeller, and so the directories that store it must be created and accessible. By default, the following two directories must be created on the host machine:

mkdir /data/postgres
mkdir /data/neo4j

If you wish to use other directories, you must edit the docker-compose.yml file and replace the following sections with your host machine directories:

services:
postgres_db:

volumes:
- /data/postgres:/var/lib/postgresql/data

neo4j_db:

volumes:
- /data/neo4j/data:/data

4.2 Advanced configuration

For an advanced configuration you may need to edit further configurations with environment variables or changing the docker-compose.yml file, as advised during the installation procedure by curiosity. A list of the variables available for configuration is provided below.

TestModeller_Web

Variable

Default

Description

HOST

localhost

Host name of the machine (IP address to be used to externally access server)

HOST_ADDR

*http://Localhost*

Host address with protocol (http or https)

API_ADDR

{*}http://localhost:8080*

API location – default same machine on port 8080

TestModeller_API

Variable

Default

Description

DATA_HOST

 

Postgres server location

DATA_USER

 

Postgres username

DATA_PASS

 

Postgres password

API_URL

 

Hostname of the API

GRAPH_HOST

 

Neo4j server location

GRAPH_PASSWORD

 

Neo4j password

GRAPH_USER

 

Neo4j Username

INSTALL_URL

 

Install URL of the webserver

SERVER_PORT

8080

Port to host the server

EMAIL_AUTH*

True

Email auth

EMAIL_HOST*

 

Email host

EMAIL_PASS*

 

Email pass

EMAIL_PORT*

 

Email port

EMAIL_TRANSPORT*

 

Email transport (smtp)

EMAIL_USER*

 

Email username

LIC_OWNER

Provided by Curiosity Software

License owner

LIC_KEY

Provided by Curiosity Software

License key

* Default email details are connected in the server for info@testmodeller.io

5 – Start the Test Modeller Services

Execute the run.sh script to load the containers and start up the services.
Note: you may need to run these commands using sudo.

sudo ./run.sh

6 – Verify the deployment

Navigate to machine host and test you can sign in.

This should bring up Test Modeller.

  • Enter login credentials

The Default administrator user is:
Username: admin@testmodeller.io
Password: Admin01!
We recommend you can change this once logged in.

  • Navigate to Models

You should see the default set of demo models installed.