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

add PowerShell to proxies docs. #2592

Merged
merged 1 commit into from
Dec 2, 2020
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
31 changes: 19 additions & 12 deletions doc/src/network-proxies.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,23 @@
Enterprise networks often don't have direct outside HTTP access, but enforce
the use of proxies. If you're on such a network, you can request that `rustup`
uses a proxy by setting its URL in the environment. In most cases, setting
`https_proxy` should be sufficient. On a Unix-like system with a shell like
__bash__ or __zsh__, you could use:

```bash
export https_proxy=socks5://proxy.example.com:1080 # or http://proxy.example.com:8080
```

On Windows, the command would be:

```cmd
set https_proxy=socks5://proxy.example.com:1080
```
`https_proxy` should be sufficient. Commands may differ between different
systems and shells:

- On a Unix-like system with a shell like __bash__ or __zsh__:
```bash
export https_proxy=socks5://proxy.example.com:1080
```
- On Windows [__Command Prompt (cmd)__][cmd]:
```cmd
set https_proxy=socks5://proxy.example.com:1080
```
- On Windows [__PowerShell__][ps] (or __PowerShell Core__):
```cmd
$env:https_proxy="socks5://proxy.example.com:1080"
```
- Replace `socks5://proxy.example.com:1080` with
`http://proxy.example.com:8080` when an HTTP proxy is used instead.

If you need a more complex setup, `rustup` supports the convention used by the
__curl__ program, documented in the ENVIRONMENT section of [its manual
Expand All @@ -34,3 +39,5 @@ getting an SSL `unknown protocol` error from `rustup` via `libcurl` but the
command-line `curl` command works fine, this may be the problem.

[curlman]: https://curl.haxx.se/docs/manpage.html
[cmd]: https://en.wikipedia.org/wiki/Cmd.exe
[ps]: https://en.wikipedia.org/wiki/PowerShell