How do I configure environment options?

While most features of Verint Community are configured through the Administration User Interface or Contextual Management User Interface , some options can only be configured outside of the User Interface. These options largely configure the infrastructure and security components of Verint Community.

Specifying Environment Configuration

Environment configuration is a set of categorized keys and values. Configuration can be layered set or configuration sources where later-defined sources override individual keys of earlier-defined sources. The layers and sources of configuration are defined using the environment variable EVOLUTION_CONFIGURATION_SOURCES which is a semi-colon limited list of configuration sources layered from left to right (where sources defined on the right override sources defined on the left). For example, the default set of configuration sources are:

EVOLUTION_CONFIGURATION_SOURCES=file=~/communitySettings.json;env;command

This defines:

1. The JSON file located at ~/communitySettings.json (where ~/ represents the root of the community installation)
2. Environment variables defining Verint Community configuration.
3. Command-line options specifying Verint Community configuration options when Verint Community components are executed.

Supported Environment Configuration Sources and Formats

File (file)

Format: file={FULL_OR_APPLICATION_ESCAPED_PATH}

Defines a JSON formatted file located at an absolute path or an application escaped (prefixed with ~/) path.

Multiple file sources can be defined in the value for EVOLUTION_CONFIGURATION_SOURCES and each file included will be layered based on the order of its inclusion.

The JSON of the file represents a single object with object properties for each configuration section (documented below). Within each section, keys/values are defined. A full JSON example is at the bottom of this article.

Environment Variables (env)

Format: env

Enables environment variables referencing Verint Community configuration key/value pairs to be read.

Environment variables following the format EVOLUTION_{Configuration_Section}_{Configuration_Key}={Value} will be read and applied to the resolved Verint Community environment configuration. Within environment variable keys and values, the following replacements can be made to prevent conflicts with host operating systems and environment variable definitions:

• Period (.): _P_
• Comma (,): _CM_
• Colon (:): _CL_
• Space ( ): _SP_ or __

When specifying a value that represents a list, list values can be delimited by double colons (;;).

Command Line Options (command)

Format: command

Enables command-line variables referencing Verint Community configuration key/value pairs to be read.

Command line options following the format --EVOLUTION-{Configuration_Section}_{Configuration_Key}={Value} will be read and applied to the resolved Verint Community environment configuration.

When specifying a value that represents a list, list values can be delimited by double colons (;;).

AWS Secrets (awssecret)

Format: awssecret={AWS_KEY_NAME}

Enables reading a JSON-formatted AWS Secret value as Verint Community configuration. To use AWS Secrets, the AWS SDK must be configured by setting the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_DEFAULT_REGION environment variables to the access credentials required to read the specified AWS Secret.

Multiple AWS secrets can be defined in the value for EVOLUTION_CONFIGURATION_SOURCES and each secret will be layered based on the order of its inclusion.

The JSON value of the secret represents a single object with object properties for each configuration section (documented below). Within each section, keys/values are defined. A full JSON example is at the bottom of this article.

Environment Configuration Sections

The following options are available to be specified via Environment Configuration:

Core

Configuration options affecting the base Verint Community functionality. All keys in this section are within the programmatic section name Core.

Connection Strings

Connection strings used to connect to database resources that enable the Community to function. All keys in this section are within the programmatic section named ConnectionStrings.

Plugin Connection Strings

Within the Verint hosting environment, connection strings are generated as needed for ISqlServerConnectedPlugin implementations. When hosting for development purposes or on-premise, each ISqlServerConnectedPlugin will require a connection string to be defined within this section. All keys in this section are within the programmatic section named PluginConnectionStrings.

Throttling

Controls HTTP throttling behavior which prevents attacks to the community by throttling HTTP requests by client IP when the web container is under load. All keys in this section are within the programmatic section named Throttling.

Review Mode

Review mode places a message and optional access-code gate in front of web access to the community. API and system-oriented requests (CFS files, robots.txt, sitemap access) is allowed when review mode is enabled.

Hosting

Controls badging and critical error reporting in cases where responsible party for infrastructure related issues is different from the configured administrators of the installation of Community. All keys in this section are within the programmatic section named Hosting.

Tracing

Controls tracing of Community processes and observability of tracing data. All keys in this section are within the programmatic section named Tracing.

Metrics

Controls metrics calculated by Community and observability of metrics data. All keys in this section are within the programmatic section named Metrics.

Logging

Controls logs written by Community and observability of logging data. All keys in this section are within the programmatic section named Logging.

Open Telemetry Tags

Controls tags applied to all open telemetry representations of traces, metrics, and logs. All keys in this section are within the programmatic section named OtlpTags.

Open Telemetry Resource Tags

Controls tags applied to all open telemetry representations of resources associated to traces, metrics, and logs. All keys in this section are within the programmatic section named OtlpResourceTags.

