Configuration

An important part of the vitrivr NG setup is adjusting the configuration to fit the data and application. The configuration can be changed through the config.json located in the src directory.

A running vitrivr NG service started through ng serve will automatically refresh itself when the configuration file is changed.

Fields

In the following itemized list, every indented item is a field of the closest unindented item above it. Only the most important fields are listed, the rest can be found in the configuration model.

• api: Object field containing information on the connection to the Cineast API.
  • host: Name of the Cineast API host.
  • port: Port of the Cineast API host.
  • protocol_http: The protocol to use for http connections (http or https).
  • protocol_ws: The protocol to use for WebSocket connections (ws or wss).
  • ping_interval: Ping interval in milliseconds to display quality of connection to Cineast API.
• resources: Object field containing information on the location and format of data resources (thumbnails, raw data).
  • host_thumbnails: Path / URL to the location of the media object thumbnails (may contain resource name tokens as explained below).
  • host_objects: Path / URL to the location of the media objects (may contain resource name tokens as explained below).
  • suffix_default: Default thumbnail file extension.
  • suffix: Object field containing thumbnail file extensions definable on a per-mediatype basis (e.g. "IMAGE": "png").

TODO: More configuration fields will be described here in the future. Until then, the available options can be found in the configuration model.

Boolean Fields

Below, you can find some example for boolean query fields.

      {
        "display": "Example Range",
        "input": "RANGE",
        "table": "table",
        "col": "col",
        "range": [0, 23]
      },
      {
        "display": "Example Provided Options",
        "input": "OPTIONS",
        "table": "table",
        "col": "col",
        "options": [
          "MONDAY",
          "TUESDAY",
          "WEDNESDAY",
          "THURSDAY",
          "FRIDAY",
          "SATURDAY",
          "SUNDAY"
        ]
      },
      {
        "display": "Example Dynamic Integer Options",
        "input": "DYNAMICOPTIONS",
        "table": "tablename",
        "col": "intcolname",
        "type": "number"
      },

Resource Name Tokens

Resource name tokens are used to specify the location of data resources in paths and URLs. The following resource name tokens exist (as defined in the resolver:

Token	Description
:o	The ID of the media object.
:n	The file name of the media object.
:p	The path of the media object.
:t	The media object's media type in lowercase letters.
:T	The media object's media type in uppercase letters.
:s	The segment ID (only for thumbnails).
:x	The thumbnail file suffix as defined in the configuration.