borsuksoftware/conical repository overview

Conical is a set of tools which can be integrated into your build-test-release process to simplify the process of collating all of your test results so that release decisions can be made more quickly and with greater confidence.

More information and licence terms can be found at https://conical.cloud⁠

⁠Installation Guide

To use the tool, it's necessary to have access to a SQL server instance (2016 onwards). This can be based locally or be cloud based.

In addition to the DB requirement, the tool itself stores its data within /var/conical. This should be mounted if one wishes to persist the settings and data etc. outside of the container / choose where the data is physically stored.

To install the tool, simply run

docker container run --name conicaltest -p:5000:5000 -d borsuksoftware/conical:latest

⁠Configuring your instance

Once your server is up and running, then a installation wizard will be presented and the server can be configured by following the steps on screen.

Note that the installation wizard does support expose a REST API which can be used to automate the installation process if desired.

⁠Updating

When upgrading to the latest version of the tool, simply download the latest image and update your container.

Note that the tool does store data within its settings directory so if you're going to upgrade an instance, please ensure that the tool's directory is mounted / persisted externally to the original container otherwise you will lose your data.

⁠Example - fully local instance for testing

For testing purposes, it's possible to use a local instance of SQL server (please ensure that your usage is consistent with the MS license). To set this up, you can use the following:

docker network create conical-test
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=Password123!" -d --network conical-test --restart always --hostname sqlserver --name conical-test-sqlserver mcr.microsoft.com/mssql/server:2019-latest
[Wait until your SQL server instance is up]
docker container exec conical-test-sqlserver /opt/mssql-tools18/bin/sqlcmd -S sqlserver -U sa -P "Password123!" -C -Q "CREATE DATABASE CONICAL"
docker run --network conical-test --name conical-test-instance -d -p:5000:5000 borsuksoftware/conical:latest

When running in the installation wizard, the connection details would be 'server = sqlserver; database = CONICAL; user = sa; password = Password123!'

Note that our production passwords are not Password123! :-)

⁠HTTPS support / public hosting

A reverse proxy can be used to expose an instance of Conical over https. Instructions on how to do this can be found on the websites of your chosen reverse proxy (we use nginx but there's no requirement to do so).