Home

🧠 Welcome to the CacheBolt Wiki

CacheBolt is a blazing-fast reverse proxy with smart caching and multi-backend object storage support (S3, GCS, Azure, Local). This wiki provides detailed documentation for users, operators, and developers.

---

📚 Table of Contents

🚀 Introduction

• What is CacheBolt?
• Common Use Cases

⚙️ Usage Guides

• Installation and Binaries
• YAML Configuration
• Running with Docker
• Admin UI (Web Interface)

📦 Cache Storage

• Multi-backend Support (S3, GCS, Azure, Local)
• Cloud Authentication
• Memory-Based Eviction
• Probabilistic Refreshing

📈 Observability

• Prometheus Metrics
• Tracing with OpenTelemetry (WIP)

💡 Architecture & Request Flow

• Request Lifecycle
• Latency-based Failover
• Concurrency Limiting

🔧 Advanced

• Invalidate Full Cache
• Inspect In-Memory Cache
• Cross Compilation
• Bundled UI Integration (Svelte)

🛠️ Development

• Building Locally
• Codebase Structure
• Testing

📜 Legal

• License

---

What is CacheBolt?

CacheBolt is a high-performance reverse proxy that serves responses with minimal latency — even when upstream services are slow or unavailable. It combines fast in-memory caching, persistent backend storage, and latency-based failover logic.

---

Common Use Cases

• Accelerating public or internal REST APIs
• Serving static files backed by S3/GCS/Azure
• Shielding unstable services with smart failover
• Increasing availability during backend deployments
• Viewing and managing cached responses via Web UI

---

➡️ Ready to get started? Head over to the Installation Guide