Sophora Tools | Version 3

Sophora Tools Guide

Learn Details on Sophora Tools using the Sophora Client API.

Archived documentation for Sophora 3. End-of-support date for this version: 7/25/21

Documentation for Sophora 4

Sophora offers a variety of sophora tools connecting to the server using the Sophora Client. Therefore they all share some features that are directly based on client features. This page lists these features and how to use them.

Tools register themselves towards the server and the dashboard. You can change their hostname and port as described in this article.

Overwrite a Tool's Hostname and Port when Registering at the Sophora Server.

This section explains how to overwrite a tool's hostname and port when registering towards the Sophora Server.

Most Sophora tools explicitly register themselves towards the Sophora Server. This implies that they can be obtained from the Server's tools-API under

http://www.mysophoraserver.com:1196/content-api/tools

and furthermore they can be monitored by the Sophora Dashboard.

These tools therefore need to send their hostname and ports (http and/or https) in order to be observed. The tools can determine host and port on their own by using their own explicit configuration or system APIs.

However in some cases the hostname or port might not be accessible from the outside, e.g. if they reside behind a proxy. In these cases you might want to overwrite hostname and port.

Overwriting using environment variables

You can explicitly force the tool to use a certain hostname, http port and https port when registering towards the server by setting these environment variables:

  • SOPHORA_CLIENT_HOSTNAME
  • SOPHORA_CLIENT_HTTP_PORT
  • SOPHORA_CLIENT_HTTPS_PORT

It is not necessary to set all of them.

Overwriting using VM Arguments

You can explicitly force the tool to use a certain hostname, http port or https port when registering towards the server by setting these VM arguments:

  • sophora.client.hostname
  • sophora.client.httpPort
  • sophora.client.httpsPort

Again: You can set just a subset of these.

Precedence of settings

If any of the settings can be derived from various sources then the precedence of these is:

VM Arguments > environment variables > implicit settings or defaults

Last modified on 12/10/20

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon