Service configuration file - Multiple configurations

[ConfigurationName].json

For each TurboPlayer Service instance, a separate configuration file must be created with the .json extension. The filename must exactly match the DigaSystem configuration name. This name must also be used as the value for the \configuration argument during Windows service installation.

Configuration name (Windows service /configuration argument and DigaSystem registry)	Configuration file name
TPS0	TPS0.json
TPS1	TPS1.json
RegionalTPS	RegionalTPS.json

Case Sensitivity

The file may be case-insensitive on Windows, depending on system settings.

First-Time Setup

On initial installation:

Rename the file template_AppSettings.json to [configurationName].json.
Fill in the required values, such as URLs and credentials for DPE services.

Template_AppSettings.json example

CODE

{
  "AllowedHosts": "*",
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "http://*:8091"
      }
    }
  },
  "ParameterService": {
    "Host": "http://localhost/DpeWebApplication/",
    "Username": "",
    "Password": ""
  },
  "RightsService": {
    "Host": "http://localhost/DpeWebApplication/",
    "Username": "",
    "Password": ""
  },
  "LogService": {
    "Host": "http://localhost/DpeWebApplication/",
    "Username": "",
    "Password": ""
  },
  "LogLevel": "Error",
  "ConfigurationName": "Configuration1"
  "SeviceConfigurationHost": "MachineName"
}

Configuration file sections

AllowedHosts

Controls which hosts are allowed to access the application. Use "*" to allow all hosts (if no security concerns). For further information please check: https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.hostfiltering.hostfilteringoptions.allowedhosts?view=aspnetcore-6.0

CODE

"AllowedHosts": "*",

Kestrel

It is used to set the endpoint of TurboPlayer Service. Here is the section that you can do adjustments in the configuration of the port.

CODE

  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "http://*:8091"
      }
    }
  },

ParameterService

The Parameter Service provides access to configuration parameters stored in the DigaSystem registry. These parameters are read in a specific order of precedence:

Global registry
Local registry (overwrites global parameters)
User registry (overwrites both global and local parameters)

To tell TurboPlayer Service what is the endpoint for the Parameter service, add the configuration section ParameterService to the corresponding file [ConfigurationName].json.

CODE

"ParameterService": {
  "Host": "http://localhost/DpeWebApplication/",
  "Username": "",
  "Password": ""
}

RightsService

The Rights Service provides access to user rights and permissions via the DPE Rights Service. This allows the application to enforce access control based on user rights defined in the DigaSystem environment.

To tell TurboPlayer Service what is the endpoint for the Rights Service, add the configuration section "RightsService" to the corresponding file [ConfigurationName].json.

CODE

"RightsService": {
  "Host": "http://localhost/DpeWebApplication/",
  "Username": "",
  "Password": ""
}

LogService

The Log Service is used to log all errors and important events via the DPE Log Service. The DPE LogService is optional and unrelated to file log system.

To tell TurboPlayer Service what is the endpoint for the Log Service, add the configuration section "LogService" to the corresponding file [ConfigurationName].json.

CODE

"LogService": {
  "Host": "http://localhost/DpeWebApplication/",
  "Username": "",
  "Password": ""
}

ConfigurationName

While using multiple configuration files, the Configuration Name can be ignored as an explicit parameter, as it will be inferred from the file name e.g Configuration1.json.

SeviceConfigurationHost

By default, TurboPlayer Service loads its configuration from the most specific DigaSystem registry available (user, local, global).
This means it uses the local registry on the workstation where the service is running to determine which configuration to apply.

To load configuration from a different machine, set the ServiceConfigurationHost parameter to the name of the remote host:

CODE

"SeviceConfigurationHost": "Workstation Name"

This parameter is optional and should only be used when TurboPlayer Service needs to access configuration from a remote workstation.

LogLevel

This setting defines the log level used by TurboPlayer Service when writing logs.
This setting can be overriden in the DigaSystem Registry. Refer to the DigaSystem Registry documentation for possible values and instructions on how to configure this setting.