Usage Guides

This section walks you through how to install, configure, and run CacheBolt, including binary usage, Docker support, and the built-in Admin Web UI.

---

📥 Installation and Binaries

You can download the latest precompiled binaries from the latest GitHub release:

Platform	File
macOS (Apple Silicon)	cachebolt-aarch64-apple-darwin.tar.gz
macOS (Intel)	cachebolt-x86_64-apple-darwin.tar.gz
Linux (ARM64)	cachebolt-aarch64-unknown-linux-gnu.tar.gz
Linux (x86_64, musl)	cachebolt-x86_64-unknown-linux-musl.tar.gz
Windows (x86_64)	cachebolt-x86_64-pc-windows-gnu.zip

To run CacheBolt with the default config:

./cachebolt

To run with a custom config path:

./cachebolt --config ./config/prod.yaml

🐳 Running with Docker

You can use the official Docker image hosted on GitHub Container Registry:

docker run --rm -p 3000:3000 \
  -v $(pwd)/config:/config \
  -v $(pwd)/cache:/data \
  -e GOOGLE_APPLICATION_CREDENTIALS=/config/adc.json \
  ghcr.io/msalinas92/cachebolt:latest \
  --config /config/config.yaml

Note: Make sure to mount both your configuration file and any necessary cloud credentials (e.g. ADC for GCP).

---

🛠 YAML Configuration

CacheBolt uses a YAML configuration file. By default, it looks for config.yaml in the current directory.

Minimal example:

app_id: my-service
downstream_base_url: http://localhost:4000
storage_backend: local

cache:
  memory_threshold: 80
  refresh_percentage: 10

latency_failover:
  default_max_latency_ms: 3000