0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-06 10:59:59 +00:00

Files

T

History

kevinveenbirkenbachandClaude Opus 5.5 eda3bdbc35 refactor(sys-svc-proxy): set the upstream request headers in one snippet

Host, X-Real-IP, X-Forwarded-For, X-Forwarded-Proto, X-Forwarded-Port and
X-Forwarded-Ssl were written out separately in the html, ws and upload
locations and in the Prometheus health probes, and the copies had drifted:
ws and upload never sent Port and Ssl, and the probes sent only Host, which
is how the Shopware readiness probe came to see plain http.

headers/forwarded.conf.j2 now holds the set and every one of those locations
includes it. The html location renders the same headers as before. ws and
upload additionally send Port and Ssl with the values the html location
already gives the same backend. The ready and live probes gain X-Real-IP and
X-Forwarded-For, and the live probe the three X-Forwarded headers as well.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

2026-10-09 17:15:22 +02:00

html.conf.j2

refactor(sys-svc-proxy): set the upstream request headers in one snippet

2026-10-09 17:15:22 +02:00

media.conf.j2

…

README.md

test(tooling): integrate markdownlint-cli2, ansible-lint, galaxy-importer + fix the resulting baseline

2026-05-08 23:46:37 +02:00

TODO.md

test(tooling): integrate markdownlint-cli2, ansible-lint, galaxy-importer + fix the resulting baseline

2026-05-08 23:46:37 +02:00

upload.conf.j2

refactor(sys-svc-proxy): set the upstream request headers in one snippet

2026-10-09 17:15:22 +02:00

ws.conf.j2

refactor(sys-svc-proxy): set the upstream request headers in one snippet

2026-10-09 17:15:22 +02:00

README.md

NGINX Location Templates

This directory contains Jinja2 templates for different NGINX location blocks, each designed to proxy and optimize different types of web traffic. These templates are used by the sys-svc-proxy role to modularize and standardize reverse proxy configuration across a wide variety of applications.

Overview of Files

`html.conf.j2`

Purpose:
Handles "normal" web traffic such as HTML pages, API endpoints, and general HTTP(S) requests.
Features:
- Proxies requests to the backend service.
- Optionally integrates with OAuth2 proxy for authentication.
- Sets all necessary proxy headers.
- Applies a Content Security Policy header.
- Activates buffering for advanced features such as Lua-based string replacements.
- Supports WebSocket upgrades for hybrid APIs.

`ws.conf.j2`

Purpose:
Handles WebSocket connections, enabling real-time features such as live updates or chats.
Features:
- Sets all headers required for WebSocket upgrades.
- Disables proxy buffering (required for WebSockets).
- Uses tcp_nodelay for low latency.
- Proxies traffic to the backend WebSocket server.

`media.conf.j2`

Purpose:
Proxies and caches static media files (images, icons, etc.).
Features:
- Matches image file extensions (jpg, png, gif, webp, ico, svg, etc.).
- Enables browser-side and proxy-side caching for efficient delivery.
- Adds cache control headers and exposes the upstream cache status.

Usage

These templates are intended for inclusion in larger NGINX configuration files via Jinja2.
They modularize your configuration by separating HTML, WebSocket, and media proxying, allowing for clear, reusable, and maintainable reverse proxy logic.

Use html.conf.j2 for standard application HTTP/S endpoints.
Use ws.conf.j2 for dedicated WebSocket endpoints.
Use media.conf.j2 for efficient handling of static media content.

Best Practices

Only enable WebSocket proxying (ws.conf.j2) for routes that actually require it, to avoid breaking buffering for standard HTTP.
Activate media proxying (media.conf.j2) if your application benefits from image caching at the proxy layer.
Keep templates modular for maintainability and scalability as your application grows.