Installation

Cantabular software package

Linux

Cantabular for Linux is supplied as a gzipped tar file named using the following convention:

cantabular-VERSION.linux_amd64.tar.gz

VERSION is a semantic version string, e.g. cantabular-6.0.0.linux_amd64.tar.gz.

The software can be extracted to the current directory using the tar command:

tar -xzf FILENAME.tar.gz

Windows

Cantabular for Windows is supplied as a zipped file named using the following convention:

cantabular-VERSION.windows_amd64.zip

VERSION is a semantic version string, e.g. cantabular-6.2.1.windows_amd64.zip.

The software can be extracted using any Windows utility that supports zip functionality.

Location

The Cantabular files can be installed anywhere on your file system according to your requirements. If they are to be run from a single user then they can be installed somewhere under that user’s home directory. Alternatively they could be installed in some system wide location e.g. in the /usr/local or /opt directories on a Linux system.

Services on Linux

If you wish to run Cantabular as a service on Linux then you would need to create appropriate configuration files for your Linux service manager (e.g. systemd).

These configuration files are typically fairly straightforward because the executables are long running processes that are configured using environment variables.

For systemd these are the default “simple” service type, e.g. for the server process:

[Unit]
Description=Cantabular Server
After=network-online.target
Wants=network-online.target

[Service]
User=ftb
WorkingDirectory=/home/ftb

Environment="CANTABULAR_API_LISTEN_ADDRESS=NNN.NNN.NNN.NNN:443"
Environment="CANTABULAR_API_LOCAL_LISTEN_ADDRESS=127.0.0.1:8491"

Environment="CANTABULAR_DATASETS=\
  dataset1.dat\
  dataset2.dat\
"

AmbientCapabilities=CAP_NET_BIND_SERVICE
ExecStart=/home/ftb/cantabular/bin/cantabular-server

[Install]
WantedBy=multi-user.target

For the user interface process:

[Unit]
Description=Cantabular UI
After=network-online.target
Wants=network-online.target

[Service]
User=ftb
WorkingDirectory=/home/ftb

Environment="CANTABULAR_UI_LISTEN_ADDRESS=NNN.NNN.NNN.NNN:443"
Environment="CANTABULAR_API_URL=http://127.0.0.1:8491/"

AmbientCapabilities=CAP_NET_BIND_SERVICE
ExecStart=/home/ftb/cantabular/bin/cantabular-ui

[Install]
WantedBy=multi-user.target

Services on Windows

Cantabular does not support running as a native Windows service at present. It could be run a service using a wrapper program. Please see https://en.wikipedia.org/wiki/Service_wrapper for an overview of these.

If you have a requirement for native Windows service support, please contact The Sensible Code Company.

License file

In order to use Cantabular a license file called license.txt should be copied to the same directory as the executables i.e. in the bin directory. Alternatively the full path of the license file can be specified using the CANTABULAR_LICENSE_FILE environment variable.

The license file does not form part of the release and will be provided by the Sensible Code Company through a separate channel.

Folder structure

The extracted files have the following folder structure:

cantabular-VERSION
├── bin
│   └── <Executables>
├── docs
│   └── <User documentation>
└── example
    └── <Example dataset>

• The root folder is cantabular-VERSION.

• All the Cantabular executables can be found in bin.

• User documentation (including this document) can be found in docs.

• An example dataset that can be used to validate the installation is found in example.