2f28dc9e51
* Make athens banner smaller This helps people see that there is more content below the athens logo, otherwise the most prominent thing they see is the next arrow > and they miss our homepage content. * Make home link friendly for previews Right now when viewing a preview of our docs site, when I click on the home logo I end up on our live site. This makes the home logo go to the root of the current site instead, which is more friendly for testing docs locally or previewing a PR.
2.3 KiB
title, date
| title | date |
|---|---|
| Intro | 2018-02-11T16:52:23-05:00 |
Welcome to Athens
Athens is the name of the combined project that includes a global registry for Go Modules and a stand-alone proxy server that can be deployed on-premise to storage and control available Go modules for your organization.
Try out Athens
To quickly see Athens in action, follow these steps:
First, make sure you have Go 1.11 installed and that GOPATH/bin is on your path.
Next, use Go to install and run the Athens proxy in a background process
$ go get -u github.com/gomods/athens/cmd/proxy
# the source is downloaded to GOPATH/src/github.com/gomods/athens/
$ proxy &
[1] 25243
INFO[0000] Starting application at 127.0.0.1:3000
Next, you will need to enable the Go Modules feature and configure Go to use the proxy!
Bash
export GO111MODULE=on
export GOPROXY=http://127.0.0.1:3000
PowerShell
$env:GO111MODULE = "on"
$env:GOPROXY = "http://127.0.0.1:3000"
Now, when you build and run this example application, go will fetch dependencies via Athens!
$ git clone https://github.com/athens-artifacts/walkthrough.git
$ cd walkthrough
$ go run .
go: finding github.com/athens-artifacts/samplelib v1.0.0
handler: GET /github.com/athens-artifacts/samplelib/@v/v1.0.0.info [200]
handler: GET /github.com/athens-artifacts/samplelib/@v/v1.0.0.mod [200]
go: downloading github.com/athens-artifacts/samplelib v1.0.0
handler: GET /github.com/athens-artifacts/samplelib/@v/v1.0.0.zip [200]
The 🦁 says rawr!
The output from go run . includes attempts to find the github.com/athens-artifacts/samplelib dependency. Since the
proxy was run in the background, you should also see output from Athens indicating that it is handling requests for the dependency.
This should give you an overview of what using Athens is like!
Next Steps
- If you are interested in what is happening between the proxy and the Go Modules feature, the Walkthrough explores this in greater depth.
- For more detailed information on how to run Athens in production, check out our other documentation (coming soon!!).
Athens banner attributed to Golda Manuel