From 80d4edcf0be923ba2c1ea9f0026ba909e7d517f8 Mon Sep 17 00:00:00 2001 From: PhatPhuckDave Date: Wed, 7 Jan 2026 20:31:59 +0100 Subject: [PATCH] Update readme --- .gitignore | 1 + README.md | 14 ++++---------- docker-compose.yml | 2 +- 3 files changed, 6 insertions(+), 11 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e377551 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +nginx-data diff --git a/README.md b/README.md index 8167d6b..04abee8 100644 --- a/README.md +++ b/README.md @@ -23,17 +23,12 @@ The nginx configuration implements an inverted caching logic: ## Usage -Both URL formats are supported: - ```bash -# Path-based URL format (recommended) -curl http://localhost:3001/https://api.example.com/data - -# Query parameter format (legacy) -curl "http://localhost:3001/?url=https://api.example.com/data" +# Proxy a URL +curl "http://localhost:3000/?url=https://api.example.com/data" # Enable caching with X-Cache header -curl -H "X-Cache: 1" http://localhost:3001/https://api.example.com/data +curl -H "X-Cache: 1" "http://localhost:3000/?url=https://api.example.com/data" ``` ## Features @@ -42,9 +37,8 @@ curl -H "X-Cache: 1" http://localhost:3001/https://api.example.com/data - Cache zone: `api_cache` (10MB) - Max cache size: 1GB - Cache validity: 365 days for 200 responses -- Cache key: Based on scheme, host, URI, and query parameters - Cache status header: `X-Cache-Status` shows cache hit/miss status -- Health endpoint: `GET /health` returns "healthy" for container health checks +- HTTPS support with proper SSL/TLS headers ## In n8n diff --git a/docker-compose.yml b/docker-compose.yml index 9b58745..fbf33e8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,7 +3,7 @@ services: # image: nginx:alpine image: docker.site.quack-lab.dev/nginx-cache-proxy:latest ports: - - "3001:3001" + - "3000:3000" volumes: # - ./nginx.conf:/etc/nginx/nginx.conf:ro - nginx-data:/etc/nginx/data