32 lines
697 B
Markdown
32 lines
697 B
Markdown
# Nginx Cache Proxy
|
|
|
|
Navigate to `http://localhost:3000/` for interactive usage with URL builder.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Build and run
|
|
./build.sh && docker-compose up
|
|
|
|
# Or run directly
|
|
docker run -p 3000:3000 docker.site.quack-lab.dev/nginx-cache-proxy:latest
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# Proxy and cache any URL
|
|
curl "http://localhost:3000/?url=https://api.example.com/data"
|
|
|
|
# Skip cache for this request
|
|
curl -H "X-NoCache: 1" "http://localhost:3000/?url=https://api.example.com/data"
|
|
```
|
|
|
|
## Features
|
|
|
|
- **Always caches** 2xx status codes for 1 year
|
|
- Cache size: 100GB max
|
|
- X-Cache-Status header shows cache status
|
|
- X-NoCache header bypasses cache
|
|
- Interactive web interface at root path
|