Add troubleshooting guide, with initial proxies entries (#1435)

* Add troubleshooting guide, with initial proxies entries

* Drop unrelated issue

diff --git a/docs/advanced.md b/docs/advanced.md
index 59c04ca1e2609abe84fbf8b09781e246b5b38411..837acd4941722defb30d045cf887aaba6ad4f4fc 100644 (file)
--- a/docs/advanced.md
+++ b/docs/advanced.md
@@ -583,6 +583,10 @@ with httpx.Client(proxies=proxies) as client:
     r = client.get("http://example.com")
 ```
 
+### Troubleshooting proxies
+
+If you encounter issues when setting up proxies, please refer to our [Troubleshooting guide](troubleshooting.md#proxies).
+
 ## Timeout Configuration
 
 HTTPX is careful to enforce timeouts everywhere by default.

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
new file mode 100644 (file)
index 0000000..6461574
--- /dev/null
+++ b/docs/troubleshooting.md
@@ -0,0 +1,61 @@
+# Troubleshooting
+
+This page lists some common problems or issues you could encounter while developing with HTTPX, as well as possible solutions.
+
+## Proxies
+
+---
+
+### "`The handshake operation timed out`" on HTTPS requests when using a proxy
+
+**Description**: When using a proxy and making an HTTPS request, you see an exception looking like this:
+
+```console
+httpx.ProxyError: _ssl.c:1091: The handshake operation timed out
+```
+
+**Similar issues**: [encode/httpx#1412](https://github.com/encode/httpx/issues/1412), [encode/httpx#1433](https://github.com/encode/httpx/issues/1433)
+
+**Resolution**: it is likely that you've set up your proxies like this...
+
+```python
+proxies = {
+  "http": "http://myproxy.org",
+  "https": "https://myproxy.org",
+}
+```
+
+Using this setup, you're telling HTTPX to connect to the proxy using HTTP for HTTP requests, and using HTTPS for HTTPS requests.
+
+But if you get the error above, it is likely that your proxy doesn't support connecting via HTTPS. Don't worry: that's a [common gotcha](advanced.md#example).
+
+Change the scheme of your HTTPS proxy to `http://...` instead of `https://...`:
+
+```python
+proxies = {
+  "http": "http://myproxy.org",
+  "https": "http://myproxy.org",
+}
+```
+
+This can be simplified to:
+
+```python
+proxies = "http://myproxy.org"
+```
+
+For more information, see [Proxies: FORWARD vs TUNNEL](advanced.md#forward-vs-tunnel).
+
+---
+
+### Error when making requests to an HTTPS proxy
+
+**Description**: your proxy _does_ support connecting via HTTPS, but you are seeing errors along the lines of...
+
+```console
+httpx.ProxyError: [SSL: PRE_MAC_LENGTH_TOO_LONG] invalid alert (_ssl.c:1091)
+```
+
+**Similar issues**: [encode/httpx#1424](https://github.com/encode/httpx/issues/1424).
+
+**Resolution**: HTTPX does not properly support HTTPS proxies at this time. If that's something you're interested in having, please see [encode/httpx#1434](https://github.com/encode/httpx/issues/1434) and consider lending a hand there.

diff --git a/mkdocs.yml b/mkdocs.yml
index a6fbb8e6aa7686db946f40522df1310d007b9c39..2f1f94b8198d1b0de9be9f17cb51b2b58b22a9a4 100644 (file)
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -19,6 +19,7 @@ nav:
     - Requests Compatibility: 'compatibility.md'
     - Developer Interface: 'api.md'
     - Exceptions: 'exceptions.md'
+    - Troubleshooting: 'troubleshooting.md'
     - Third Party Packages: 'third-party-packages.md'
     - Contributing: 'contributing.md'