Add cache logs

Try and "stop" the 502s that esi throws us
Update the html readme
2026-01-07 21:52:09 +01:00 · 2026-01-07 21:43:48 +01:00 · 2026-01-07 21:38:42 +01:00 · 2026-01-07 21:23:00 +01:00 · 2026-01-07 21:12:30 +01:00
4 changed files with 167 additions and 25 deletions
--- a/3
+++ b/3
@@ -1,7 +1,8 @@
 FROM nginx:alpine
-# Copy nginx configuration
+# Copy nginx configuration and HTML
 COPY nginx.conf /etc/nginx/nginx.conf
 COPY index.html /usr/share/nginx/html/index.html
 # Create data directories
 RUN mkdir -p /etc/nginx/data/cache /etc/nginx/data/temp && \
--- a/README.md
+++ b/README.md
@@ -1,15 +1,12 @@
 # Nginx Cache Proxy
-An nginx proxy server that caches requests only when explicitly requested via the `X-Cache: 1` header.
+Navigate to `http://localhost:3000/` for interactive usage with URL builder.
 ## Quick Start
 ```bash
-# Build the image
+# Build and run
-./build.sh
+./build.sh && docker-compose up
 # Run with docker-compose (uses the built image)
 docker-compose up
 # Or run directly
 docker run -p 3000:3000 docker.site.quack-lab.dev/nginx-cache-proxy:latest
@@ -20,19 +17,15 @@ docker run -p 3000:3000 docker.site.quack-lab.dev/nginx-cache-proxy:latest
 ```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** all proxied requests
+- **Always caches** 2xx status codes for 1 year
- Cache path: `/etc/nginx/data/cache`
+- Cache size: 100GB max
- Cache zone: `api_cache` (10MB memory)
+- X-Cache-Status header shows cache status
- Max cache size: 100GB
+- X-NoCache header bypasses cache
- Cache validity: 365 days for 200 responses
+- Interactive web interface at root path
 - Max request size: 128MB
 - Cache status header: `X-Cache-Status` shows cache hit/miss status
 - HTTPS support with proper SSL/TLS headers
 ## In n8n
 Add the `X-Cache: 1` header only to requests you want cached. All other requests will bypass the cache completely.
