⚙️ Configuration

Gigapipe has no configuration files by design — just ENV variables

💡 Gigapipe OSS is K8s and Docker container friendly. All parameters are optional except CLICKHOUSE_SERVER.

🗄️ ClickHouse Settings

Connection to your ClickHouse backend. CLICKHOUSE_SERVER is the only required parameter.

Variable	Default	Description
`CLICKHOUSE_SERVER`	localhost	ClickHouse server address required
`CLICKHOUSE_PORT`	9000	ClickHouse server port (binary)
`CLICKHOUSE_DB`	qryn	ClickHouse database name
`CLICKHOUSE_AUTH`	default:	Authentication (`user:password`)
`CLICKHOUSE_PROTO`	tcp	Protocol (`tcp`, `tls`)
`CLICKHOUSE_TIMEFIELD`	record_datetime	DateTime column for native queries
`CLUSTER_NAME`	—	ClickHouse cluster name
`STORAGE_POLICY`	—	ClickHouse cluster storage policy
`SELF_SIGNED_CERT`	false	Allow self-signed TLS certificates

📥 Ingestion & Retention

Controls bulk insert behaviour and data retention windows.

Variable	Default	Description
`BULK_MAXAGE`	2000	Max age for bulk inserts (ms)
`BULK_MAXSIZE`	5000	Max size for bulk inserts
`BULK_MAXCACHE`	50000	Max labels in memory cache
`BULK_MAX_SIZE_BYTE`	—	Max bulk size in bytes (empty = infinite)
`BULK_MAX_AGE_MS`	100	Max bulk age in ms (min 100ms)
`LABELS_DAYS`	7	Max days before label rotation
`SAMPLES_DAYS`	7	Max days before timeseries rotation

🌐 Server Settings

HTTP API binding, authentication and operational mode.

Variable	Default	Description
`HOST`	0.0.0.0	HTTP API bind address
`PORT`	3100	HTTP API port
`QRYN_LOGIN`	—	Basic HTTP username
`QRYN_PASSWORD`	—	Basic HTTP password
`CORS_ALLOW_ORIGIN`	*	CORS allow origin
`READONLY`	false	Readonly mode, no DB init
`OMIT_CREATE_TABLES`	false	Skip database provisioning on startup dangerous
`MODE`	all	`all`, `writer`, `reader`, `init_only`
`LOG_LEVEL`	info	Log level
`DEBUG`	false	Debug mode (backwards compatibility)
`LOG_DRILLDOWN`	false	Enable drill-down features for logs

🔬 Advanced Settings

Query tuning, tracing, hashing and alerting configuration.

Variable	Default	Description
`HASH`	xxhash64	Hash function for fingerprints (`short-hash`, `xxhash64`)
`ADVANCED_PROMETHEUS_MAX_SAMPLES`	5000000	Max samples per PromQL request
`ADVANCED_SAMPLES_ORDERING`	timestamp_ns	ORDER BY for samples table (comma-separated for multiple)
`TEMPO_SPAN`	24	Default span for Tempo queries (hours)
`TEMPO_TAGTRACE`	false	Optional tagging of TraceID expensive
`ALERTMAN_URL`	—	Alertmanager API URL (e.g. `http://alertmanager:9093`)

💾 Resource Recommendations

We suggest 8 GB RAM or higher for most setups with 100k–1M fingerprints. Monitor your daily/weekly data volume to forecast disk requirements. Compression codecs and other optimisations can be applied at the ClickHouse level.