docs: standardize readme format
This commit is contained in:
parent
a60b9b4f53
commit
80af041401
1 changed files with 27 additions and 9 deletions
36
readme.md
36
readme.md
|
|
@ -1,14 +1,32 @@
|
||||||
# Overview
|
# Ansible Role: Traefik
|
||||||
|
|
||||||
This role configures [Docker](<https://docker.io/>), for reasons.
|
Install and configure [Traefik](https://traefik.io/) - a modern HTTP reverse proxy and load balancer.
|
||||||
|
|
||||||
## Supported Operating Systems
|
## Variables
|
||||||
|
|
||||||
| Operating System | Version |
|
| Variable | Required | Default | Description |
|
||||||
| --- | ----- |
|
|----------|----------|---------|-------------|
|
||||||
| Debian | 13 |
|
| `traefik_letsencrypt_email` | Yes | `email@example.com` | Email for Let's Encrypt certificates |
|
||||||
| Debian | 13 |
|
| `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"
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue