From b348420a804d69047c98aea9743292c9156e4e3e Mon Sep 17 00:00:00 2001 From: zjpersc Date: Sun, 26 Feb 2023 20:44:08 -0600 Subject: [PATCH] Adding global-agent to dependencies; updated README w/ instructions Signed-off-by: zjpersc --- .changeset/short-panthers-float.md | 5 +++++ packages/techdocs-cli/README.md | 7 +++++++ packages/techdocs-cli/package.json | 1 + 3 files changed, 13 insertions(+) create mode 100644 .changeset/short-panthers-float.md diff --git a/.changeset/short-panthers-float.md b/.changeset/short-panthers-float.md new file mode 100644 index 0000000000..41ec71a7aa --- /dev/null +++ b/.changeset/short-panthers-float.md @@ -0,0 +1,5 @@ +--- +'@techdocs/cli': patch +--- + +Adding global-agent to enable the ability to publish through a proxy \ No newline at end of file diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md index ae296d2c26..e6ba03e1d0 100644 --- a/packages/techdocs-cli/README.md +++ b/packages/techdocs-cli/README.md @@ -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. diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json index 0a3bbed06f..371ddf440f 100644 --- a/packages/techdocs-cli/package.json +++ b/packages/techdocs-cli/package.json @@ -69,6 +69,7 @@ "commander": "^9.1.0", "dockerode": "^3.3.1", "fs-extra": "^10.0.1", + "global-agent": "^3.0.0", "http-proxy": "^1.18.1", "react-dev-utils": "^12.0.0-next.60", "serve-handler": "^6.1.3",