Files
computer-playbook/roles/sys-stk-front-proxy/README.md
kevinveenbirkenbachandClaude Opus 5 c55f508e05 feat(readme): draw mandatory and disabled service relations
The cosmos generator linked a consumer to its provider only through an
'<role>' in group_names reference or an explicit provides: name. A hard
dependency has neither -- pinning the provider on unconditionally is
exactly what removes the Jinja reference the generator was reading -- so
web-svc-asset's bond to web-svc-file vanished from the diagram the moment
it became binding. Match a service key against the provider's own primary
key from the registry, in both directions.

Services the role turns off drew a solid 1:1 edge, claiming a mandatory
relationship for something that carries nothing at deploy time. They now
render as a red 0..0 edge; edge merging gained a real precedence so a
provider consumed through two keys stays live when only one is off.

Named colour, not hex: a '#' opens an entity code in the mermaid lexer and
turns the whole diagram into a parse error on GitHub.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-17 18:02:31 +02:00

48 lines
2.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# NGINX Domain Setup
## Description
This role bootstraps **per-domain NGINX configuration**: it requests TLS certificates, applies global modifiers, deploys a ready-made vHost file, and can optionally lock down access via OAuth2.
## Overview
A higher-level orchestration wrapper, *sys-stk-front-proxy* ties together several lower-level roles:
1. **`sys-front-inj-all`** – applies global tweaks and includes.
2. **`sys-svc-certs`** – obtains Let’s Encrypt certificates.
3. **Domain template deployment** – copies a Jinja2 vHost from *sys-svc-proxy*.
4. **`web-app-keycloak`'s SSO-proxy sidecar** *(optional)* – protects the site with OAuth2.
The result is a complete, reproducible domain rollout in a single playbook task.
## Cosmos
The diagram places NGINX Domain Setup in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).
```mermaid
flowchart LR
subgraph role [sys-stk-front-proxy 💻]
svc_front_proxy["front-proxy"]
end
```
Solid `1:1` edges are fixed relationships; dashed `0..1` edges are conditional (enabled only in matching deployments); red `0..0` edges are turned off in this role. Node markers show the role's deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in `meta/main.yml`.
## Purpose
Provide **one-stop, idempotent domain provisioning** for NGINX-based homelabs or small production environments.
## Features
- **End-to-end TLS**: certificate retrieval and secure headers included.
- **Template-driven vHosts**: choose *basic* or *ws_generic* flavours (or your own).
- **Conditional OAuth2**: easily toggle authentication per application.
- **Handler-safe**: automatically triggers an NGINX reload when templates change.
- **Composable**: designed to be called repeatedly for many domains.
## Credits
Implemented by **[Kevin Veen-Birkenbach](https://www.veen.world)**.
Part of the [Infinito.Nexus Project](https://s.infinito.nexus/code) and maintained by [Kevin Veen-Birkenbach](https://www.veen.world).
Licensed under the [Infinito.Nexus Community License (Non-Commercial)](https://s.infinito.nexus/license).