Configure the FORGE VESPER Importer
The service is configured through the standard ASP.NET Core configuration providers. See appsettings.sample.json for a complete example. This document lists the environment variables for the FORGE VESPER Importer.
Environment Variables
Application settings
| Configuration key | Description | Sample | Mandatory | Default value |
|---|---|---|---|---|
ConnectionStrings__MongoDbConnection | MongoDB connection string. The database name is taken from this connection string. | mongodb://... | Yes | |
AppSettings__DefaultCulture | Default culture used by the service. | en-US | No | en-GB |
AppSettings__StoragePath | Local directory where uploaded CSV files are temporarily stored before ingestion. When ingestion completes, files are automatically deleted. | /data/storage | Yes | |
AppSettings__FilePollingIntervalSeconds | How often the ingestion worker polls MongoDB for new uploaded files. | 10 | No | 10 |
AppSettings__DocumentSenderIntervalSeconds | How often the sender worker polls staging collections for unsent documents. | 10 | No | 10 |
AppSettings__HealthCheckTimeoutInSeconds | Timeout for readiness checks. | 5 | No | 5 |
AppSettings__MaxUploadFileSizeMB | Maximum upload request size. | 1-100 MB | No | 100 |
LOG_MINIMUM_LEVEL | The minimum logging level. | Information | No | Warning |
MICROSOFT_LOG_MINIMUM_LEVEL | The minimum logging level used for the logs written by the .NET framework. | Warning | No | Warning |
Amazon SQS settings
| Configuration key | Description | Sample | Mandatory | Default Value |
|---|---|---|---|---|
AmazonSqs__AccessKeyId | AWS access key used by the SQS client. | Yes | ||
AmazonSqs__SecretAccessKey | AWS secret access key used by the SQS client. | Yes | ||
AmazonSqs__Region | AWS region system name. | eu-central-1 | Yes | |
AmazonSqs__QueueUrl | Target SQS queue URL. | Yes | ||
AmazonSqs__Timeout | SQS client timeout. | 00:00:30 | No | 00:00:30 |
AmazonSqs__RetryCount | SQS retry count. | 2 | No | 2 |
AmazonSqs__SendDelaySeconds | Delay applied to sent messages. | 0-900 | No | 0 |
Authentication settings
| Configuration key | Description | Sample | Mandatory | Default Value |
|---|---|---|---|---|
ApiKey__HeaderName | Request header that contains the shared secret. | x-api-key | No | x-api-key |
ApiKey__ApiKeyValue | Shared secret value expected by the service. | Yes | ||
ApiKey__UserName | Authenticated user name assigned to accepted requests. | ServiceUser | No | ServiceUser |
Notes
- Uploaded CSV files are stored in
AppSettings__StoragePathuntil ingestion completes, then they are cleaned up automatically. - The importer polls MongoDB for new uploads and staging collections for unsent documents according to the configured interval values.
- The SQS client configuration controls the queue used for importer-delivered messages, retry behavior, and overall timeout settings.