-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(doc): update for PAC file use and new priority
- Loading branch information
Showing
2 changed files
with
12 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# How to use behind a network proxy | ||
|
||
:::{info} | ||
Only HTTP and HTTPS proxies are supported. No socks, no PAC. | ||
Only HTTP and HTTPS proxies are supported. No socks. Automatic values definition from PAC file available. | ||
::: | ||
|
||
> 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" | |
|
||
## Using environment variables | ||
|
||
### Generic `HTTP_PROXY` and `HTTPS_PROXY` | ||
For proxy definition, QDT use this order of priority: | ||
|
||
- it allows a specific URL by protocol (scheme) | ||
- `QDT_PROXY_HTTP` | ||
- `QDT_PAC_FILE` | ||
- PAC file from system | ||
- Proxy configuration from system | ||
- Generic `HTTP_PROXY` and `HTTPS_PROXY` | ||
|
||
### Custom `QDT_PROXY_HTTP` | ||
|
||
|
@@ -32,10 +36,12 @@ qdt --proxy-http "http://user:[email protected]:8765" | |
|
||
[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. | ||
|
||
For QDT, PAC file can be used if no environment variable for proxy are already defined (`HTTP_PROXY`,`HTTPS_PROXY`, `QDT_PROXY_HTTP`). | ||
|
||
[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). | ||
|
||
### Generic `HTTP_PROXY` and `HTTPS_PROXY` | ||
|
||
- it allows a specific URL by protocol (scheme) | ||
|
||
#### Example on Windows PowerShell | ||
|
||
Only for the QDT command scope: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters