Add global-agent to dependencies; Update Readme w/ instructions

Signed-off-by: zjpersc <zjpersc@gmail.com>
2023-02-25 00:10:13 -06:00
parent 107ae5220e
commit e339789173
2 changed files with 8 additions and 0 deletions
@@ -40,6 +40,13 @@ yarn start
 yarn techdocs-cli:dev [...options]
 ```

+### Connecting behind a proxy
+```sh 
+# Prior to executing the techdocs-cli command
+export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY}
+export GLOBAL_AGENT_NO_PROXY=${NO_PROXY}
+```
+
 ### Using an example docs project

 For the purpose of local development, we have created an example documentation project. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory.