From 80af041401a24d7a9b789d0dd7c79cb132cee4ab Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Fri, 10 Apr 2026 09:00:18 +0200 Subject: [PATCH] docs: standardize readme format --- readme.md | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index b24a20e..26c6d41 100644 --- a/readme.md +++ b/readme.md @@ -1,14 +1,32 @@ -# Overview +# Ansible Role: Traefik -This role configures [Docker](), for reasons. +Install and configure [Traefik](https://traefik.io/) - a modern HTTP reverse proxy and load balancer. -## Supported Operating Systems +## Variables -| Operating System | Version | -| --- | ----- | -| Debian | 13 | -| Debian | 13 | +| Variable | Required | Default | Description | +|----------|----------|---------|-------------| +| `traefik_letsencrypt_email` | Yes | `email@example.com` | Email for Let's Encrypt certificates | +| `traefik_routes` | Yes | `[]` | List of Traefik routes to configure | +| `traefik_routes[].name` | Yes | - | Route domain name | +| `traefik_routes[].service` | Yes | - | Service name | +| `traefik_routes[].host` | Yes | - | Backend host | +| `traefik_routes[].proto` | Yes | - | Backend protocol (http/https) | +| `traefik_routes[].port` | Yes | - | Backend port | -## Tags +## Example -This role has no tags. +```yaml +traefik_letsencrypt_email: "admin@example.com" +traefik_routes: + - name: "app.example.com" + service: "webapp" + host: "192.168.1.10" + proto: "http" + port: "8080" + - name: "api.example.com" + service: "api" + host: "192.168.1.11" + proto: "https" + port: "443" +```