README.md

Goproxy

A minimalist Go module proxy handler.

Goproxy has fully implemented the Go's module proxy protocol. Our goal is to find the most dead simple way to provide a minimalist handler that can act as a full-featured Go module proxy for those who want to build their own proxies. Yeah, there is no Makefile, no configuration files, no crazy file organization, no lengthy documentation, no annoying stuff, just a goproxy.Goproxy that implements the http.Handler.

The project was created on 2019-06-03 and is still very young, so it's not production-ready yet. Issues welcome! PRs welcome!

Features

• Extremely easy to use
  • One struct: goproxy.Goproxy
  • Two interfaces: goproxy.Cacher and goproxy.Cache
• Can be served under other Go module proxies by setting GOPROXY
• Built-in GONOPROXY (it will be introduced in Go 1.13) support
• Supports multiple mainstream implementations of the goproxy.Cacher
  • Disk: cachers.Disk
  • MinIO: cachers.MinIO
  • Google Cloud Storage: cachers.GCS
  • Amazon Simple Storage Service: cachers.S3
  • Alibaba Cloud Object Storage Service: cachers.OSS
  • Qiniu Cloud Kodo: cachers.Kodo

Installation

Open your terminal and execute

$ go get github.com/goproxy/goproxy

done.

The only requirement is the Go, at least v1.11.

Quick Start

Create a file named goproxy.go

package main

import (
	"net/http"

	"github.com/goproxy/goproxy"
)

func main() {
	http.ListenAndServe("localhost:8080", goproxy.New())
}

and run it

$ go run goproxy.go

then try it by setting GOPROXY to http://localhost:8080 by following the instructions below.

macOS or Linux

Open your terminal and execute

$ export GOPROXY=http://localhost:8080

or

$ echo "GOPROXY=http://localhost:8080" >> ~/.profile && source ~/.profile

done.

Windows

Open your PowerShell and execute

C:\> $env:GOPROXY = "http://localhost:8080"

or

1. Open the Start Search, type in "env"
2. Choose the "Edit the system environment variables"
3. Click the "Environment Variables…" button
4. Under the "User variables for <YOUR_USERNAME>" section (the upper half)
5. Click the "New..." button
6. Choose the "Variable name" input bar, type in "GOPROXY"
7. Choose the "Variable value" input bar, type in "http://localhost:8080"
8. Click the "OK" button

done.

Community

If you want to discuss Goproxy, or ask questions about it, simply post questions or ideas here.

Contributing

If you want to help build Goproxy, simply follow this to send pull requests here.

License

This project is licensed under the Unlicense.

License can be found here.