Skip to content

Commit bc0d4bc

Browse files
committed
feat(doc): update for PAC file use and new priority
1 parent cb6b6ea commit bc0d4bc

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

docs/guides/howto_behind_proxy.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# How to use behind a network proxy
22

33
:::{info}
4-
Only HTTP and HTTPS proxies are supported. No socks, no PAC.
4+
Only HTTP and HTTPS proxies are supported. No socks. Automatic values definition from PAC file available.
55
:::
66

77
> See [Requests official documentation](https://docs.python-requests.org/en/latest/user/advanced/#proxies)
@@ -19,9 +19,13 @@ qdt --proxy-http "http://user:[email protected]:8765"
1919

2020
## Using environment variables
2121

22-
### Generic `HTTP_PROXY` and `HTTPS_PROXY`
22+
For proxy definition, QDT use this order of priority:
2323

24-
- it allows a specific URL by protocol (scheme)
24+
- `QDT_PROXY_HTTP`
25+
- `QDT_PAC_FILE`
26+
- PAC file from system
27+
- Proxy configuration from system
28+
- Generic `HTTP_PROXY` and `HTTPS_PROXY`
2529

2630
### Custom `QDT_PROXY_HTTP`
2731

@@ -32,10 +36,12 @@ qdt --proxy-http "http://user:[email protected]:8765"
3236

3337
[PAC file](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file) can be used by SysAdmin to define proxy with a set of rules depending on the url.
3438

35-
For QDT, PAC file can be used if no environment variable for proxy are already defined (`HTTP_PROXY`,`HTTPS_PROXY`, `QDT_PROXY_HTTP`).
36-
3739
[PyPac](https://pypac.readthedocs.io/en/latest/) is used for PAC file management. By default we are using the PAC file defined by system but a custom PAC file can be defined with `QDT_PAC_FILE` environment variable (local file or url).
3840

41+
### Generic `HTTP_PROXY` and `HTTPS_PROXY`
42+
43+
- it allows a specific URL by protocol (scheme)
44+
3945
#### Example on Windows PowerShell
4046

4147
Only for the QDT command scope:

docs/usage/settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Some others parameters can be set using environment variables.
2828
| `QDT_STREAMED_DOWNLOADS` | If set to `false`, the content of remote files is fully downloaded before being written locally. | `true` |
2929
| `QDT_SSL_USE_SYSTEM_STORES` | By default, a bundle of SSL certificates is used, through [certifi](https://pypi.org/project/certifi/). If this environment variable is set to `true`, QDT tries to uses the system certificates store. Based on [truststore](https://truststore.readthedocs.io/). See also [How to use custom SSL certificates](../guides/howto_use_custom_ssl_certs.md). | `False` |
3030
| `QDT_SSL_VERIFY` | Enables/disables SSL certificate verification. Useful for environments where the proxy is unreliable with HTTPS connections. Boolean: `true` or `false`. | `True` |
31+
| `QDT_PAC_FILE` | Define PAC file for proxy definition. See also [How to use behind a proxy](../guides/howto_behind_proxy.md). | `` |
3132

3233
----
3334

0 commit comments

Comments
 (0)