govanityurls/README.md
Jaana Burcu Dogan 6deaf42fa0 fix README
2017-06-25 16:53:09 -07:00

35 lines
848 B
Markdown

# Go Vanity URLs
Go Vanity URLs is a simple App Engine Go app that allows you
to set custom import paths for your Go packages.
## Quickstart
Install [gcloud](https://cloud.google.com/sdk/downloads) and install Go App Engine component:
```
$ gcloud components install app-engine-go
```
Setup a [custom domain](https://cloud.google.com/appengine/docs/standard/python/using-custom-domains-and-ssl) for your app.
Get the application:
```
go get -u -d github.com/GoogleCloudPlatform/govanityurls
cd $(go env GOPATH)/github.com/GoogleCloudPlatform/govanityurls
```
Edit `vanity.yaml` too any number of git repos. E.g., `CUSTOM_DOMAIN/portmidi` will
serve the [https://github.com/rakyll/portmidi](https://github.com/rakyll/portmidi) repo.
```
/portmidi:
repo: https://github.com/rakyll/portmidi
```
Deploy the app:
```
$ gcloud app deploy
```