appsettings.json Overview

The file appsettings.json is the main source of configuration for the DpeNanoServices application. It contains various (optional) sections. Some are inherited from the used ASP.Net framework, some are custom options for DpeNanoServices.

Example appsettings.json file

CODE

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    },

    "EventLog": {
      "LogLevel": {
        "Default": "Information",
        "Microsoft.AspNetCore": "Warning"
      }
    },
    
    "Dpe": {
      "LogLevel": {
        "Default": "Information",
        "Microsoft.AspNetCore": "Warning",
        "_Microsoft.Hosting.Lifetime": "Information"
      }
    }
  },

  "AllowedHosts": "*",

  "_Kestrel": {
    "Endpoints": {
      "Https": {
        "Url": "https://localhost:5256",
        "SslProtocols": [ "Tls12", "Tls13" ],
        "Certificate": {
          "Path": "C:\\\\Orga\\\\LicsAndKeys\\wildcard_davidsystems-test_com.pfx",
          "Password": ""
        }
      }
    }
  },

  "_TempFolder": "\\\\MyShare\\Temp",

  "DpeLogging": {
    "UseFileLogger": true,
    "_BaseFolder": ".\\",
    "_ProtocolParameterXml": "C:\\temp",
    "_ConnectionString": "Data Source=NOTEBOOK-WS2\\sql2022;Initial Catalog=DpeCoreDb;Integrated Security=True;Min Pool Size=100;Max Pool Size=1000;"
  },

  "DpeParFile": {
    "_DigaSystemRegistryXmlFilePath": null
  }
  
  "DpeContentService": {
    "_OnTheFlyAudioConversionEnabled": true,
    "_OnTheFlyAudioConversionLocalEnabled": false,
    "_OnTheFlyAudioConversionFormat": "[FILETYPE]RAW[FORMAT]MPEG-LAYER3[SAMPLERATE]48000[BITRATE]128[MODE]Stereo[RELAXED_ERROR_CHECK]1",
    "_OnTheFlyAudioConversionExtension": ".mp3",
    "_MediaPartialBlockSize": -1,
    "_MaxLocalAudioConversions": 4,
    "_OnTheFlyWaveformEnabled": true,
    "_OnTheFlyWaveformLocalEnabled": false,
    "_MaxLocalWaveformConversions": 4,
    "_ExtToType": "Audio=WAV,MP3|Video=|Text=TXT",
    "_ExtToClass": "",
    "_VerboseAshxLog": false,
    "_TestExtensionsEnabled":  false
  },
  
  "_Ldap": {
    "Address": "",
    "Port": 389,
    "Security": "none" // none, ssl
  }
}

Note: A starting underscore for an option name “comments” it out.

Section Logging

Configures ASP.Net logging. Which kind of information should be logged to which logging channels.

More info under https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-7.0

Section Kestrel

Configures Kestrel, the web server framework used by ASP.Net.

Section DpeLogging

Configures DPE Logging

UseFileLogger:
true: logging to files,
false: logging to DpeCoreDb database (requires a valid ConnectionString)
ConnectionString: optional database connection string for accessing DpeCoreDb (needed when UseFileLogger=false)
ProtocolParameterXml: optional override for path to log config file (Protocol.parameterxml). default location is application folder
BaseFolder: folder for file logging

Section DpeParFile

Configures DPE Parameter File Usage

Section DpeWorkflowService

Configures DPE Workflow Service

ConnectionString: optional database connection string for accessing DpeCoreDb (needed when workflows are used, e.g. for copying entries from ContentManager or for creating lores audio, waveform files or for creating speech-to-text files)

Section DpeContentService

Configures DPE Content Service

OnTheFlyAudioConversionEnabled: enables on-the-fly audio conversion
OnTheFlyAudioConversionLocalEnabled: switches to on-the-fly audio conversion via Audio32Console.exe instead of using workflow system. Useful when operating in non-enterprise environments, e.g. a local notebook installation.
Note: the Audio32Console package must be copied to a sub folder tools
OnTheFlyAudioConversionCacheLowWaterMarkGb: cache cleanup options, default=10
OnTheFlyAudioConversionCacheHighWaterMarkGb: cache cleanup options, default=20
OnTheFlyWaveformEnabled: enables on-the-fly waveform creation
OnTheFlyWaveformLocalEnabled: switches to on-the-fly waveform creation via Audio32Console.exe instead of using workflow system. Useful when operating in non-enterprise environments, e.g. a local notebook installation.
Note: the Audio32Console package must be copied to a sub folder tools
OnTheFlyWaveformCacheLowWaterMarkGb: cache cleanup options, default=10
OnTheFlyWaveformCacheHighWaterMarkGb: cache cleanup options, default=20

Section Ldap

Configures LDAP (only needed when not running under windows)

Address: address of the LDAP server
Port: port of the LDAP server, e.g. 389 or 636
Security: e.g. “none” or “ssl”

Top Level Options

TempFolder: optionally specifies a shared temp folder, otherwise a local default folder is used