--- a/index.html
+++ b/index.html
@@ -0,0 +1,136 @@
 <!DOCTYPE html>
 <html>
 <head>
    <title>Nginx Cache Proxy</title>
    <style>
        :root {
            --bg: #ffffff;
            --text: #333333;
            --heading: #007cba;
            --border: #007cba;
            --code-bg: #f4f4f4;
            --code-inline-bg: #f4f4f4;
            --pre-bg: #2d2d2d;
            --pre-text: #f8f8f2;
            --copy-bg: #e8f4fd;
            --copy-border: #007cba;
            --success: #28a745;
            --error: #dc3545;
        }
        @media (prefers-color-scheme: dark) {
            :root {
                --bg: #1a1a1a;
                --text: #e0e0e0;
                --heading: #58a6ff;
                --border: #58a6ff;
                --code-bg: #2d2d2d;
                --code-inline-bg: #3d3d3d;
                --pre-bg: #0d0d0d;
                --copy-bg: #1c3d5e;
                --copy-border: #58a6ff;
                --success: #3fb950;
                --error: #f85149;
            }
        }
        body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; max-width: 800px; margin: 0 auto; padding: 20px; line-height: 1.6; color: var(--text); background: var(--bg); }
        h1 { border-bottom: 2px solid var(--border); padding-bottom: 10px; color: var(--text); }
        h2 { color: var(--heading); margin-top: 30px; }
        h3 { color: var(--text); opacity: 0.8; }
        code { background: var(--code-inline-bg); padding: 2px 6px; border-radius: 3px; font-family: "Consolas", "Monaco", monospace; font-size: 0.9em; color: var(--text); }
        pre { background: var(--pre-bg); color: var(--pre-text); padding: 15px; border-radius: 5px; overflow-x: auto; }
        pre code { background: none; padding: 0; color: inherit; }
        .copy-section { background: var(--copy-bg); padding: 20px; border-radius: 8px; margin: 20px 0; border-left: 4px solid var(--copy-border); }
        .copy-section h3 { margin-top: 0; color: var(--text); }
        .copy-section p { color: var(--text); }
        button { background: var(--heading); color: white; border: none; padding: 12px 24px; cursor: pointer; border-radius: 5px; font-size: 14px; font-weight: 600; }
        button:hover { filter: brightness(0.9); }
        .status { margin-top: 10px; font-size: 14px; }
        .status.success { color: var(--success); }
        .status.error { color: var(--error); }
        ul { line-height: 1.8; }
        li { color: var(--text); }
    </style>
 </head>
 <body>
    <h1>Nginx Cache Proxy</h1>
    <p>Proxy and cache any HTTP/HTTPS URL with automatic caching.</p>
    <div class="copy-section">
        <h3>Quick Copy</h3>
        <p>Copy this proxy URL with <code>?url=</code> appended, then paste any URL after it:</p>
        <button onclick="copyProxyUrl()">Copy Proxy URL</button>
        <div id="status" class="status"></div>
    </div>
    <h2>Usage Examples</h2>
    <h3>Basic Proxy (Cached)</h3>
    <pre><code id="basicExample">Loading...</code></pre>
    <h3>Skip Cache</h3>
    <pre><code id="nocacheExample">Loading...</code></pre>
    <h2>Features</h2>
    <ul>
        <li>Always caches <strong>2xx</strong> status codes for <strong>1 year</strong></li>
        <li>Cache size: <strong>100GB</strong> max</li>
        <li><code>X-Cache-Status</code> header shows cache hit/miss</li>
        <li><code>X-NoCache</code> header bypasses cache</li>
        <li>Interactive web interface</li>
    </ul>
    <script>
        function getBaseUrl() {
            const protocol = window.location.protocol;
            const hostname = window.location.hostname;
            const port = window.location.port;
            let baseUrl = protocol + '//' + hostname;
            if ((protocol === 'http:' && port !== '80' && port !== '') ||
                (protocol === 'https:' && port !== '443' && port !== '')) {
                baseUrl += ':' + port;
            }
            return baseUrl;
        }
        document.addEventListener('DOMContentLoaded', function() {
            const base = getBaseUrl();
            document.getElementById('basicExample').textContent =
                'curl "' + base + '/?url=https://api.example.com/data"';
            document.getElementById('nocacheExample').textContent =
                'curl -H "X-NoCache: 1" "' + base + '/?url=https://api.example.com/data"';
        });
        function copyProxyUrl() {
            const proxyUrl = window.location.href + '?url=';
            const statusEl = document.getElementById('status');
            navigator.clipboard.writeText(proxyUrl).then(() => {
                statusEl.className = 'status success';
                statusEl.textContent = 'Copied: ' + proxyUrl;
            }).catch(err => {
                // Fallback for older browsers
                const textArea = document.createElement('textarea');
                textArea.value = proxyUrl;
                textArea.style.position = 'fixed';
                textArea.style.opacity = '0';
                document.body.appendChild(textArea);
                textArea.select();
                try {
                    document.execCommand('copy');
                    statusEl.className = 'status success';
                    statusEl.textContent = 'Copied: ' + proxyUrl;
                } catch (e) {
                    statusEl.className = 'status error';
                    statusEl.textContent = 'Copy failed. URL: ' + proxyUrl;
                }
                document.body.removeChild(textArea);
            });
        }
    </script>
 </body>
 </html>
--- a/nginx.conf
+++ b/nginx.conf
@@ -11,18 +11,20 @@ http {
    proxy_cache_path /etc/nginx/data/cache levels=1:2 keys_zone=api_cache:10m max_size=100g inactive=365d;
-    error_log /dev/stdout debug;
+    error_log /dev/stdout warn;
    access_log /dev/stdout;
-    # Use Docker's internal DNS
+    log_format main '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" cache:$upstream_cache_status';
-    resolver 127.0.0.11 valid=10s;
+    access_log /dev/stdout main;
    resolver 127.0.0.11 valid=60s;
    server {
        listen 3000;
        location / {
            # If no url parameter, serve the readme
            if ($arg_url = "") {
-                return 400 "Missing url parameter";
+                rewrite ^ /index.html last;
            }
            proxy_pass $arg_url;
@@ -31,8 +33,18 @@ http {
            proxy_ssl_server_name on;
            proxy_cache api_cache;
-            proxy_cache_valid 200 365d;
+            proxy_cache_valid 200 201 202 203 204 205 206 207 208 226 365d;
            proxy_cache_bypass $http_x_nocache;
            proxy_no_cache $http_x_nocache;
            proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
            add_header X-Cache-Status $upstream_cache_status always;
        }
        location = /index.html {
            root /usr/share/nginx/html;
        }
    }
 }
Author	SHA1	Message	Date
PhatPhuckDave	05c4e86f4b	Add cache logs	2026-01-07 21:52:09 +01:00
PhatPhuckDave	df77ee5498	Try and "stop" the 502s that esi throws us	2026-01-07 21:43:48 +01:00
PhatPhuckDave	5ecb74ad78	Update the html readme	2026-01-07 21:38:42 +01:00
PhatPhuckDave	2ed228b7fb	Hallucinate a short little readme on index.html (/)	2026-01-07 21:23:00 +01:00
PhatPhuckDave	5e4c9c533e	Add a purge endpoint and add more header controls	2026-01-07 21:12:30 +01:00