From 0bfb2ed604c011372c6c8fb4c21d3f94bf0f76a8 Mon Sep 17 00:00:00 2001 From: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Date: Tue, 28 May 2019 08:58:39 -0700 Subject: [PATCH] Updating english docs to indicate the presence of hosted public proxies (#1238) * Updating english docs to indicate the presence of hosted public proxies * fixing spacing * more spacing * bump chart version again since I pulled from master, the linter told me to do this again --- charts/athens-proxy/Chart.yaml | 2 +- charts/athens-proxy/values.yaml | 6 +++++- docs/content/_index.md | 2 ++ docs/content/configuration/_index.md | 3 +-- docs/content/configuration/upstream.md | 1 + docs/content/install/install-on-kubernetes.md | 6 +++++- 6 files changed, 15 insertions(+), 5 deletions(-) diff --git a/charts/athens-proxy/Chart.yaml b/charts/athens-proxy/Chart.yaml index 2c2f1cef..5fe81680 100644 --- a/charts/athens-proxy/Chart.yaml +++ b/charts/athens-proxy/Chart.yaml @@ -1,5 +1,5 @@ name: athens-proxy -version: 0.2.6 +version: 0.2.7 appVersion: 0.4.0 description: The proxy server for Go modules icon: https://raw.githubusercontent.com/gomods/athens/master/docs/static/banner.png diff --git a/charts/athens-proxy/values.yaml b/charts/athens-proxy/values.yaml index 19f7ca5b..7ce6825d 100644 --- a/charts/athens-proxy/values.yaml +++ b/charts/athens-proxy/values.yaml @@ -53,7 +53,11 @@ netrc: upstreamProxy: # This is where you can set the URL for the upstream module repository. # If 'enabled' is set to true, Athens will try to download modules from the upstream when it doesn't find them in its own storage. - # You can use 'https://gocenter.io' to use JFrog's GoCenter as an upstream here, or you can also use another Athens server as well. + # Here's a non-exhaustive list of options you can set here: + # + # - https://gocenter.io + # - https://proxy.golang.org + # - another Athens server enabled: false url: "https://gocenter.io" diff --git a/docs/content/_index.md b/docs/content/_index.md index d54de9d8..c596133c 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -30,6 +30,8 @@ Athens is easy to run yourself. We give you a few options: We also run an experimental version of Athens so you can get started without even installing anything. To get started, set `GOPROXY="https://athens.azurefd.net"`. +>This is not a production-ready proxy deployment, though. Please deploy your own Athens instance for your builds. _If you need a hosted proxy for public code, consider using either `https://gocenter.io` or `https://proxy.golang.org`_. + **[Like what you hear? Try Athens Now!](/try-out)** diff --git a/docs/content/configuration/_index.md b/docs/content/configuration/_index.md index a78c1a37..73151e54 100644 --- a/docs/content/configuration/_index.md +++ b/docs/content/configuration/_index.md @@ -17,9 +17,8 @@ In Athens we support many storage options. In this section we'll describe how th - [Storage](/configuration/storage) - ### Upstream proxy -In this section we'll describe how the upstream proxy can be configured to fetch all modules from a Go Modules Repository such as [GoCenter](https://gocenter.io) or another Athens Server. +In this section we'll describe how the upstream proxy can be configured to fetch all modules from a Go Modules Repository such as [GoCenter](https://gocenter.io), [The Go Module Mirror](https://proxy.golang.org), or another Athens Server. - [Upstream](/configuration/upstream) diff --git a/docs/content/configuration/upstream.md b/docs/content/configuration/upstream.md index 70813e61..c2627001 100644 --- a/docs/content/configuration/upstream.md +++ b/docs/content/configuration/upstream.md @@ -19,6 +19,7 @@ Additionally in the current or new config file, set the following parameters as FilterFile = "/usr/local/lib/FilterForGoCenter" GlobalEndpoint = "https://" # To use GoCenter for example, replace with gocenter.io + # You can also use https://proxy.golang.org to use the Go Module mirror ``` 1. Restart Athens specifying the updated current or new config file. diff --git a/docs/content/install/install-on-kubernetes.md b/docs/content/install/install-on-kubernetes.md index b61f5e34..8a05e927 100644 --- a/docs/content/install/install-on-kubernetes.md +++ b/docs/content/install/install-on-kubernetes.md @@ -187,7 +187,11 @@ helm install gomods/athens-proxy -n athens --namespace athens -f override-values You can set the `URL` for the [upstream module repository](https://docs.gomods.io/configuration/upstream/) then Athens will try to download modules from the upstream when it doesn't find them in its own storage. -You can use `https://gocenter.io` to use JFrog's GoCenter as an upstream here, or you can also use another Athens server as well. +You have a few good options for what you can set as an upstream: + +- `https://gocenter.io` to use JFrog's GoCenter +- `https://proxy.golang.org` to use the Go Module Mirror +- The URL to any other Athens server The example below shows you how to set GoCenter up as upstream module repository: