Skip to content

Configuration reference

See also: Environment variable reference — shared env vars; orchestrator-specific vars are listed below. Regenerate the generated table with pnpm docs:env. Unknown KICI_* env vars cause the orchestrator to refuse to start (typo catcher); set KICI_DEV=true for warn-only behaviour during local development.

The KiCI orchestrator uses a layered configuration system: a local YAML file for per-instance settings, a shared PostgreSQL-backed config store for shared settings, and environment variable overrides for both. The scaler configuration (scalers.yaml) remains a separate file.

The orchestrator resolves its configuration from four sources, in order of precedence:

  1. Environment variables (KICI_-prefixed) — highest precedence
  2. Local YAML file (orchestrator.yaml) — per-instance settings
  3. Shared DB config (PostgreSQL config_versions table) — shared across all instances
  4. Built-in defaults — lowest precedence

This means an environment variable always overrides the same setting from YAML or DB. The YAML file overrides the shared DB config. And the shared DB config overrides built-in defaults.

The configuration source of truth is packages/orchestrator/src/config/schema.ts.

The orchestrator loads configuration in two phases to avoid a circular dependency (you need the database URL to connect to the DB, but the DB stores shared config):

  1. Phase 1 (local-only): Load orchestrator.yaml + KICI_ env vars to get database.url, instance.id, server.port, and instance.mode. This is enough to start the process and connect to PostgreSQL.
  2. Phase 2 (full merge): Query the shared config from the config_versions table, merge all four layers (env > YAML > DB > defaults), and validate with the full appConfigSchema.

The local config file contains per-orchestrator-instance settings that are never shared across orchestrators. By default, the orchestrator looks for the file at /etc/kici/orchestrator.yaml. Override this with:

  • --config /path/to/orchestrator.yaml (CLI flag)
  • KICI_CONFIG=/path/to/orchestrator.yaml (env var)

If no file is found and no explicit path was given, the orchestrator runs in env-only mode (YAML is optional).

/etc/kici/orchestrator.yaml
# Local configuration for a single orchestrator instance.
# Database connection (required)
database:
url: 'postgresql://kici:s3cur3pass@postgres:5432/kici'
# Instance settings
instance:
# Unique identifier for this orchestrator instance.
# Default: auto-generated random UUID.
id: 'orch-west-1'
# Operating mode: platform | hybrid | independent
# - platform (default): WS to Platform relay only; rejects direct webhooks.
# Requires platform.url + platform.token (or KICI_PLATFORM_URL + KICI_PLATFORM_TOKEN).
# - hybrid: Platform relay + direct per-source webhook ingestion (deduplicated).
# Requires Platform credentials. Per-source webhook secrets live in the
# orchestrator DB (kici-admin source add ...) — there is no global
# webhook-secret env var.
# - independent: standalone, direct per-source webhook ingestion only.
# Different entry point (`standalone.js`). Per-source secrets in DB.
# Mode is optional — defaults to "platform" — but the credentials the mode
# requires must be present at startup or the orchestrator refuses to boot.
# See operator/orchestrator/getting-started.md#three-deployment-modes for the
# full picture.
mode: 'hybrid'
# HTTP server settings
server:
# Port to listen on (default: 4000)
port: 4000
# URL prefix for all routes (default: "/")
basePath: '/'
# Log level: debug | info | warn | error (default: info)
logLevel: 'info'
# Path to TLS certificate (PEM) for the expiry diagnostic check.
# Optional — when set, /diagnostics reports cert validity and expiry.
# tlsCertPath: '/etc/ssl/certs/kici.pem'
# Auto-scaler configuration file paths
scaler:
# Path to the main scalers.yaml config file
configPath: '/etc/kici/scalers.yaml'
# Directory for scalers.d/ drop-in configs
configDir: '/etc/kici/scalers.d/'
FieldTypeDefaultDescription
database.urlstring(required)PostgreSQL connection URL
instance.idstring<random-UUID>Unique orchestrator instance ID
instance.modeenumplatformOperating mode: platform, hybrid, independent
server.portnumber4000HTTP server listen port
server.basePathstring/URL prefix for all routes
server.logLevelenuminfoLog level: debug, info, warn, error
server.tlsCertPathstringPath to TLS cert (PEM) for expiry diagnostic
scaler.configPathstringPath to scalers.yaml
scaler.configDirstringPath to scalers.d/ directory

Every config field can be overridden by a KICI_-prefixed environment variable. The mapping uses underscore-separated uppercase paths:

Environment variable reference (orchestrator-specific)

Section titled “Environment variable reference (orchestrator-specific)”

Variables shared across KiCI services and the logger live in the environment variable reference. The orchestrator-specific variables, with type/default/required metadata generated from the config schema:

Env varRequiredDefaultTypeAliasesDescription
KICI_AGENT_AUTHno”token”enum:token|none
KICI_AGENT_MAX_RECONNECT_DELAY_MSno60000number
KICI_AGENT_TOKEN_TTL_MSno3600000number
KICI_AUTO_MIGRATEno”true”string
KICI_BASE_PATHno”/“string
KICI_BOOTSTRAP_ADMIN_TOKENnostring
KICI_CACHE_BUILD_TIMEOUT_MSno600000number
KICI_CACHE_MAX_TARBALL_BYTESno524288000number
KICI_CACHE_TTL_DAYSno30number
KICI_CLUSTER_ADDRESSnostring
KICI_CLUSTER_COORDINATOR_URLnostring
KICI_CLUSTER_COORDINATOR_URLSnostring
KICI_CLUSTER_CREDENTIAL_FILEno”~/.kici/peer-credential”string
KICI_CLUSTER_ELECTION_GRACE_PERIOD_MSno60000number
KICI_CLUSTER_INSTANCE_IDno""string
KICI_CLUSTER_JOIN_TOKENnostring
KICI_CLUSTER_NAMEnostring
KICI_CLUSTER_PEER_HEARTBEAT_INTERVAL_MSno30000number
KICI_CLUSTER_PEER_MAX_RECONNECT_DELAY_MSno60000number
KICI_CLUSTER_PEER_STALE_TIMEOUT_MSno60000number
KICI_CLUSTER_PEERSnostring
KICI_CLUSTER_RAFT_ELECTION_TIMEOUT_MAX_MSno10000number
KICI_CLUSTER_RAFT_ELECTION_TIMEOUT_MIN_MSno5000number
KICI_CLUSTER_RAFT_HEARTBEAT_MSno2000number
KICI_CLUSTER_ROLEno”coordinator”enum:coordinator|worker
KICI_CLUSTER_SINGLE_NODEnofalseunion
KICI_CLUSTER_TRUSTED_PROXIESnostring
KICI_DASHBOARD_URLnostring
KICI_DATA_DIRnostring
KICI_DATABASE_URLnostring
KICI_DISPATCH_ACK_TIMEOUT_MSno10000number
KICI_EVENT_LOG_MAX_PAYLOAD_BYTESno5242880number
KICI_EVENT_ROUTER_CLEANUP_INTERVAL_MSno3600000number
KICI_EVENT_ROUTER_EVENT_TTL_SECONDSno604800number
KICI_EVENT_ROUTER_LEASE_DURATION_MSno60000number
KICI_EVENT_ROUTER_MAX_CHAIN_DEPTHno10number
KICI_EVENT_ROUTER_MAX_DISPATCH_ATTEMPTSno5number
KICI_EVENT_ROUTER_RATE_LIMIT_PER_WORKFLOW_PER_MINUTEno100number
KICI_EVENT_ROUTER_RETRY_BASE_BACKOFF_MSno5000number
KICI_EVENT_ROUTER_RETRY_MAX_BACKOFF_MSno300000number
KICI_EVENT_ROUTER_RETRY_SCAN_INTERVAL_MSno10000number
KICI_LOCKFILE_CACHE_MAXno500number
KICI_LOCKFILE_CACHE_TTL_MSno3600000number
KICI_MACHINE_LEDGER_DIRnostring
KICI_MAX_FANOUT_HOSTSno1024number
KICI_MODEno”platform”enum:platform|hybrid|independent
KICI_PG_CUSTOMER_SECRETSno”true”enum:true|false
KICI_PLATFORM_TOKENnostring
KICI_PLATFORM_URLnostring
KICI_PORTno4000number
KICI_QUEUE_BACKPRESSURE_THRESHOLDno100number
KICI_QUEUE_MAX_DEPTHno1000number
KICI_QUEUE_TIMEOUT_MSno3600000number
KICI_ROSTER_GRACE_MSno300000number
KICI_ROSTER_TTL_MSno1800000number
KICI_SCALER_CONFIG_DIRnostring
KICI_SCALER_CONFIG_PATHnostring
KICI_SECRET_KEYnostring
KICI_SECRET_KEY_FILEnostring
KICI_SECRET_KEY_FILE_OLDnostring
KICI_SECRET_KEY_OLDnostring
KICI_SERVER_TLS_CERT_PATHnostring
KICI_SKIP_S3_SENTINEL_VALIDATIONno”false”string
KICI_STALE_DETECTOR_SCAN_INTERVAL_MSno60000number
KICI_STALE_DETECTOR_THRESHOLD_MULTIPLIERno2number
KICI_STORAGE_BUCKETnostring
KICI_STORAGE_ENDPOINTnostring
KICI_STORAGE_EXTERNAL_ENDPOINTnostring
KICI_STORAGE_FORCE_PATH_STYLEnoenum:true|false
KICI_STORAGE_FS_BASE_URLnostring
KICI_STORAGE_FS_PATHnostring
KICI_STORAGE_LOG_BUCKETnostring
KICI_STORAGE_PATHnostring
KICI_STORAGE_PREFIXno”kici-cache/“string
KICI_STORAGE_REGIONnostring
KICI_STORAGE_TYPEnoenum:s3|filesystem
KICI_STORAGE_UPLOAD_ENDPOINTnostring
KICI_TEST_EVENT_FAIL_FIRST_Nnostring
KICI_TEST_MODEno”0”string
KICI_USER_CACHE_QUOTA_BYTESno5368709120numberCluster-wide default per-org byte quota for the user-facing cache (ctx.cache). A per-org override in org_settings.user_cache_quota_bytes (set via kici-admin org-settings user-cache set-quota) takes precedence when present.
KICI_USER_CACHE_TTL_MSno604800000numberCluster-wide default per-entry TTL (ms) for the user-facing cache. A per-org override in org_settings.user_cache_ttl_ms (set via kici-admin org-settings user-cache set-ttl) takes precedence when present.
KICI_WEBHOOK_PAYLOAD_DIRnostring
KICI_WEBHOOK_PUBLIC_URLnostring
KICI_WORKER_CONCURRENCYno5number
NODE_ENVno”development”enum:development|production|test

