From: cdeler <serj.krotov@gmail.com>
Date: Sun, 6 Sep 2020 11:52:37 +0000 (+0300)
Subject: Edited documentation about proxy-envs usage (#404) (#1257)
X-Git-Tag: 0.15.0~31
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=78f24203cec131cd71aca470dcf442dac912a8b4;p=thirdparty%2Fhttpx.git

Edited documentation about proxy-envs usage (#404) (#1257)

* Edited documentation about proxy-envs usage (#404)

* PR review (#404)

Co-authored-by: Florimond Manca <florimond.manca@gmail.com>

* PR review (#404)

Co-authored-by: Florimond Manca <florimond.manca@gmail.com>

* Fix typo

Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
---

diff --git a/docs/environment_variables.md b/docs/environment_variables.md
index 9ffa6848..252ab66c 100644
--- a/docs/environment_variables.md
+++ b/docs/environment_variables.md
@@ -134,17 +134,46 @@ Example:
 SSL_CERT_DIR=/path/to/ca-certs/ python -c "import httpx; httpx.get('https://example.com')"
 ```
 
-## `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`
+## Proxies
+
+The environment variables documented below are used as a convention by various HTTP tooling, including:
+
+* [cURL](https://github.com/curl/curl/blob/master/docs/MANUAL.md#environment-variables)
+* [requests](https://github.com/psf/requests/blob/master/docs/user/advanced.rst#proxies)
+
+For more information on using proxies in HTTPX, see [HTTP Proxying](/advanced/#http-proxying).
+
+### `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`
 
 Valid values: A URL to a proxy
 
-Sets the proxy to be used for `http`, `https`, or all requests respectively.
+`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY` set the proxy to be used for `http`, `https`, or all requests respectively.
 
 ```bash
-export HTTP_PROXY=http://127.0.0.1:3080
+export HTTP_PROXY=http://my-external-proxy.com:1234
 
 # This request will be sent through the proxy
 python -c "import httpx; httpx.get('http://example.com')"
+
+# This request will be sent directly, as we set `trust_env=False`
+python -c "import httpx; httpx.get('http://example.com', trust_env=False)"
+
 ```
 
-For more information on using proxies in HTTPX, see [HTTP Proxying](/advanced/#http-proxying).
+### `NO_PROXY`
+
+Valid values: a comma-separated list of hostnames/urls
+
+`NO_PROXY` disables the proxy for specific urls
+
+```bash
+export HTTP_PROXY=http://my-external-proxy.com:1234
+export NO_PROXY=http://127.0.0.1,python-httpx.org
+
+# As in the previous example, this request will be sent through the proxy
+python -c "import httpx; httpx.get('http://example.com')"
+
+# These requests will be sent directly, bypassing the proxy
+python -c "import httpx; httpx.get('http://127.0.0.1:5000/my-api')"
+python -c "import httpx; httpx.get('https://www.python-httpx.org')"
+```