User Guide
This guide covers deploying, configuring, and operating HyperbyteDB. You do not need to read the source code.
Reading order
| Step | Page | What you will do |
| 1 | Installation | Run HyperbyteDB with Docker, Compose, or the Kubernetes operator |
| 2 | Configuration | Set config.toml and environment variables |
| 3 | Basic operations | Create a database, write line protocol, run TimeseriesQL |
| 3b | CLI (hyperbytedb-cli) | Interactive shell, batch queries, write/import from the terminal |
| 4 | Authentication | Optional: require credentials on /write and /query |
| 4b | Rate limiting | Optional: cap /write and /query request rates |
| 5 | Advanced features | Clustering, continuous queries, TLS, tracing |
| 6 | Common workflows | Migrate from InfluxDB 1.x, wire Telegraf and Grafana |
| 7 | Administration | Metrics, logs, traces, backups, cluster operations |
| 8 | Troubleshooting | Fix startup, query, and cluster issues |
| 9 | API reference | HTTP endpoints and TimeseriesQL compatibility |
| 10 | Resource sizing | CPU, memory, disk, and cluster sizing guidelines |
| 11 | V1 stable scope | Supported topologies, guarantees, and breaking-change policy |
Prerequisites
| Requirement | Details |
| Platforms | Linux x86_64 or aarch64 for pre-built images and tarballs |
| Runtime | Docker, Docker Compose, or Kubernetes with the HyperbyteDB operator |
| Network | Port 8086 by default for the HTTP API |