Skip to content

Novelty Setup

Prerequisites

Novelty requires a valid license key to run. To obtain a license key:

Warning

Novelty authenticates against thatDot servers with your license key, meaning Novelty requires an open internet connection to authenticate and start.

Getting Started with thatDot Novelty

Getting started is easy:

  1. Download the software - this is a Java JAR file, if you would prefer a Docker Container please contact the thatDot Support team (support@thatdot.com).
  2. Create a configuration file (.conf extension) containing the license key and place it adjacent to your downloaded JAR file (in the same directory). This is just a plain text file.
  3. Start your instance of Novelty

Download the Software

After obtaining a license, thatDot will provide you with a secure download link for the Novelty JAR file. Download the file to your local machine or server.

Create the Configuration File for thatDot Novelty

Create a configuration file containing your license key. This file has a .conf extension and should be placed in the same directory as your JAR file.

thatdot {
  novelty {
    license-key = "YOUR_LICENSE_KEY"
  }
}

Start Instance of thatDot Novelty

Start Novelty with your configuration file using the following command (in this example, the file is called novelty.conf):

java -jar -Dconfig.file=novelty.conf novelty.jar

You can also choose to configure your instance on the command line when launching an instance instead of using a configuration file:

java -jar -Dthatdot.novelty.license-key=YOUR_LICENSE_KEY novelty.jar

Configuring Proxy Settings for Novelty

When deploying Novelty in a network environment that requires proxy traversal, you can configure the application to route traffic through a proxy server. This is achieved by specifying the appropriate Java system properties:

  • http.proxyHost
  • https.proxyHost
  • http.proxyPort
  • https.proxyPort

Here is how you can configure these when running the jar:

java \
  -Dhttp.proxyHost=<PROXY_HOST> \
  -Dhttp.proxyPort=<PROXY_PORT> \
  -Dhttps.proxyHost=<PROXY_HOST> \
  -Dhttps.proxyPort=<PROXY_PORT> \
  -Dthatdot.novelty.license-key=<LICENSE_KEY> \
  -jar novelty.jar

Configuring Novelty transformation cache

Novelty transformations persist a cache to help speed up and optimize their runtime. On Linux machines, this defaults to the $USER home directory. If your deployment of Novelty restricts write access to the default cache location, you can provide on Linux machines, the XDG_CACHE_HOME environment variable, and provide a writable location, like somewhere in the /tmp directory for instance.

If running a .jar file, here is how you can use that environment variable in a script:

export XDG_CACHE_HOME="/tmp/transformation-cache"
java -jar novelty.jar

Here's a snippet of the env section of a Kubernetes manifest if you are using it to orchestrate Novelty, and an example of setting that cache path environment variable:

env:
- name: XDG_CACHE_HOME
  value: "/tmp/transformation-cache"

Key Resources to Help Guide You

Once you have the software downloaded and the initial configuration file created you are ready to go.

These materials will help you navigate setting up pipelines, querying real-time data, and detecting anomalies.