Skip to content

Commit 4f0b310

Browse files
authored
doc: add fuelup http proxy setting document (#523)
* doc: add http proxy setting * doc: add warning for http_proxy value format * doc: add http proxy prompt in quickstart * refactor: add more proxy enviroment options doc * fix: ci lint
1 parent 12faf1c commit 4f0b310

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docs/src/basics.md

+15
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ fuelup self update
3434
```
3535
<!-- update_fuelup:example:end -->
3636

37+
## Using Http Proxy
38+
39+
To configure `fuelup` to use your proxy setting you can change `http_proxy`(***other optional enviroments see below***) environment value. The value format is in [libcurl format](https://everything.curl.dev/usingcurl/proxies/type.html) as in `[protocol://]host[:port]`.
40+
41+
### Supported proxy enviroment variables
42+
43+
- http_proxy
44+
- HTTP_PROXY
45+
- https_proxy
46+
- HTTPS_PROXY
47+
- all_proxy
48+
- ALL_PROXY
49+
50+
***Warning: don't leave all proxy environment with empty string or other invalid format***
51+
3752
## Help system
3853

3954
The `fuelup` command-line is built with [clap], which serves a nice, built-in help system

docs/src/installation/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ allowed in the installation step (explained below), which means you can run them
1414

1515
Installation is done through the `fuelup-init` script found on our [repository], where you may find the source code.
1616

17-
Run the following command:
17+
Run the following command (you may need to set a [http proxy](../basics.md#using-http-proxy) before running this command):
1818

1919
<!-- This section should have the default command to install fuelup -->
2020
<!-- install:example:start -->

0 commit comments

Comments
 (0)