Not shown above: the KICI_COLD_STORE_* family (consumed directly by cold-store/orchestrator-cold-store.ts, registered in COLD_STORE_ENV_VARS so the typo catcher allows them but not part of the Zod schema). For the full storage env-var inventory plus prefix layout, see orchestrator storage layout.

Env VarConfig PathNotes
KICI_DATABASE_URLdatabase.url
KICI_SERVER_PORTserver.portCoerced to number
KICI_SERVER_BASE_PATHserver.basePath
KICI_SERVER_LOG_LEVELserver.logLevel
KICI_SERVER_TLS_CERT_PATHserver.tlsCertPathPath to TLS cert (PEM) for expiry diagnostic
KICI_INSTANCE_IDinstance.id
KICI_INSTANCE_MODEinstance.mode
KICI_SCALER_CONFIG_PATHscaler.configPath
KICI_SCALER_CONFIG_DIRscaler.configDir
KICI_PLATFORM_URLplatform.url
KICI_PLATFORM_TOKENplatform.tokenSensitive
KICI_AGENT_AUTHagentAuthDefault: token. token or none
KICI_AGENT_TOKEN_TTL_MSagentTokenTtlMsDefault: 3600000 (1h). Coerced to number
KICI_QUEUE_MAX_DEPTHqueue.maxDepthDefault: 1000. Coerced to number
KICI_QUEUE_TIMEOUT_MSqueue.timeoutMsDefault: 3600000 (1h). Coerced to number. How long a job can wait in the dispatch queue before expiring. Set to 0 for indefinite. Also configurable via admin CLI: kici-admin config set queue.timeoutMs <ms>
KICI_QUEUE_BACKPRESSURE_THRESHOLDqueue.backpressureThresholdDefault: 100. Coerced to number. Pending-depth threshold that triggers the operator-facing queue.backpressure.sustained warn log after two consecutive refresher ticks (~10s). 0 disables the warner (Prometheus kici_orch_dispatch_queue_depth gauge and Grafana panel alert continue unaffected). Also configurable via admin CLI: kici-admin config set queue.backpressureThreshold <n>
KICI_LOCKFILE_CACHE_MAXlockfileCache.maxDefault: 500. Coerced to number
KICI_LOCKFILE_CACHE_TTL_MSlockfileCache.ttlMsDefault: 3600000 (1h). Coerced to number
KICI_STALE_DETECTOR_SCAN_INTERVAL_MSstaleDetector.scanIntervalMsDefault: 60000 (1m). Coerced to number
KICI_STALE_DETECTOR_THRESHOLD_MULTIPLIERstaleDetector.thresholdMultiplierDefault: 2. Coerced to number
KICI_JOB_HEARTBEAT_INTERVAL_MSstaleDetector.heartbeatIntervalMsDefault: 60000 (1m). Coerced to number
KICI_SECRET_KEYsecrets.keySensitive
KICI_SECRET_KEY_FILEsecrets.keyFile
KICI_BOOTSTRAP_ADMIN_TOKENsecrets.bootstrapAdminTokenSensitive
KICI_WEBHOOK_PAYLOAD_DIRwebhookPayloadDirOptional. Directory path where the orchestrator fire-and-forget writes every processed webhook payload to disk as <dir>/<repoIdentifier>/<deliveryId>/payload.json. Leave unset to disable the on-disk archive.
KICI_EVENT_LOG_MAX_PAYLOAD_BYTESeventLog.maxPayloadBytesDefault: 5242880 (5 MB). Soft cap for the inbound webhook delivery log (event_log table). Oversized payloads are recorded with payload_omitted=true rather than 413’d; the metadata + hash + size are still durable. Payloads below the cap are gzipped + uploaded to the existing LogStorage adapter at event-log/<orgId>/<deliveryId>.json.gz. Row retention is managed by the cold-store sweeper (see KICI_COLD_STORE_EVENT_LOG_* env vars) rather than a separate retention window.
KICI_CACHE_TTL_DAYScacheTtlDaysDefault: 30. Coerced to number
KICI_CACHE_BUILD_TIMEOUT_MScacheBuildTimeoutMsDefault: 600000 (10m). Coerced to number
KICI_CACHE_MAX_TARBALL_BYTEScacheMaxTarballBytesDefault: 524288000 (500MB). Coerced to number
KICI_USER_CACHE_QUOTA_BYTESuserCacheQuotaBytesDefault: 5368709120 (5 GiB). Coerced to number. Cluster-wide default per-org byte quota for the user-facing cache (ctx.cache); a per-org override in org_settings.user_cache_quota_bytes takes precedence when present
KICI_USER_CACHE_TTL_MSuserCacheTtlMsDefault: 604800000 (7d). Coerced to number. Cluster-wide default per-entry TTL for the user-facing cache; a per-org override in org_settings.user_cache_ttl_ms takes precedence when present
KICI_STORAGE_TYPEstorage.types3
KICI_STORAGE_BUCKETstorage.bucket
KICI_STORAGE_PREFIXstorage.prefix
KICI_STORAGE_REGIONstorage.region
KICI_STORAGE_ENDPOINTstorage.endpoint
KICI_STORAGE_EXTERNAL_ENDPOINTstorage.externalEndpoint
KICI_STORAGE_FORCE_PATH_STYLEstorage.forcePathStyleCoerced to boolean
KICI_STORAGE_LOG_BUCKETstorage.logBucket
KICI_PG_CUSTOMER_SECRETSpgCustomerSecretsCoerced to boolean. Default: true
KICI_CLUSTER_JOIN_TOKENcluster.joinTokenSensitive, one-time use for first join
KICI_CLUSTER_CREDENTIAL_FILEcluster.credentialFileDefault: ~/.kici/peer-credential
KICI_CLUSTER_AUTO_ROTATE_CREDENTIALScluster.autoRotateCredentialsCoerced to boolean. Default: false
KICI_CLUSTER_ADDRESScluster.address
KICI_CLUSTER_INSTANCE_IDcluster.instanceId
KICI_CLUSTER_PEERScluster.peersComma-separated
KICI_CLUSTER_RAFT_ELECTION_TIMEOUT_MIN_MScluster.raftElectionTimeoutMinMsDefault: 5000. Coerced to number
KICI_CLUSTER_RAFT_ELECTION_TIMEOUT_MAX_MScluster.raftElectionTimeoutMaxMsDefault: 10000. Coerced to number
KICI_CLUSTER_RAFT_HEARTBEAT_MScluster.raftHeartbeatMsDefault: 2000. Coerced to number
KICI_CLUSTER_PEER_HEARTBEAT_INTERVAL_MScluster.peerHeartbeatIntervalMsDefault: 30000 (30s). Coerced to number
KICI_CLUSTER_PEER_MAX_RECONNECT_DELAY_MScluster.peerMaxReconnectDelayMsDefault: 60000 (1m). Coerced to number
KICI_CLUSTER_ROLEcluster.roleDefault: coordinator. coordinator or worker
KICI_CLUSTER_COORDINATOR_URLcluster.coordinatorUrlRequired when cluster.role = worker
KICI_CLUSTER_PEER_STALE_TIMEOUT_MScluster.peerStaleTimeoutMsDefault: 60000 (1m). Coerced to number
KICI_EVENT_ROUTER_MAX_CHAIN_DEPTHeventRouter.maxChainDepthDefault: 10. Coerced to number. Maximum depth for chained event routing
KICI_EVENT_ROUTER_RATE_LIMIT_PER_WORKFLOW_PER_MINUTEeventRouter.rateLimitPerWorkflowPerMinuteDefault: 100. Coerced to number. Rate limit per workflow per minute for event routing
KICI_EVENT_ROUTER_EVENT_TTL_SECONDSeventRouter.eventTtlSecondsDefault: 604800 (7d). Coerced to number. Time-to-live for routed events
KICI_EVENT_ROUTER_CLEANUP_INTERVAL_MSeventRouter.cleanupIntervalMsDefault: 3600000 (1h). Coerced to number. Interval between expired event cleanup sweeps
KICI_LOG_LEVELlogLevelDefault: info
KICI_NODE_ENVnodeEnvDefault: development

For multi-provider setups, env vars use the app name from the config (hyphen to underscore, uppercased):

KICI_PROVIDERS_GITHUB_<APP_NAME>_<FIELD>
Env Var PatternConfig PathExample
KICI_PROVIDERS_GITHUB_<NAME>_APP_IDproviders.github[name].appIdKICI_PROVIDERS_GITHUB_MAIN_ORG_APP_ID=12345
KICI_PROVIDERS_GITHUB_<NAME>_PRIVATE_KEYproviders.github[name].privateKeyKICI_PROVIDERS_GITHUB_MAIN_ORG_PRIVATE_KEY=...
KICI_PROVIDERS_GITHUB_<NAME>_WEBHOOK_SECRETproviders.github[name].webhookSecretKICI_PROVIDERS_GITHUB_MAIN_ORG_WEBHOOK_SECRET=whsec_...

App name conversion: YAML main-org becomes env var segment MAIN_ORG (hyphen to underscore, uppercased).

If an env var references an app name that does not exist in the config, a stub app entry is created automatically.

Important: Legacy provider-specific env vars without the KICI_ prefix (e.g., PROVIDERS_GITHUB_APP_ID, PROVIDERS_GITHUB_PRIVATE_KEY, GITHUB_APP_ID) are not recognized. Only NODE_ENV is still honored as a low-priority unprefixed fallback; every other config field requires its KICI_-prefixed env var name.

