Skip to main content

Configuration

The backend is configured entirely through environment variables (using the __ nesting convention for .NET options). This page groups the ravenxcope-backend env block from compose.yml by concern. Values shown as ${...} come from the deployment .env file.


OpenSearch

VariableExamplePurpose
OpenSearch__Urlhttps://opensearch-node1:9200Cluster URL.
OpenSearch__Username / OpenSearch__Passwordadmin / ${OPENSEARCH_INITIAL_ADMIN_PASSWORD}Credentials.
OpenSearch__IndexNamemataelang-sensor-events-streamIndex/alias the backend reads analytics from.

Redis

VariableExample
RedisSettings__Host / RedisSettings__Portredis / 6379
RedisSettings__Password(empty in compose)
RedisSettings__DefaultDatabase0

PostgreSQL

VariableExample
PostgresqlSettings__Host / Portpostgres / 5432
PostgresqlSettings__Username / Password / Database${POSTGRES_USER} / ${POSTGRES_PASSWORD} / ${POSTGRES_DB}

InfluxDB

VariableExample
InfluxDb__Urlhttp://influxdb:8086
InfluxDb__Token / Org / Bucket${INFLUXDB_TOKEN} / ${INFLUXDB_ORG} / ${INFLUXDB_BUCKET}

JWT (auth)

VariablePurpose
JwtSettings__SecretSigning secret.
JwtSettings__Issuer / JwtSettings__AudienceToken issuer/audience.

Data collector & sensor runtime

VariablePurpose
BackendUrlCallback URL handed to sensors.
DataCollector__Endpoint / DataCollector__PortWhere sensors send alert events.
SensorApiSettings__ApiKeyAuthenticates sensor-triggered calls.
SensorSettings__HeartbeatTimeoutMinutesMinutes without a heartbeat before a sensor is marked offline (default 1).
SensorAgent__ImageSensor agent container image reference.

Docker registry (for virtual-sensor activation)

VariablePurpose
DockerRegistry__Registry / Username / PasswordPrivate registry credentials embedded in activation commands so sensors can pull Suricata images.

Threat map (Kafka consumer)

VariableDefaultPurpose
ThreatMap__EnabledtrueEnable the live threat-map consumer.
ThreatMap__Kafka__Brokersbroker:29092Kafka brokers.
ThreatMap__Kafka__Topicravenxcope_threat_geo_eventsGeo events topic.
ThreatMap__Kafka__GroupIdravenxcope-threat-mapConsumer group.
ThreatMap__Kafka__AutoOffsetResetlatestOffset reset policy.
ThreatMap__RecentBufferSize / ThreatMap__SubscriberBufferSize1000 / 256In-memory buffers.

Database migration

VariableDefaultPurpose
Database__AutoMigratetrueRun EF Core migrations on startup.
Database__MigrationMaxRetries10Retry count if the DB is not ready.
Database__MigrationRetryDelaySeconds5Delay between retries.

Not in this compose: environments that enable the NATS control plane additionally set NatsProvisioner__* and NatsMessaging__*. See Backend Control-Plane Integrations and NATS Provisioner.