Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
62 lines (50 sloc) 3.11 KB

turbo-vanityURLs - golift.io source

This is the source that runs https://golift.io.

Automatic Builds

This can be run anywhere, really. Packages and builds for lots of things are provided. The repo auto-builds packages for linux, binaries for macOS and windows. A homebrew formula and a Docker image are also available, and easy to use.

Install

  • Linux users can use this script to download and install the latest package for their system.
curl https://raw.githubusercontent.com/golift/turbovanityurls/master/scripts/install.sh | sudo bash
  • Docker users can pull directly from the image built on Docker.
docker pull golift/turbovanityurls:stable

The config file is located at /config.yaml, pass that path into your container.

  • macOS users can try it out using homebrew.
brew install golift/mugs/turbovanityurls
  • App Engine: Just push it as-is after you edit app.yaml and config.yaml.

Fixes from https://github.com/GoogleCloudPlatform/govanityurls

  • Wildcard Support Example: You can point a path (even /) to a github user/org. #25
  • App Engine Go 1.12. go112 #29
  • Moved Templates to their own file.
  • Cleaned up templates. Add some css, a little better formatting.
  • Pass entire PathConfig into templates.
  • Exported most of the struct members to make them usable by yaml and template packages.
  • Reused structs for unmarshalling and passing into templates.
  • Converted PathConfig to a pointer; can be accessed as a map or a slice now.
  • Embedded structs for better inheritance model.
  • Set max_age per path instead of global-only.
  • Added -l (listen) and -c (config) flags. #20
  • Root path repos work now. #23
  • Better auto-detection for repo type. #26 and #27

New Features

  • See the new manual, and the example config file.
  • Path redirects. Issue 302s for specific paths.
    • Useful for redirecting to download links on GitHub.
  • More customization for index and package pages.
  • Configurable descriptions and logos.
  • Better CSS/HTML templates.

Other

Incorporated a badge package for data collection and return. In other words this app can collect data from "things" (like the public grafana api) and store that data for later requests. I use this to populate badge/shield data for things like "grafana dashboard download counter" - https://github.com/golift/badgedata. It's 3 lines of code you can pull out real easy. You can also disable badgedata in the config file.

You can’t perform that action at this time.