RunReveal

RRSCH (RunReveal Scheduler) Configuration Guide

RRSCH runs scheduled tasks and background workers in RunReveal, including detection queries, notifications, threat feeds, enrichments, and AI agents.

Table of Contents

Basic Configuration

RRSCH uses a JSON configuration file:

{
  "common": {
    "chdsn": "clickhouse://user:password@localhost:9000/dbname",
    "pgdsn": "postgres://user:password@localhost:5432/dbname?sslmode=verify-full",
    "baseurl": "http://localhost:8000",
    "appBaseURL": "http://localhost:3000",
    "secretsConfig": {
      "type": "none"
    }
  },
  "schedule": {
    "schedulers": [
      {
        "type": "query",
        "timer": 500,
        "fetchCount": 10,
        "visibilityTimeout": 10,
        "parallelism": 3
      },
      {
        "type": "notification-send"
      }
    ]
  }
}

Common Configuration Options

OptionTypeDescriptionRequired
commonobjectShared configuration across RunReveal servicesYes
scheduleobjectRRSCH scheduler configuration (see Scheduler Types)Yes

common Object

OptionTypeDescriptionRequired
chdsnstringClickHouse connection stringYes
pgdsnstringPostgreSQL connection stringYes
baseurlstringExternal API base URLYes
internalBaseURLstringInternal API URL for service-to-service calls (falls back to baseurl when unset)No
appBaseURLstringFrontend application URL used in notification links and OAuth metadataNo
secretsConfigobjectEncryption provider configuration for database secretsYes

Running RRSCH

RRSCH can be run using the following command:

rrsch queries --config config.json

Command Line Arguments

FlagDescriptionDefault
--configPath to configuration fileconfig.json

Environment Variables

Configuration values can reference environment variables by prefixing the value with $. For example:

{
  "common": {
    "pgdsn": "$POSTGRES_DSN"
  }
}

On this page