https://docs.gomods.io/configuration/index.html Recent content in Configuring Athens on Athens Hugo -- gohugo.io en Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/download/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/download/index.html Athens accepts an HCL formatted file that has instructions for how it should behave when a module@version isn’t found in its storage. This functionality gives Athens the flexibility configure Athens to fit your organization’s needs. The most popular uses of this download file are: Configure Athens to never download or serve a module or group of modules Redirect to a different module proxy for a module or group of modules This document will outline how to use this file - called the download mode file - to accomplish these tasks and more. https://docs.gomods.io/configuration/authentication/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/authentication/index.html Authentication SVN private repositories Subversion creates an authentication structure in ~/.subversion/auth/svn.simple/<hash> In order to properly create the authentication file for your SVN servers you will need to authenticate to them and let svn build out the proper hashed files. $ svn list http://<domain:port>/svn/<somerepo> Authentication realm: <http://<domain> Subversion Repository Username: test Password for 'test': Once we’ve properly authenticated we want to share the .subversion directory with the Athens proxy server in order to reuse those credentials. https://docs.gomods.io/configuration/storage/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/storage/index.html Storage The Athens proxy supports many storage types: Storage Memory - Configuration: Disk - Configuration: Mongo - Configuration: Google Cloud Storage - Configuration: AWS S3 - Configuration: Minio - Configuration: DigitalOcean Spaces Configuration: Alibaba OSS Configuration: Azure Blob Storage - Configuration: External Storage - Configuration: Running multiple Athens pointed at the same storage Using etcd as the single flight mechanism Using redis as the single flight mechanism Direct connection to redis Connecting to redis via redis sentinel All of them can be configured using config. https://docs.gomods.io/configuration/sumdb/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/sumdb/index.html If you run go get github.com/mycompany/secret-repo@v1.0.0 and that module version is not yet in your go.sum file, Go will by default send a request to https://sum.golang.org/lookup/github.com/mycompany/secret-repo@v1.0.0. That request will fail because the Go tool requires a checksum, but sum.golang.org doesn’t have access to your private code. The result is that (1) your build will fail, and (2) your private module names have been sent over the internet to an opaque public server that you don’t control. https://docs.gomods.io/configuration/prefill-disk-cache/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/prefill-disk-cache/index.html One of the popular features of Athens is that it can be run completely cut off from the internet. In this case, though, it can’t reach out to an upstream (e.g. a VCS or another module proxy) to fetch modules that it doesn’t have in storage. So, we need to manually fill up the disk partition that Athens uses with the dependencies that we need. This document will guide you through packaging up a single module called github. https://docs.gomods.io/configuration/filter/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/filter/index.html Note: the filter file that this page documents is deprecated. Please instead see “Filtering with the download mode file” for updated instructions on how to filter modules in Athens. The proxy supports the following three use cases Fetches a module directly from the source (upstream proxy) Exclude a particular module Include a module in the local proxy. These settings can be done by creating a configuration file which can be pointed by setting either FilterFile in config. https://docs.gomods.io/configuration/upstream/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/upstream/index.html Note: the filter file that this page documents is deprecated. Please instead see “Filtering with the download mode file” for updated instructions on how to set upstream repositories in Athens. By default, Athens fetches module code from an upstream version control system (VCS) like github.com, but this can be configured to use a Go modules repository like GoCenter or another Athens Server. Create a filter file (e.g /usr/local/lib/FilterForGoCenter) with letter D (stands for “direct access”) in first line. https://docs.gomods.io/configuration/home-template/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/home-template/index.html As of v0.14.0 Athens ships with a default, minimal HTML home page that advises users on how to connect to the proxy. It factors in whether GoNoSumPatterns is configured, and attempts to build configuration for GO_PROXY. It relies on the users request Host header (on HTTP 1.1) or the Authority header (on HTTP 2) as well as whether the request was over TLS to advise on configuring GO_PROXY. Lastly, the homepage provides a quick guide on how users can leverage the Athens API. https://docs.gomods.io/configuration/logging/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/configuration/logging/index.html Athens is designed to support a myriad of logging scenarios. Standard The standard structured logger can be configured in plain or json formatting via LogFormat or ATHENS_LOG_FORMAT. Additionally, verbosity can be controlled by setting LogLevel or ATHENS_LOG_LEVEL. In order for the standard structured logger to work, CloudRuntime and ATHENS_CLOUD_RUNTIME should not be set to a valid value. The logging is via Logrus, so the allowed values for logging config options are determined by that project.