Welcome to the httpcache documentation! This directory contains detailed guides organized by topic.
- Main README - Project overview, features, quick start, and installation
- Cache Backends - Choose and configure storage backends
- How It Works - Understanding the caching mechanism
- Advanced Features - Transport configuration, custom cache control, and advanced options
- Security Considerations - Multi-user applications and secure caching
- Monitoring - Prometheus metrics integration
- Examples - Complete, runnable examples for all backends and features
- Tests - Test utilities and helpers
I want to...
- Start quickly → Quick Start + Memory Cache Example
- Use Redis → Redis Backend + Redis Example
- Cache per-user data → Cache Key Headers + Security Guide
- Add encryption → Secure Cache Wrapper + Security Example
- Monitor performance → Monitoring Guide + Prometheus Example
- Handle stale content → Stale-If-Error + How It Works
Core Concepts:
Backends:
Advanced:
- Transport Configuration
- Custom Logger
- Stale-While-Revalidate
- Custom Cache Control
- Vary Header Limitations
Security:
Operations:
- RFC 9111 - HTTP Caching (current standard, obsoletes RFC 7234)
- RFC 7234 - HTTP Caching (obsoleted by RFC 9111)
- RFC 5861 - Cache-Control Extensions for Stale Content
- GoDoc API Reference
Found an error in the documentation? Want to add examples or clarifications?
- Check the Contributing Guide
- Open an issue or pull request
- Help improve the docs for everyone!
Our documentation follows these principles:
- Clear and concise - Get to the point quickly
- Code examples - Show, don't just tell
- Real-world use cases - Practical scenarios
- Cross-referenced - Easy navigation between topics
- Up-to-date - Maintained alongside code changes