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
| Variable | Example | Purpose |
|---|
OpenSearch__Url | https://opensearch-node1:9200 | Cluster URL. |
OpenSearch__Username / OpenSearch__Password | admin / ${OPENSEARCH_INITIAL_ADMIN_PASSWORD} | Credentials. |
OpenSearch__IndexName | mataelang-sensor-events-stream | Index/alias the backend reads analytics from. |
Redis
| Variable | Example |
|---|
RedisSettings__Host / RedisSettings__Port | redis / 6379 |
RedisSettings__Password | (empty in compose) |
RedisSettings__DefaultDatabase | 0 |
PostgreSQL
| Variable | Example |
|---|
PostgresqlSettings__Host / Port | postgres / 5432 |
PostgresqlSettings__Username / Password / Database | ${POSTGRES_USER} / ${POSTGRES_PASSWORD} / ${POSTGRES_DB} |
InfluxDB
| Variable | Example |
|---|
InfluxDb__Url | http://influxdb:8086 |
InfluxDb__Token / Org / Bucket | ${INFLUXDB_TOKEN} / ${INFLUXDB_ORG} / ${INFLUXDB_BUCKET} |
JWT (auth)
| Variable | Purpose |
|---|
JwtSettings__Secret | Signing secret. |
JwtSettings__Issuer / JwtSettings__Audience | Token issuer/audience. |
Data collector & sensor runtime
| Variable | Purpose |
|---|
BackendUrl | Callback URL handed to sensors. |
DataCollector__Endpoint / DataCollector__Port | Where sensors send alert events. |
SensorApiSettings__ApiKey | Authenticates sensor-triggered calls. |
SensorSettings__HeartbeatTimeoutMinutes | Minutes without a heartbeat before a sensor is marked offline (default 1). |
SensorAgent__Image | Sensor agent container image reference. |
Docker registry (for virtual-sensor activation)
| Variable | Purpose |
|---|
DockerRegistry__Registry / Username / Password | Private registry credentials embedded in activation commands so sensors can pull Suricata images. |
Threat map (Kafka consumer)
| Variable | Default | Purpose |
|---|
ThreatMap__Enabled | true | Enable the live threat-map consumer. |
ThreatMap__Kafka__Brokers | broker:29092 | Kafka brokers. |
ThreatMap__Kafka__Topic | ravenxcope_threat_geo_events | Geo events topic. |
ThreatMap__Kafka__GroupId | ravenxcope-threat-map | Consumer group. |
ThreatMap__Kafka__AutoOffsetReset | latest | Offset reset policy. |
ThreatMap__RecentBufferSize / ThreatMap__SubscriberBufferSize | 1000 / 256 | In-memory buffers. |
Database migration
| Variable | Default | Purpose |
|---|
Database__AutoMigrate | true | Run EF Core migrations on startup. |
Database__MigrationMaxRetries | 10 | Retry count if the DB is not ready. |
Database__MigrationRetryDelaySeconds | 5 | Delay 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.