Skip to content

Commit

Permalink
change to APOLLO_ROUTER_BINARY_REMOTE
Browse files Browse the repository at this point in the history
  • Loading branch information
LongLiveCHIEF committed Nov 7, 2024
1 parent b3519a1 commit a488d81
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/source/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Hello! This tutorial walks you through installing the router (GraphOS Router or

If you have a bash-compatible terminal, you can download the latest version of the Apollo Router Core directly to your current directory with the following command:

\*Note: If you are behind a network proxy, set `APOLLO_ROUTER_DOWNLOAD_HOST` first. see: ([configuring a proxy for the binary download](#configuring-a-proxy-for-the-binary-download))\*
\*Note: If you are behind a network proxy, set `APOLLO_ROUTER_BINARY_REMOTE` first. see: ([configuring a proxy for the binary download](#configuring-a-proxy-for-the-binary-download))\*

```bash
curl -sSL https://router.apollo.dev/download/nix/latest | sh
Expand Down Expand Up @@ -270,15 +270,15 @@ Visit `http://127.0.0.1:4000` to open Apollo Sandbox, inspect your entire superg
## Configuring a Proxy for the Binary Download

The installer from step 1 downloads from github, and can be configured to support a proxy artifact repository by
setting the `APOLLO_ROUTER_DOWNLOAD_HOST` environment variable to point to your artifact proxy repository
setting the `APOLLO_ROUTER_BINARY_REMOTE` environment variable to point to your artifact proxy repository
for this github repositories releases/download path on your proxy.

For example, if your artifact proxy mirror has a hostname of `my-artifact-mirror`, and the proxy for github
is available at `my-artifact-mirror.com/artifacts/github-com`, you would want to set the value of
`APOLLO_ROUTER_DOWNLOAD_HOST` like so:
`APOLLO_ROUTER_BINARY_REMOTE` like so:

```bash
export APOLLO_ROUTER_DOWNLOAD_HOST="https://my-artifact-mirror.com/artifacts/github-com/apollograpqhl/router/releases/download"
export APOLLO_ROUTER_BINARY_REMOTE="https://my-artifact-mirror.com/artifacts/github-com/apollograpqhl/router/releases/download"
# proceed to run installation script
curl -sSL https://router.apollo.dev/download/nix/latest | sh
```
Expand All @@ -287,7 +287,7 @@ If your remote proxy requires authentication, you can configure that as part of
Be aware that this will cause the password to appear in plaintext in the command output:

```bash
export APOLLO_ROUTER_DOWNLOAD_HOST=https://<user>:<password>@myartifact-mirror...."
export APOLLO_ROUTER_BINARY_REMOTE=https://<user>:<password>@myartifact-mirror...."
```
## Next steps
Expand Down
2 changes: 1 addition & 1 deletion scripts/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#

set -u
BINARY_DOWNLOAD_PREFIX="${APOLLO_ROUTER_BINARY_HOST:="https://github.com/apollographql/router/releases/download"}"
BINARY_DOWNLOAD_PREFIX="${APOLLO_ROUTER_BINARY_REMOTE:="https://github.com/apollographql/router/releases/download"}"

# Router version defined in apollo-router's Cargo.toml
# Note: Change this line manually during the release steps.
Expand Down

0 comments on commit a488d81

Please sign in to comment.