diff --git a/README.md b/README.md index fc92940..2abd66b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ -| 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 | +# Vps target server system variables + +> [!NOTE] +> +> **Path**: vps + +| 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 | +| **vps.ssh_key**
[`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | Vps ssh private key.
- The ssh key path must be accessible (the file must be present)
- It is possible not to declare (if the ssh key is your default key).
**Validators**:
• this filename could be a relative path
• this file must exist
• file type allowed: "file"
**Example**: ./sshkeys/myssh_privatekey | # Pedagogic html static file server @@ -20,11 +27,15 @@ > - Activation of the Nginx site: The site is enabled by creating a symbolic link in the sites-enabled directory.\ > - Testing the Nginx configuration: The Nginx configuration is tested before restarting the service.\ > - Restarting Nginx: Nginx is restarted to apply the changes.\ +> \ +> Dependencies:.\ +> \ +> - ubuntu 24.04 linux distribution.\ > **Path**: nginx | 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.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 |