The full resolution chain is: env var > local YAML > shared DB > defaults.

Example: Suppose the queue max depth is set in three places:

Listed highest-priority first:

SourceValue
Env var KICI_QUEUE_MAX_DEPTH2000
Local YAML(not set)
Shared DB config500
Built-in default1000

The resolved value is 2000 (env var wins). If the env var were absent, it would be 500 (DB wins over default). If the DB config were also absent, it would be 1000 (default).

The orchestrator supports multiple webhook sources simultaneously — GitHub App sources and generic webhook sources alike. Each is managed as a webhook source via the kici-admin source commands (not through config YAML or config seed).

Terminal window
# Add a GitHub App source
kici-admin source add github \
--name main-org \
--app-id 12345 \
--private-key @main-org.pem \
--webhook-secret whsec_main_secret
# Add another app
kici-admin source add github \
--name partner-org \
--app-id 67890 \
--private-key @partner-org.pem \
--webhook-secret whsec_partner_secret

See docs/operator/orchestrator/kici-admin-cli.md for the full source command reference.

Each app registers its own routing key (e.g., github:12345, github:67890) with the Platform relay via source.register messages. The ProviderRegistry maps each routing key to its own provider bundle (normalizer, lock file fetcher, clone token provider, etc.).

One HTTP listener for every source (no per-source ports)

