Candybox documentation#

Welcome to the Candybox manual. Candybox is a distributed, S3-like object store backed by a distributed LSM tree on Apache BookKeeper.

Use the navigation on the left to browse, or jump to a common starting point:

• Getting started — run a cluster and store your first object.
• Installation & downloads — Docker image, distribution tarball, and client library.
• Concepts & architecture — the LSM engine, ledgers, and fenced ownership.
• Command-line client — the candybox CLI and the Java client library.
• S3 gateway — the S3-compatible HTTP endpoint.
• Operations — running, monitoring, and Kubernetes.
• Configuration reference — every tunable key.

Candybox is pre-1.0 (current version 0.1.0-SNAPSHOT). APIs, wire protocol, and on-disk formats may still change between releases.