Documentation¶

HyperbyteDB is a time-series database written in Rust. It speaks the InfluxDB v1 HTTP API, stores data in embedded chDB MergeTree tables, and uses RocksDB for the write-ahead log and metadata. Clustered deployments use Raft for schema consensus and asynchronous replication for writes.

Quick start¶

docker run -d \
  --name hyperbytedb \
  -p 8086:8086 \
  ghcr.io/hyperbyte-cloud/hyperbytedb:latest

docker exec -it hyperbytedb \
  hyperbytedb-cli create database mydb

docker exec -it hyperbytedb \
  hyperbytedb-cli write -database mydb \
  --data-binary 'cpu,host=srv01 value=42'

  docker exec -it hyperbytedb \
  hyperbytedb-cli query -database mydb \
  --data-urlencode 'q=SELECT * FROM cpu'

User guide¶

For operators and application developers deploying HyperbyteDB.

Topic	Description
Installation	Docker, Compose, binaries, kind, Kubernetes operator
Configuration	`config.toml` and `HYPERBYTEDB__*` environment variables
Basic operations	Databases, writes, queries, retention
Authentication	Credentials, public routes, admin APIs
Advanced features	Clustering, continuous queries, TLS, tracing
Common workflows	InfluxDB migration, Telegraf, Grafana, monitoring
Administration	Metrics, logs, traces, backup, cluster ops
Troubleshooting	Common problems
API reference	HTTP endpoints and TimeseriesQL compatibility
Kubernetes operator	Helm install, CRDs, backups

Start with the user guide index for a recommended reading order.

Developer guide¶

For contributors working on the codebase.

Topic	Description
Architecture	Hexagonal design and data flow
Development setup	Build, run, and debug locally
Testing	Test suites and CI
Contributing	PR process and review checklist

See the developer guide index for internals and deep dives.

Other references¶

Glossary — shared terminology
Benchmarks — Criterion ingestion benchmarks
Deep dives — write path, read path, clustering, compaction
Container image: ghcr.io/hyperbyte-cloud/hyperbytedb:latest