Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add example on run QDT behind a proxy with PowerShell #394

Merged
merged 1 commit into from
Jan 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/guides/howto_behind_proxy.md
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. Not socks, no PAC.
Only HTTP and HTTPS proxies are supported. No socks, no PAC.
:::

## Passing as CLI option
Expand All @@ -13,6 +13,8 @@ Only HTTP and HTTPS proxies are supported. Not socks, no PAC.
qdt --proxy-http "http://user:password@proxyserver.intra:8765"
```

----

## Using environment variables

### Generic `HTTP_PROXY` and `HTTPS_PROXY`
Expand All @@ -23,3 +25,18 @@ qdt --proxy-http "http://user:password@proxyserver.intra:8765"

- it avoids potential conflict with "classic" proxy settings
- it allows to use a specific network proxy for QDT (can be useful for some well controlled systems)

#### Example on Windows PowerShell

Only for the QDT command scope:

```powershell
$env:QDT_PROXY_HTTP='http://user:password@proxyserver.intra:8765'; qdt -vvv
```

At the shell session scope:

```powershell
> $env:QDT_PROXY_HTTP='http://user:password@proxyserver.intra:8765'
> qdt -vvv
```