Environment Variables

All Code Search configuration can be set via environment variables. This page provides a complete reference.

Naming Convention

Environment variables follow this pattern:

• Prefix: CS_
• Nested keys: separated by _
• All uppercase

Example: server.addr → CS_SERVER_ADDR

Complete Reference

Server Configuration

Variable	Description	Default
CS_SERVER_ADDR	Listen address (host:port)	:8080
CS_SERVER_READ_TIMEOUT	HTTP read timeout	15s
CS_SERVER_WRITE_TIMEOUT	HTTP write timeout	60s

Database Configuration

Variable	Description	Default
CS_DATABASE_URL	PostgreSQL connection string	-
CS_DATABASE_MAX_OPEN_CONNS	Maximum open connections	25
CS_DATABASE_MAX_IDLE_CONNS	Maximum idle connections	5
CS_DATABASE_CONN_MAX_LIFETIME	Connection max lifetime	5m

Redis Configuration

Variable	Description	Default
CS_REDIS_ADDR	Redis address (host:port)	localhost:6379
CS_REDIS_PASSWORD	Redis password	-
CS_REDIS_DB	Redis database number	0

Zoekt Configuration

Variable	Description	Default
CS_ZOEKT_URL	Zoekt server URL	http://localhost:6070
CS_ZOEKT_INDEX_PATH	Index directory path	-
CS_ZOEKT_SHARDS	Number of shards (0=auto)	0

Indexer Configuration

Variable	Description	Default
CS_INDEXER_CONCURRENCY	Concurrent indexing jobs	2
CS_INDEXER_INDEX_PATH	Index directory path	-
CS_INDEXER_REPOS_PATH	Repositories directory path	-
CS_INDEXER_REINDEX_INTERVAL	Reindex interval	1h
CS_INDEXER_ZOEKT_BIN	Zoekt indexer binary	zoekt-git-index

Repository Configuration

Variable	Description	Default
CS_REPOS_BASE_PATH	Base path for repo clones	-
CS_REPOS_READONLY	Disable repo delete via UI	false

Scheduler Configuration

Variable	Description	Default
CS_SCHEDULER_ENABLED	Enable auto-scheduling	true
CS_SCHEDULER_POLL_INTERVAL	Default sync interval	6h
CS_SCHEDULER_CHECK_INTERVAL	Check interval	5m
CS_SCHEDULER_STALE_THRESHOLD	Stale repo threshold	24h
CS_SCHEDULER_MAX_CONCURRENT_CHECKS	Parallel checks	5
CS_SCHEDULER_JOB_RETENTION	Job retention period	1h

Replace Configuration

Variable	Description	Default
CS_REPLACE_CONCURRENCY	Parallel repo processing	3
CS_REPLACE_CLONE_TIMEOUT	Git clone timeout	10m
CS_REPLACE_PUSH_TIMEOUT	Git push timeout	5m
CS_REPLACE_MAX_FILE_SIZE	Max file size (bytes)	10485760

Rate Limiting

Variable	Description	Default
CS_RATE_LIMIT_ENABLED	Enable rate limiting	false
CS_RATE_LIMIT_REQUESTS_PER_SECOND	Requests per second per IP	10
CS_RATE_LIMIT_BURST_SIZE	Maximum burst size	20

Metrics Configuration

Variable	Description	Default
CS_METRICS_ENABLED	Enable Prometheus metrics	true
CS_METRICS_PATH	Metrics endpoint path	/metrics

Tracing Configuration (OpenTelemetry)

Variable	Description	Default
CS_TRACING_ENABLED	Enable OpenTelemetry tracing	false
CS_TRACING_SERVICE_NAME	Service name for traces	code-search
CS_TRACING_SERVICE_VERSION	Service version	1.0.0
CS_TRACING_ENVIRONMENT	Deployment environment	development
CS_TRACING_ENDPOINT	OTLP endpoint	localhost:4317
CS_TRACING_PROTOCOL	Protocol (grpc/http)	grpc
CS_TRACING_SAMPLE_RATE	Sampling rate (0.0-1.0)	1.0
CS_TRACING_INSECURE	Disable TLS	true

Also supports standard OpenTelemetry and Datadog environment variables:

• OTEL_SERVICE_NAME, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_PROTOCOL
• DD_SERVICE, DD_VERSION, DD_ENV, DD_TRACE_ENABLED

Sharding Configuration (Horizontal Scaling)

Variable	Description	Default
CS_SHARDING_ENABLED	Enable hash-based sharding	false
CS_SHARDING_TOTAL_SHARDS	Number of indexer shards	1
CS_SHARDING_INDEXER_API_PORT	HTTP API port for federated access	8081
CS_SHARDING_INDEXER_SERVICE	Headless service for pod discovery	code-search-indexer-headless
CS_SHARDING_FEDERATED_ACCESS	Enable federated file browsing/replace	false

Search Configuration

Variable	Description	Default
CS_SEARCH_ENABLE_STREAMING	Enable true streaming from Zoekt	false

When streaming is enabled, search results are sent to the client as they arrive from Zoekt, rather than waiting for all results. This provides faster time-to-first-result, especially for large result sets.

Note

Replace operations always use batch search regardless of this setting, as they need all results upfront to display the preview.

UI Configuration

Variable	Description	Default
CS_UI_HIDE_READONLY_BANNER	Hide read-only mode banner	false
CS_UI_HIDE_FILE_NAVIGATOR	Hide browse links in search results	false
CS_UI_DISABLE_BROWSE_API	Disable browse API endpoints	false

Connection Configuration

Variable	Description	Default
CS_CONNECTIONS_READONLY	Lock connections to config	false

Config File Path

Variable	Description	Default
CS_CONFIG_FILE	Path to config file	Auto-discovered

Docker Compose Example

services:
  api:
    image: ghcr.io/techquestsdev/code-search-api:latest
    environment:
      CS_DATABASE_URL: postgres://user:pass@postgres:5432/codesearch?sslmode=disable
      CS_REDIS_ADDR: redis:6379
      CS_ZOEKT_URL: http://zoekt:6070
      CS_SERVER_ADDR: ":8080"
      CS_SCHEDULER_ENABLED: "true"
      CS_SCHEDULER_POLL_INTERVAL: "6h"

  indexer:
    image: ghcr.io/techquestsdev/code-search-indexer:latest
    environment:
      CS_DATABASE_URL: postgres://user:pass@postgres:5432/codesearch?sslmode=disable
      CS_REDIS_ADDR: redis:6379
      CS_INDEXER_INDEX_PATH: /data/index
      CS_INDEXER_REPOS_PATH: /data/repos
      CS_INDEXER_CONCURRENCY: "2"

Kubernetes ConfigMap/Secret

apiVersion: v1
kind: Secret
metadata:
  name: code-search-secrets
type: Opaque
stringData:
  CS_DATABASE_URL: "postgres://user:pass@postgres:5432/codesearch"
  CS_REDIS_PASSWORD: ""
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: code-search-config
data:
  CS_SERVER_ADDR: ":8080"
  CS_REDIS_ADDR: "redis:6379"
  CS_ZOEKT_URL: "http://zoekt:6070"
  CS_INDEXER_CONCURRENCY: "2"
  CS_SCHEDULER_ENABLED: "true"
  CS_SCHEDULER_POLL_INTERVAL: "6h"

Shell Script

#!/bin/bash

# Database and Redis
export CS_DATABASE_URL="postgres://user:pass@localhost:5432/codesearch?sslmode=disable"
export CS_REDIS_ADDR="localhost:6379"

# Server
export CS_SERVER_ADDR=":8080"
export CS_SERVER_READ_TIMEOUT="15s"
export CS_SERVER_WRITE_TIMEOUT="60s"

# Zoekt
export CS_ZOEKT_URL="http://localhost:6070"
export CS_INDEXER_INDEX_PATH="./data/index"
export CS_INDEXER_REPOS_PATH="./data/repos"

# Indexer
export CS_INDEXER_CONCURRENCY="2"
export CS_INDEXER_REINDEX_INTERVAL="1h"

# Scheduler
export CS_SCHEDULER_ENABLED="true"
export CS_SCHEDULER_POLL_INTERVAL="6h"
export CS_SCHEDULER_CHECK_INTERVAL="5m"
export CS_SCHEDULER_STALE_THRESHOLD="24h"

# Readonly modes
export CS_REPOS_READONLY="false"
export CS_CONNECTIONS_READONLY="false"

# Start the API server
./bin/api-server

Duration Format

Duration values use Go’s duration format:

Suffix	Meaning	Example
s	Seconds	30s
m	Minutes	10m
h	Hours	6h

Combine for complex durations: 1h30m, 2h45m30s

Boolean Values

Boolean environment variables accept:

• True: true, 1, yes, on
• False: false, 0, no, off