http://www.predatorray.me/candybox/docs/reference/Recent content in Reference on CandyboxHugoen-ushttp://www.predatorray.me/candybox/docs/reference/configuration/Mon, 01 Jan 0001 00:00:00 +0000http://www.predatorray.me/candybox/docs/reference/configuration/<h1 id="configuration">Configuration<a class="anchor" href="#configuration">#</a></h1> <p>A node reads <code>conf/candybox.properties</code>. <strong>Every key can be overridden by an environment variable</strong> named <code>CANDYBOX_&lt;KEY&gt;</code> (dots become underscores, upper-cased) — for example <code>CANDYBOX_ZOOKEEPER_CONNECT</code> — and the environment value wins. This makes it easy to ship one image and configure each instance through the environment.</p> <h2 id="common-keys">Common keys<a class="anchor" href="#common-keys">#</a></h2> <table> <thead> <tr> <th>Key</th> <th>Meaning</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>node.id</code></td> <td>Cluster-unique node id. Falls back to the trailing number in <code>$HOSTNAME</code> (so a Kubernetes pod <code>candybox-2</code> becomes node <code>2</code>).</td> <td>—</td> </tr> <tr> <td><code>zookeeper.connect</code></td> <td>ZooKeeper connect string, shared by BookKeeper and Candybox coordination.</td> <td><code>127.0.0.1:2181</code></td> </tr> <tr> <td><code>server.bind</code></td> <td>Address clients connect to.</td> <td><code>0.0.0.0:9709</code></td> </tr> <tr> <td><code>server.advertised</code></td> <td>Address published to the cluster for routing (set to a reachable hostname).</td> <td>bind address</td> </tr> <tr> <td><code>health.port</code></td> <td>HTTP port for <code>/healthz</code>, <code>/readyz</code>, <code>/metrics</code>.</td> <td><code>9710</code></td> </tr> <tr> <td><code>quorum.*</code></td> <td>BookKeeper replication per ledger role (<code>E/Qw/Qa</code>).</td> <td><code>3/3/2</code> (WAL, manifest), <code>3/2/2</code> (data)</td> </tr> <tr> <td><code>multipart.upload.ttl.millis</code></td> <td>How long an abandoned multipart upload is kept before a background sweep aborts it.</td> <td>7 days</td> </tr> <tr> <td><code>rename.intent.abandon.millis</code></td> <td>Cross-partition rename: how long the source owner keeps a rename intent whose destination rendezvous marker never appears before dropping it (the source stays live).</td> <td>60000 (60 s)</td> </tr> </tbody> </table> <h2 id="full-reference">Full reference<a class="anchor" href="#full-reference">#</a></h2> <p>The complete, commented list of keys lives in <a href="https://github.com/predatorray/candybox/blob/main/candybox-dist/src/conf/candybox.properties.example"><code>candybox.properties.example</code></a>, and the <code>CandyboxConfig</code> section of <a href="https://github.com/predatorray/candybox/blob/main/OPERATIONS.md#configuration-reference-candyboxconfig"><code>OPERATIONS.md</code></a> documents the operational meaning of each tunable, including the security, consistency, and garbage collection settings.</p>