The interoperability test platform is built using Docker, which means that it can run on any environment which supports Docker. Installation guides for Docker are available for Ubuntu, macOS and Windows.
Additionally, the platform is developed using microservices which are
Windows and macOS,
docker-compose should be installed automatically with
Docker. On a Linux host,
docker-compose must be installed separately using
You can check that both Docker and
docker-compose have been correctly
installed by running the following commands on your machine:
Finally, we recommend the use of
git to download source code and fetch
updates. Installation guides for
git for all platforms can be found
To simplify installation, we have prepared a template repository with example configurations for installation here. To begin with, click "Use this template" to make a copy of the repository in your own namespace. Once the template has been applied, you can copy the configuration files onto your host machine using git:
Certain configuration files must be adjusted to customise the test platform to
your own environment. More detail on the configuration options required is
available in the README file within the repository (and is guaranteed to be up
to date with the version of
interop-release-configuration you are using). In
particular, you should take note of the platform version which is configured
Once the configuration files have been adjusted, you should be able to launch all services using the following command:
This will download Docker images corresponding to the appropriate version of the test platform, and launch them on your system.
At this point,
docker-compose has launched all services required for the test
platform, but they will require further set-up. You can now set up the database
by running the migration script.
Note that this command will perform a "factory reset" on the database.
At this point, all services are set up, and you should be able to log in. You
should now be able to browse to the domain you configured in
.env and see a
Updating the test platform is very straightforward and unlikely to cause any data loss. Before you proceed, you may nonetheless choose to make a backup of your database with the following command:
This will place a
.sql dump file inside the your working directory.
To update the project code, update the version number inside docker-compose, and then pull the new images:
Once you have obtained the latest code, you can restart the services, install
any missing dependencies and update the database structure using another