diff --git a/doc.md b/doc.md index 1152a79..191789a 100644 --- a/doc.md +++ b/doc.md @@ -4,22 +4,29 @@ include_toc: true --- # Variables -## env_proxy +## HTTP(s) proxy server overview and configuration (env_proxy) + +A proxy server acts as an intermediary gateway between a client and another +HTTP(s) server, such as the Internet. + +It makes service requests on behalf of a local client and allows the client +to make network connections to network services outside its own network. + | Parameter | Comment | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **host**
`mandatory`
**Type:** [`string`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **host**
`mandatory`
**Type:** [`domainname`](https://forge.cloud.silique.fr/stove/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The proxy server’s address.
Specifies the hostname of proxy server to enable proxy server access to all of your HTTP(s) requests. .
**Example:** proxy.silique.fr | # Example with mandatories variables ``` env_proxy: - host: xxx + host: proxy.silique.fr ``` # Example with all variables ``` env_proxy: - host: xxx + host: proxy.silique.fr ```