diff --git a/README.md b/README.md index cb5ddf6..fc92940 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| +| **vps_domain_name**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | The domain name of the VPS.
**Example**: example.fr | + # Pedagogic html static file server > [!NOTE] @@ -18,11 +22,11 @@ > - Restarting Nginx: Nginx is restarted to apply the changes.\ > **Path**: nginx -| Variable | Description | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| -| **nginx.domain_name**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Domain name.
**Validator**: type domainname
**Example**: exemple.fr | -| **nginx.email**
[`mail`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Email for the domain name.
This is for certbot.
**Example**: contact@exemple.fr | -| **nginx.htpasswd_file**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Htpassword file.
**Validator**: file type allowed: "file"
**Default**: /etc/nginx/.htpasswd | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **nginx.domain_name**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Domain name.
**Validator**: type domainname
**Default**: the value of the variable "[The domain name of the VPS](#vps_domain_name)"
**Example**: example.fr | +| **nginx.email**
[`mail`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Email for the domain name.
This is for certbot.
**Example**: contact@exemple.fr | +| **nginx.htpasswd_file**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Htpassword user credential file name.
**Validator**: file type allowed: "file"
**Default**: /etc/nginx/.htpasswd | ## Nginx authenticated user credentials diff --git a/structure.yml b/structure.yml index 80ecc3d..f7687b9 100644 --- a/structure.yml +++ b/structure.yml @@ -10,7 +10,7 @@ vps_domain_name: nginx: description: pedagogic html static file server help: |- - This is a complete Ansible playbook to configure Nginx with basic authentication using htpasswd. + This is a complete Ansible playbook to configure Nginx with basic authentication using htpasswd. This playbook installs Nginx, configures a static website, and secures access with basic authentication. steps: @@ -27,6 +27,8 @@ nginx: domain_name: description: domain name + default: + variable: __.vps_domain_name examples: - example.fr type: domainname