mirror of
https://github.com/aykhans/gopkg-proxy.git
synced 2026-01-13 18:51:21 +00:00
first commit
This commit is contained in:
38
README.md
Normal file
38
README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# gopkg-proxy
|
||||
|
||||
A lightweight vanity import path server for Go packages. Use your own domain for clean, branded package imports.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Add Packages
|
||||
|
||||
Edit `main.go`:
|
||||
|
||||
```go
|
||||
var packages = []Package{
|
||||
{
|
||||
Path: "/my-package",
|
||||
Repo: "https://github.com/username/my-package",
|
||||
VCS: "git",
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- `PORT` - Server port (default: `8421`)
|
||||
- `HOST_HEADER` - Header to read domain from (default: `X-Forwarded-Host`)
|
||||
|
||||
## Usage
|
||||
|
||||
Instead of:
|
||||
|
||||
```go
|
||||
import "github.com/aykhans/go-utils"
|
||||
```
|
||||
|
||||
Use:
|
||||
|
||||
```go
|
||||
import "gopkg.yourdomain.com/go-utils"
|
||||
```
|
||||
Reference in New Issue
Block a user