HTTP Logging

Controls the enablement and behavior of the file-based HTTP access log. All keys in this section are within the programmatic section named HttpLogging.

Plugin Enablement

Optionally, environment configuration can force-enable or disable plugins. When a plugin is force-enabled or disabled, the Verint Community Administration User Interface will not present the option to enable/disable the affected plugin. All keys in this section are within the programmatic section named PluginEnablement.

Plugin Configuration

Optionally, environment configuration can force-set plugin configuration--either the full configuration of a plugin or individual properties. When a plugin has some or all of its configured force-set, the Verint Community Administration User Interface will not the force-set configuration options. All keys in this section are within the programmatic section named PluginConfiguration.

Job Schedules

Optionally, environment configuration can force-set job schedules. When a job is force-scheduled, the Verint Community Administration User Interface show the job's force-set schedule as read-only. All keys in this section are within the programmatic section named JobSchedules.

Search

Configure search support. All keys in this section are within the programmatic section named Search.

Mail Gateway

Configure email gateway which enabled incoming and bidirectional email support. All keys in this section are within the programmatic section named MailGateway.

[
 // Mail.app, iPhone, Gmail
 "(?:<div>(?:\\s*<br ?/?>)?)\\s*On [^"]+"[\\s\\w']+"(?:\\s(?:<|<<a href="[\\w:\\./@]+">)[\\w\\./@]+(?:>|</a>>))? wrote",
 // OSX Mail
 "<div[^>]*>(?:(?!</div).)*[^>]*?>?\\s*?On[^<&]*(?:(?:<|<)<a [^>]*?href="[^<>@"]*@[^<>@"]*"[^>]*>[^<>@]*@[^<>@]*(?:>|</a>>))? wrote.*",
 // Yahoo, Entourage
 "(?:---\\s)?On(?:\\s\\w+,)?\\s\\d{1,4}[-/\\.]\\d{1,2}[-/\\.]\\d{1,4}(?:\\s\\d{1,2}:\\d{2}(?:\\s(?:am|pm))?)?(?:,)?\\s(?:"|")?[\\s\\w]+(?:"|")?(?:\\s(?:<|<|<<a\\shref="[\\w:\\./@]+">)[\\w:\\./@]+(?:>|>|</a>>))?\\swrote",
 // Windows Mobile, Blackberry
 "(?:-{2,})?Original\\sMessage(?:-{2,})?",
 // Gmail
 "<div\\sclass=['"]gmail_quote['"]>",
 // Hotmail
 "<DIV\\sstyle=['"]BACKGROUND:\\s#f5f5f5['"]>",
 // HTML Blackberry
 "<hr\\salign=['"]center['"]>",
 // Outlook, Windows Phone 8
 "(?:<div[^>]*>)?\\s*(?:<hr[^>]*>)?\\s*(?:<div[^>]*>)?(?:<font[^>]*>)?(?:<p[^>]*>)?(?:<b>)?(?:<span[^>]*>)?(?:<b>)?From:(?:</b>)?\\s*(?:</span>)?\\s*(?:</b>)?"
]

Centralized File Storage (CFS)

The centralized file system manages all dynamic file content for Verint Community. All keys in this section are within the programmatic section named CentralizedFileStorage. In general, key-value pairs defined in this section are provided to the configured ICentralizedFileStorageProvider defined by the Type and/or SourceProviderType key via its Initialize() method for configuration and to the configured ICentralizedFileStorageDeliveryProvider  defined by the DeliveryType key via its TryInitialize() method.

FileSystemFileStorageProvider

Configuration keys when the CFS provider or source provider type is configured as "Telligent.Evolution.Extensibility.Storage.Providers.Version1.FileSystemFileStorageProvider, Telligent.Evolution.Platform"

AmazonS3FileStorageProvider

Configuration keys when the CFS provider or source provider type is configured as "Telligent.Evolution.Extensibility.Storage.Providers.Version1.AmazonS3FileStorageProvider, Telligent.Evolution.Platform"

Note that the Amazon S3 provider will use the AWS environment variables to identify the region and access credentials to access the Amazon S3 API.

DeliveryProvider

Configuration keys when the CFS delivery provider type is configured as "Telligent.Evolution.Extensibility.Storage.Providers.Version1.DeliveryProvider, Telligent.Evolution.Platform"

MIME Types

Mappings between file extensions and MIME types are used when adding and serving files from the centralized file system. All keys in this section are within the programmatic section named MimeTypes.

Sample JSON Configuration

Below is a sample JSON configuration file showing how options are defined and configured as a full set. When defining overrides in a layered JSON format, only include the sections, keys that you intend to override.