Section titled “One HTTP listener for every source (no per-source ports)”

Every webhook source — GitHub Apps, generic webhooks, internal sources — is served from the single HTTP listener the orchestrator binds at startup. The listener address is controlled by KICI_PORT (one numeric value, no list, no per-source override) and the orchestrator routes inbound deliveries by path, not by port:

  • POST /webhook/:orgId/github — every GitHub App source registered on this orchestrator
  • POST /webhook/:orgId/generic/:sourceId — one path per generic source, distinguished by the sourceId segment

The generic_webhook_sources table has no port column, and kici-admin source add ... exposes no --port flag — there is intentionally no way to give one source its own listener while another stays on KICI_PORT. If you want different upstream URLs per source (different hostnames, different TLS certs, different ingress paths), terminate that distinction at your reverse proxy / load balancer and forward all of them to the orchestrator’s single port. The same KICI_BASE_PATH reverse-proxy pattern documented in getting-started is the supported way to host the orchestrator behind a custom URL prefix.

The KICI_PROVIDERS_GITHUB_<NAME>_<FIELD> env vars (documented in the env var table above) can still inject provider fields into the runtime config object, but the primary mechanism for managing sources is kici-admin source add.

The orchestrator writes to three independent object-storage subsystems (cache, logs, cold-store). The full bucket-and-prefix map — including which env var names which bucket, what data lives under each prefix, and per-table cold-store tuning — lives in storage layout. Two storage-specific quirks worth knowing up front:

Cache storage env vars are KICI_STORAGE_*. The orchestrator reads the KICI_STORAGE_TYPE / KICI_STORAGE_BUCKET / KICI_STORAGE_PREFIX / KICI_STORAGE_REGION / KICI_STORAGE_ENDPOINT / KICI_STORAGE_EXTERNAL_ENDPOINT / KICI_STORAGE_FORCE_PATH_STYLE / KICI_STORAGE_LOG_BUCKET family directly via loadConfig() in packages/orchestrator/src/config.ts and bridges them into the storage.* config field. The names follow the project-wide KICI_-prefix convention and benefit from the unknown-env-var typo catcher at boot.

The log-storage prefix is hardcoded. Step logs are written under kici-logs/... and webhook payloads under event-log/{orgId}/{deliveryId}.json.gz — neither is configurable via env var. If you need a different layout (e.g., to share the log bucket with another service that already owns one of these prefixes), use KICI_STORAGE_LOG_BUCKET to point logs at a dedicated bucket rather than trying to relocate the prefix.

Secrets stored in the shared DB config (private keys, tokens, webhook secrets) are encrypted at rest using AES-256-GCM. The encryption key is derived from a master key that must be available on every orchestrator instance.

Set the master key via:

  • Env var: KICI_SECRET_KEY (64-character hex string or base64-encoded)
  • File: Set secrets.keyFile in orchestrator.yaml pointing to a file containing the key

The master key is the minimum bootstrap secret — the only secret that must be distributed out-of-band to each orchestrator. All other secrets can then be stored encrypted in the database.

When you seed config to the database (kici-admin config seed), the following fields are automatically encrypted before storage:

  • platform.token
  • secrets.key
  • secrets.bootstrapAdminToken
  • cluster.joinToken

Provider secrets (privateKey, webhookSecret) are not part of the config system. They are stored separately via the PgSecretStore in the secrets table, managed through the sources API.

Each encrypted field uses a path-specific AAD (Additional Authenticated Data) in the format config-field:<path>, binding the ciphertext to its specific location in the config tree. The encrypted_paths array is stored alongside each config version so the system knows exactly which fields to decrypt on read.

When you query config via the admin API or CLI (kici-admin config get), sensitive values in the response are redacted as ***REDACTED***.

The auto-scaler configuration (scalers.yaml) remains a separate file, not part of the YAML/DB config system. It is referenced from the local config via scaler.configPath and scaler.configDir.

When SIGHUP is sent to the orchestrator, both the orchestrator config and the scaler config are reloaded together (unified signal). See Auto-scaler configuration for the scaler YAML schema and examples.

On startup, the orchestrator validates the merged config against appConfigSchema (Zod). If validation fails, the service prints all errors and exits:

Configuration validation failed:
- platformUrl: platformUrl is required when mode is platform or hybrid
- platformToken: platformToken is required when mode is platform or hybrid
  • Worker mode requires coordinator URL: If cluster.role is worker, cluster.coordinatorUrl is required
  • Coordinator mode requires database: databaseUrl is required when cluster.role is coordinator (the default). Workers do not need a database connection.
  • Platform/hybrid mode: platformUrl and platformToken are required (skipped for workers)
  • Cluster peers require address: If cluster.peers is set, cluster.address is required
  • S3 storage requires bucket: If storage.type is s3, storage.bucket is required

Validate a YAML file without contacting the orchestrator:

Terminal window
kici-admin config validate --file orchestrator.yaml --type local --offline
kici-admin config validate --file shared-config.yaml --type shared --offline

Each orchestrator instance generates a unique instanceId at startup using a random UUID (e.g., f47ac10b-58cc-4372-a567-0e02b2c3d479). Override with instance.id in YAML or KICI_INSTANCE_ID env var.

orchestrator.yaml:

database:
url: 'postgresql://kici:s3cur3pa55w0rd@postgres:5432/kici'
instance:
mode: 'platform'
server:
port: 4000
logLevel: 'info'

Env vars:

Terminal window
KICI_PROVIDERS_GITHUB_MAIN_ORG_APP_ID=123456
KICI_PROVIDERS_GITHUB_MAIN_ORG_PRIVATE_KEY="$(cat /keys/private-key.pem)"
KICI_PROVIDERS_GITHUB_MAIN_ORG_WEBHOOK_SECRET=whsec_github_secret
KICI_PLATFORM_URL=wss://platform.kici.dev/ws
KICI_PLATFORM_TOKEN=kici_abc123def456
KICI_SECRET_KEY=<64-char-hex-master-key>
KICI_BOOTSTRAP_ADMIN_TOKEN=<admin-token>

orchestrator.yaml:

database:
url: 'postgresql://kici:s3cur3pa55w0rd@postgres:5432/kici'
instance:
mode: 'independent'
server:
port: 4000

orchestrator.yaml:

database:
url: 'postgresql://kici:s3cur3pa55w0rd@postgres:5432/kici'
instance:
mode: 'hybrid'
server:
port: 4000

Shared config (seeded to DB):

platform:
url: 'wss://relay.kici.dev'
storage:
type: 's3'
bucket: 'kici-cache'

Provider credentials (GitHub App private keys, webhook secrets) are not part of the shared config schema. Manage them with kici-admin source add instead — see Multi-Provider Setup.

Mode / RoleEntry PointCMD Override Needed
platformserver.js (default)No
hybridserver.js (default)No
independentstandalone.jsYes: node packages/orchestrator/dist/standalone.js
cluster.role = workerserver.js (default)No (workers bypass mode check, work from any entry)