User Guide¶
This guide is for operators, DBAs, and developers using HyperbyteDB as a time-series database. You do not need to read the source code.
How to follow this guide¶
Use this order the first time you deploy HyperbyteDB: install the software, tune configuration, prove reads and writes, then add security and advanced options. Later you can jump to any page from the list below.
| Step | Page | What you will do |
|---|---|---|
| 1 | Installation | Run HyperbyteDB with Docker, from source, on kind, or with the Kubernetes operator on a real cluster. |
| 2 | Configuration | Set config.toml and HYPERBYTEDB__* environment variables. |
| 3 | Basic operations | Create a database, write line protocol, run InfluxQL, manage retention. |
| 4 | Authentication | Optional: require credentials on /write and /query, admin access for internal APIs. |
| 5 | Advanced features | Clustering, continuous queries, TLS, S3 storage, statement summary. |
| 6 | Common workflows | Migrate from InfluxDB 1.x, wire Telegraf and Grafana, monitoring patterns. |
| 7 | Administration | Backups, Prometheus metrics, compaction, cluster drain, debug CLI. |
| 8 | Troubleshooting | Fix common startup, query, cardinality, and cluster issues. |
| 9 | API & InfluxQL reference | Full HTTP surface, InfluxQL syntax, compatibility notes. |
Prerequisites¶
| Requirement | Details |
|---|---|
| Platform | Linux x86_64 (libchdb requirement) |
| Runtime | Docker, or Rust + libchdb for source builds |
| Network | Port 8086 by default for the HTTP API |