diff --git a/docs/content/design/proxy.md b/docs/content/design/proxy.md index 42d24600..79fe7141 100644 --- a/docs/content/design/proxy.md +++ b/docs/content/design/proxy.md @@ -70,30 +70,3 @@ Private module filters are string globs that tell the proxy what is a private mo ### Exclude Lists for Public Modules Exclude lists for public modules are also globs that tell the proxy what modules it should never download from the registry. For example, the string `github.com/arschles/**` tells the proxy to always return `404 Not Found` to clients. - -## Authenticate private repositories via .netrc - -1. Create a .netrc file that looks like the following: - - `machine ` - - `login ` - - `password ` - -2. Tell Athens through an environment variable the location of that file - - `ATHENS_NETRC_PATH=` - -3. Athens will copy the file into the home directory and override whatever .netrc file is in home directory. Alternatively, if the host of the Athens server already has a .netrc file in the home directory, then authentication should work out of the box. - -## Authenticate Mercurial private repositories via .hgrc - -1. Create a .hgrc file with authentication data - -2. Tell Athens through an environment variable the location of that file - - `ATHENS_HGRC_PATH=` - -3. Athens will copy the file into the home directory and override whatever .hgrc file is in home directory. Alternatively, if the host of the Athens server already has a .hgrc file in the home directory, then authentication should work out of the box. - diff --git a/docs/content/install/install-on-kubernetes.md b/docs/content/install/install-on-kubernetes.md index c75faa39..df1014b8 100644 --- a/docs/content/install/install-on-kubernetes.md +++ b/docs/content/install/install-on-kubernetes.md @@ -1,6 +1,7 @@ --- title: Install Athens on Kubernetes description: Installing an Athens Instance on Kubernetes +weight: 1 --- When you follow the instructions in the [Walkthrough](/walkthrough), you end up with an Athens Proxy that uses in-memory storage. This is only suitable for trying out the proxy for a short period of time, as you will quickly run out of memory and Athens won't persist modules between restarts. In order to run a more production-like proxy, you may with to run Athens on a [Kubernetes](https://kubernetes.io/) cluster. To aid in deployment of the Athens proxy on Kubernetes, a [Helm](https://www.helm.sh/) chart has been provided. This guide will walk you through installing Athens on a Kubernetes cluster using Helm. diff --git a/docs/content/install/managing-private-repos.md b/docs/content/install/managing-private-repos.md new file mode 100644 index 00000000..f87eef4d --- /dev/null +++ b/docs/content/install/managing-private-repos.md @@ -0,0 +1,32 @@ +--- +title: Managing private repos with .netrc files +description: Authenticate athens against private repos +weight: 10 +--- + +## Authenticate private repositories via .netrc + +1. Create a .netrc file that looks like the following: + + `machine ` + + `login ` + + `password ` + +2. Tell Athens through an environment variable the location of that file + + `ATHENS_NETRC_PATH=` + +3. Athens will copy the file into the home directory and override whatever .netrc file is in home directory. Alternatively, if the host of the Athens server already has a .netrc file in the home directory, then authentication should work out of the box. + +## Authenticate Mercurial private repositories via .hgrc + +1. Create a .hgrc file with authentication data + +2. Tell Athens through an environment variable the location of that file + + `ATHENS_HGRC_PATH=` + +3. Athens will copy the file into the home directory and override whatever .hgrc file is in home directory. Alternatively, if the host of the Athens server already has a .hgrc file in the home directory, then authentication should work out of the box. + diff --git a/docs/content/install/shared-team-instance.md b/docs/content/install/shared-team-instance.md index d22b3c47..1fffe00a 100644 --- a/docs/content/install/shared-team-instance.md +++ b/docs/content/install/shared-team-instance.md @@ -1,6 +1,7 @@ --- title: Shared Team Instance description: Installing an Athens Instance For Your Development Team +weight: 2 --- When you follow the instructions in the [Walkthrough](/walkthrough), you end up with an Athens Proxy that uses in-memory storage. This is only suitable for trying out the proxy for a short period of time, as you will quickly run out of memory and Athens won't persist modules between restarts. This guide will help you get Athens running in a more suitable manner for scenarios like providing an instance for your development team to share.