From 8f49d19e9f4ba9dc78f6a8e6e49ba15e9772f872 Mon Sep 17 00:00:00 2001 From: Stephen Glass Date: Sun, 30 Jun 2024 14:36:05 -0400 Subject: [PATCH 1/3] Add proxy section to keeping backstage updated docs Signed-off-by: Stephen Glass --- docs/getting-started/keeping-backstage-updated.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/getting-started/keeping-backstage-updated.md b/docs/getting-started/keeping-backstage-updated.md index 1de8874d56..1c01a289a9 100644 --- a/docs/getting-started/keeping-backstage-updated.md +++ b/docs/getting-started/keeping-backstage-updated.md @@ -78,3 +78,15 @@ duplicate definitions: # Add --fix to attempt automatic resolution in yarn.lock yarn backstage-cli versions:check ``` + +## Proxy + +The Backstage CLI uses [global-agent](https://www.npmjs.com/package/global-agent) to configure HTTP/HTTPS proxy settings using environment variables. This allows you to route the CLI’s network traffic through a proxy server, which can be useful in environments with restricted internet access. + +### Example Configuration + +```bash +export GLOBAL_AGENT_HTTP_PROXY=http://proxy.company.com:8080 +export GLOBAL_AGENT_HTTPS_PROXY=https://secure-proxy.company.com:8080 +export GLOBAL_AGENT_NO_PROXY=localhost,internal.company.com +``` From 57da7544a91a6685083ec9130b71a8199efa9b6d Mon Sep 17 00:00:00 2001 From: Stephen Glass Date: Sat, 24 Aug 2024 13:59:36 -0400 Subject: [PATCH 2/3] add reference from versions:bump doc to keeping backstage updated Signed-off-by: Stephen Glass --- docs/tooling/cli/03-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tooling/cli/03-commands.md b/docs/tooling/cli/03-commands.md index a6652bd036..913a71f514 100644 --- a/docs/tooling/cli/03-commands.md +++ b/docs/tooling/cli/03-commands.md @@ -326,7 +326,7 @@ Options: ## versions\:bump Bump all `@backstage` packages to the latest versions. This checks for updates -in the package registry, and will update entries `package.json` files when necessary. +in the package registry, and will update entries `package.json` files when necessary. See more how this command can be configured and used [for keeping Backstage updated](../../getting-started/keeping-backstage-updated.md). ```text Usage: backstage-cli versions:bump [options] From d29c828524dd694805d0dcc92c26e613f2e33f9a Mon Sep 17 00:00:00 2001 From: Stephen Glass Date: Sat, 24 Aug 2024 14:13:37 -0400 Subject: [PATCH 3/3] add note for backstage cli in proxy config docs Signed-off-by: Stephen Glass --- contrib/docs/tutorials/help-im-behind-a-corporate-proxy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/contrib/docs/tutorials/help-im-behind-a-corporate-proxy.md b/contrib/docs/tutorials/help-im-behind-a-corporate-proxy.md index deef356d84..3aab9261c9 100644 --- a/contrib/docs/tutorials/help-im-behind-a-corporate-proxy.md +++ b/contrib/docs/tutorials/help-im-behind-a-corporate-proxy.md @@ -111,3 +111,7 @@ The `proxy-agent` package can be used as an alternative to `global-agent` (do no ``` 4. Start the backend with `yarn start` + +## Backstage CLI + +The Backstage CLI [versions:bump](https://backstage.io/docs/tooling/cli/commands#versionsbump) command also supports proxies via `global-agent` environment variable configuration. See the [keeping Backstage updated](https://backstage.io/docs/getting-started/keeping-backstage-updated/#proxy) docs for more information.