Skip to main content

Configure the FORGE VESPER Connector

This document lists the environment variables for the FORGE VESPER Connector.

Environment Variables

ConfigurationDescriptionSample/type of valid valuesMandatoryDefault value
Guishell__BackofficeUrlGuishell backoffice URLhttps://localhost:3000Yes
Guishell__ClientIdGuishell client idyour-client-idYes
Guishell__ClientSecretGuishell client secretyour-client-secretYes
ManagementApi__UrlFORGE Management API URLhttps://management-api.example.comYes
ManagementApi__ResourceNameFORGE Management API Resource namemanagement-apiYes
AmazonSqs__AccessKeyIdAWS SQS access key IDAKIA...Yes
AmazonSqs__SecretAccessKeyAWS SQS secret access keyyour-secret-access-keyYes
AmazonSqs__RegionAWS SQS regioneu-central-1Yes
AmazonSqs__QueueUrlAWS SQS queue URLhttps://sqs.eu-central-1.amazonaws.com/123/queueYes
AmazonSqs__PrefecthCountSQS prefetch count10No10
AmazonSqs__TimeoutSQS timeout (hh:mm:ss)00:00:30No00:00:30
AmazonSqs__RetryCountSQS retry count2No2
AmazonSqs__ReceiveMessageWaitTimeSecondsSQS receive message wait time (seconds)20No20
AmazonSqs__VisibilityTimeoutSecondsSQS visibility timeout (seconds)120No120
AmazonSqs__VisibilityHeartbeatSecondsSQS visibility heartbeat (seconds)60No60
ProcessorSettings__RetryCountProcessor retry count2No2
ProcessorSettings__RetryDelayProcessor retry delay (hh:mm:ss)00:00:01No00:00:01
Vesper__DatasourceNameVesper datasource nameVesperYesVesper
Vesper__EventMappings__0__EventNameEvent mapping: event name (first mapping)UPDATED_VODNoUPDATED_VOD
Vesper__EventMappings__0__EntityCodeEvent mapping: entity code (first mapping)vesper-videoNovesper-video
MongoDb__ConnectionStringMongo DB connection string with database namemongodb://localhost:27017/database-nameYes
MongoDb__LockTtlSecondsMongo DB lock TTL in seconds for distributed locks3600No3600
MongoDb__AreaCodeAreaCode setting for multi datacenter scenarioVesperNoVesper
Vesper__ContextTags__0Tag that, when matched among incoming Vesper tags, triggers the connector logicSportNoSport
ExternalTags__DataSources__0__DataSourceNameName of the external tag datasource matched against incoming tagsStructured external tag not supportedNo
LOG_MINIMUM_LEVELThe minimum logging levelInformationNoWarning
MICROSOFT_LOG_MINIMUM_LEVELThe minimum logging level used for the logs written by .NET frameworkWarningNoWarning

Authentication settings

Configuration keyDescriptionSampleMandatoryDefault Value
ApiKey__HeaderNameRequest header that contains the shared secretx-api-keyNox-api-key
ApiKey__ApiKeyValueShared secret value expected by the serviceyour-shared-secretYes
ApiKey__UserNameAuthenticated user name assigned to accepted requestsServiceUserNoServiceUser

Notes

  • ExternalTags__DataSources__0__DataSourceName is intended for external tag matching. The document notes that structured external tag data sources are not supported and that the connector skips unsupported tags such as Competitions.
  • The connector relies on the configured queue, visibility timeout, and heartbeat values to maintain message processing safely and avoid duplicate or stale work.

Was this page helpful?