https://docs.gomods.io/index.html Recent content in Intro on Athens Hugo -- gohugo.io en Tue, 16 Oct 2018 12:14:01 -0700 https://docs.gomods.io/intro/index.html Thu, 20 Sep 2018 15:38:11 -0700 https://docs.gomods.io/intro/index.html Welcome to Athens, Gophers! We gave a very brief overview of Athens on the home page, so if you want to know more, you’ve come to the right place! This section gives you all the details you need to understand what Athens does, why it exists, and how it fits into your workflow. Where to Go From Here We recommend you read this section from front to back: Athens 101 - the basic mechanics of Athens Download Protocol - the fundamental way that Athens serves Go packages Components - the different moving pieces of Athens https://docs.gomods.io/install/index.html Thu, 20 Sep 2018 15:38:01 -0700 https://docs.gomods.io/install/index.html The Go ecosystem has always been federated and completely open. Anyone with a GitHub or GitLab (or any other supported VCS) account can effortlessly provide a library with just a git push (or similar). No extra accounts to create or credentials to set up. A Federated Ecosystem We feel that Athens should keep the community federated and open, and nobody should have to change their workflow when they’re building apps and libraries. https://docs.gomods.io/configuration/index.html Tue, 16 Oct 2018 12:14:01 -0700 https://docs.gomods.io/configuration/index.html Configuring Athens Here we’ll cover how to configure the Athens application utilizing various configuration scenarios. This section covers some of the more commonly used configuration variables, but there are more! If you want to see all the configuration variables you can set, we’ve documented them all in this configuration file. Authentication There are numerous version control systems available to us as developers. In this section we’ll outline how they can be used by supplying required credentials in various formats for the Athens project. https://docs.gomods.io/design/index.html Thu, 20 Sep 2018 15:37:49 -0700 https://docs.gomods.io/design/index.html This section of the documentation details the design of Athens. You can read the code and ask plenty of questions (which we’re always happy to answer!), but we want to take some time here to give you a head start by describing how Athens is designed in words and diagrams, rather than code. What You’ll Find Here We’ve split this section into two major sections: Proxy internals - basics of the Athens proxy architecture and major features Communication flow - how the Athens proxy interacts with the outside world to fetch and store code, respond to user requests, and so on How to Read this Section We’ve designed the documentation in this section as a reference, which contrasts some of the other sections. https://docs.gomods.io/contributing/index.html Sat, 01 Sep 2018 19:30:42 -0700 https://docs.gomods.io/contributing/index.html Welcome, Gopher! We’re really glad you’re considering contributing to Athens. We’d like to briefly introduce you to our community before you get started. We have some hard-and-fast rules in our community, like our Code of Conduct, but instead of making rules pre-emptively, we try to keep in mind a shared philosophy to help us all make decisions and make new rules when we need to. Our Philosophy Document The philosophy section of these docs details our philosophy, and if you get involved with our project we encourage you to read it. https://docs.gomods.io/faq/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/faq/index.html Is Athens Just a Proxy? A Registry? TL;DR “Registry” doesn’t describe what Athens is trying to do here. That implies that there’s only one service in the world that can serve Go modules to everyone. Athens isn’t trying to be that. Instead, Athens is trying to be part of a federated group of module proxies. A registry is generally run by one entity, is one logical server that provides authentication (and provenance sometimes), and is pretty much the de-facto only source of dependencies. https://docs.gomods.io/try-out/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/try-out/index.html Try out Athens To quickly see Athens in action, follow these steps: First, make sure you have Go v1.12+ installed, that GOPATH/bin is on your path, and that you have enabled the Go Modules feature. Bash export GO111MODULE=onPowerShell $env:GO111MODULE = "on"Next, use git and Go to install and run the Athens proxy in a background process. $ git clone https://github.com/gomods/athens $ cd athens/cmd/proxy $ go install $ proxy & [1] 37186 INFO[0000] Exporter not specified. https://docs.gomods.io/walkthrough/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://docs.gomods.io/walkthrough/index.html First, make sure you have Go v1.12+ installed and that GOPATH/bin is on your path. Without the Athens proxy Let’s review what everything looks like in Go without the Athens proxy in the picture: Bash $ git clone https://github.com/athens-artifacts/walkthrough.git $ cd walkthrough $ GO111MODULE=on go run . go: downloading github.com/athens-artifacts/samplelib v1.0.0 The 🦁 says rawr! PowerShell $ git clone https://github.com/athens-artifacts/walkthrough.git $ cd walkthrough $ $env:GO111MODULE = "on" $ go run .