{
  "Core": {
    "RunJobsInternally": false,
    "EnableDeveloperMode": false,
    "EnableAdminTranslations": false,
    "MaxNumberOfJobThreads": null,
    "JobLookAheadInterval": "00:00:02",
    "DisableEmail": false,
    "AnnouncementRssUrl": "https://community.telligent.com/r?43",
    "EnableRestStatusMessageOnUser": false,
    "DisallowedFileExtensions": "dll,exe",
    "SiteUrl": "https://net.local.computer:7161",
    "KeyEncryptionCertificateBase64": null,
    "KeyEncryptionCertificatePassword": null,
    "EnableCors": false,
    "CorsOrigins": null,
    "EnableMaintenanceMessage": false,
    "MaintenanceMessageHtml": null,
    "MemoryLimitMB": null,
    "ProcessorLimit": null,
    "DatabaseManagerServiceBaseUrl": null,
    "ResetDatabaseToVersion": null,
    "RollbackToDate": null,
    "ReadForwardedHeader": false,
    "CustomProxyHeader": null,
    "PluginSourceVersion":  null,
    "InternalApplicationStatusPort": null,
    "EmergencyLoginKey": null
  },
  "ConnectionStrings": {
    "SiteSqlServer": "server=(local);uid=username;pwd=passw0rd;Trusted_Connection=no;database=Community.App;TrustServerCertificate=True",
    "Reporting": "server=(local);uid=username;pwd=passw0rd;Trusted_Connection=no;database=Community.Reporting;TrustServerCertificate=True"
  },
  "PluginConnectionStrings": {
    "MyNamespace.MyPlugin, MyAssembly": "server=(local);uid=MyPlugin;pwd=passw0rd;Trusted_Connection=no;database=Community.App;TrustServerCertificate=True"
  },
  "Throttling": {
    "Enable": true,
    "GlobalConcurrentRequestThreshold": 50,
    "CpuPressureThreshold": 30,
    "MaxClientQueueLength": 200,
    "AlwaysAllowedIpAddressRanges": ["127.0.0.1","192.168.0.*"]
  },
  "Hosting": {
    "EnableInfrastructureSystemIndicatorBadging": true,
    "EnableInfrastructureSystemIndicatorSystemNotifications": true,
    "SendCriticalSystemIndicatorsToEmailAddress": null,
    "RemoteAllowedIpAddressRanges": []
  },
  "Tracing": {
    "EnableConsole": false,
    "EnableOtlp": true,
    "OtlpEndpoint": "http://127.0.0.1:5317/",
    "OtlpEndpointHeaders": null,
    "OtlpEndpointProtocol": "grpc",
    "Filters": [
      "exception:logged=1",
      "sql.command:duration>500"
    ]
  },
  "Metrics": {
    "EnableConsole": false,
    "EnableOtlp": true,
    "OtlpEndpoint": "http://127.0.0.1:5317/",
    "OtlpEndpointHeaders": null,
    "OtlpEndpointProtocol": "grpc"
  },
  "Logging": {
    "EnableEventLog": true,
    "EnableConsole": true,
    "ConsoleFormat": "text",
    "EnableOtlp": true,
    "OtlpEndpoint": "http://127.0.0.1:5317/",
    "OtlpEndpointHeaders": null,
    "OtlpEndpointProtocol": "grpc",
    "MinimumLevel": [
      "Information",
      "Microsoft.AspNetCore:Warning"
    ]
  },
  "OtlpTags": {
    "environment": "dev",
    "developer": "me"
  }
  "HttpLogging": {
    "Enable": false,
    "LogFileBasePath": "~/logs",
    "LogFileNamePrefix": "httplog",
    "LogFileMaxDurationMinutes": 1440,
    "LogFileMaxSizeMegabytes": 10,
    "ExcludeHttpStatusCodes": [ 429 ],
    "EnableS3Shipping": false
  },
  "PluginEnablement": {
    "Telligent.Evolution.Infra.Connector.InfraPlugin, Telligent.Evolution.Infra.Connector": true,
    "Telligent.Evolution.Api.Plugins.FileValidators.ClamAvFileValidator, Telligent.Evolution.Platform":  true
  },
  "PluginConfiguration": {
    "Telligent.Evolution.Infra.Connector.InfraPlugin, Telligent.Evolution.Infra.Connector:host": "http://127.0.0.1:5700",
    "Telligent.Evolution.Api.Plugins.FileValidators.ClamAvFileValidator, Telligent.Evolution.Platform:host": "127.0.0.1",
    "Telligent.Evolution.Api.Plugins.FileValidators.ClamAvFileValidator, Telligent.Evolution.Platform:port": 5310
  },
  "JobSchedules": {
    "Telligent.Evolution.Api.Plugins.FileValidators.ClamAvFileValidator, Telligent.Evolution.Platform": "default",
    "Telligent.ReportingETL.ReportingETLJob, Telligent.Reporting.ETL": "2h",
  },
  "Search": {
    "SolrContentUrl": "http://localhost:8983/solr/telligent-content/",
    "SolrConversationsUrl": "http://localhost:8983/solr/telligent-conversations/",
    "MaxAttachmentTermCount": 1000000,
    "BestMatchFieldName": "content",
    "BestMatchTitleFieldName": "title",
    "EnableFieldCollapsing": true
  },
  "MailGateway": {
    "Mailboxes": [
        "server=domain.com;type=pop3;uid=mailbox1;pwd=pa$$word;apop=True",
        "server=domain.com;type=pop3;uid=mailbox2;pwd=pa$$word;apop=True"
    ],
    "SubjectPrefixesToStrip": [
      "RE:",
      "FW:",
      "FWD:"
    ],
    "QuoteRegex": [
      "(?:---\\s)?On(?:\\s\\w+,)?\\s\\d{1,4}[-/\\.]\\d{1,2}[-/\\.]\\d{1,4}(?:\\s\\d{1,2}:\\d{2}(?:\\s(?:am|pm))?)?(?:,)?\\s(?:"|")?[\\s\\w]+(?:"|")?(?:\\s(?:<|<|<<a\\shref="[\\w:\\./@]+">)[\\w:\\./@]+(?:>|>|</a>>))?\\swrote",
      "(?:-{2,})?Original\\sMessage(?:-{2,})?",
      "(?:<div[^>]*>)?\\s*(?:<hr[^>]*>)?\\s*(?:<div[^>]*>)?(?:<font[^>]*>)?(?:<p[^>]*>)?(?:<b>)?(?:<span[^>]*>)?(?:<b>)?From:(?:</b>)?\\s*(?:</span>)?\\s*(?:</b>)?"
    ]
  },
  "CentralizedFileStorage": {
    "Type": "Telligent.Evolution.Extensibility.Storage.Providers.Version1.FileSystemFileStorageProvider, Telligent.Evolution.Platform",
    "RootPath": "~/filestorage",
    "CaseSensitivity": "Required",
    "DeliveryType": "Telligent.Evolution.Extensibility.Storage.Providers.Version1.DeliveryProvider, Telligent.Evolution.Platform",
    "DeliveryProvider": "CloudFront",
    "DeliveryRootUrl": "https://cdn.mysite.com/",
    "DeliverProviderPath": true,
    "SourceProviderType":  null
  },
  "MimeTypes": {
    "aac": "audio/aac",
    "csv": "application/vnd.ms-excel",
    "css": "text/css; is-text",
    "less": "text/css; is-text",
    "js": "text/javascript; is-text",
    "doc": "application/msword",
    "gif": "image/gif; is-inline",
    "bmp": "image/bmp; is-inline",
    "htm": "text/html; is-text",
    "html": "text/html; is-text",
    "jpg": "image/jpeg; is-inline",
    "jpeg": "image/jpeg; is-inline",
    "heic": "image/heic; is-inline",
    "heif": "image/heic; is-inline",
    "pdf": "application/pdf; is-inline",
    "png": "image/png; is-inline",
    "ppt": "application/vnd.ms-powerpoint",
    "rtf": "application/msword",
    "txt": "text/plain; is-text",
    "xls": "application/vnd.ms-excel",
    "xml": "text/xml; is-text",
    "wmv": "video/x-ms-wmv",
    "wma": "video/x-ms-wmv",
    "mpeg": "video/mpeg",
    "mpg": "video/mpeg",
    "mpa": "video/mpeg",
    "mpe": "video/mpeg",
    "webm": "video/webm",
    "webp": "image/webp; is-inline",
    "ogv": "video/ogg",
    "mov": "video/quicktime",
    "qt": "video/quicktime",
    "avi": "video/x-msvideo",
    "asf": "video/x-ms-asf",
    "asr": "video/x-ms-asf",
    "asx": "video/x-ms-asf",
    "flv": "video/x-flv",
    "zip": "application/zip",
    "mp3": "audio/mpeg",
    "wav": "audio/wav",
    "mp4": "video/mp4",
    "ogg": "audio/ogg",
    "docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "dotx": "application/vnd.openxmlformats-officedocument.wordprocessingml.template",
    "ppsx": "application/vnd.openxmlformats-officedocument.presentationml.slideshow",
    "pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
    "xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    "xltx": "application/vnd.openxmlformats-officedocument.spreadsheetml.template",
    "otf": "font/opentype",
    "ttf": "font/truetype",
    "eot": "application/vnd.ms-fontobject",
    "svg": "image/svg+xml; is-inline",
    "woff": "application/x-font-woff",
    "ico": "image/x-icon",
    "vm": "text/x-velocity-macro; is-text",
    "jsm": "text/x-javascript-macro; is-text"
  }
}