golift/turbovanityurls

turbo-vanityURLs - golift.io 镜像文档

镜像概述和主要用途

turbo-vanityURLs是一个HTTP服务器，用于提供自定义Go vanity import路径，支持多种部署环境。该镜像基于golift.io源代码构建，可运行在Docker、Linux、macOS、FreeBSD及App Engine等平台，旨在简化Go包的自定义导入路径配置与管理。

核心功能和特性

与govanityurls的差异

• 通配符支持：可将路径（甚至根路径）指向GitHub用户或组织
• App Engine兼容性：支持Go 1.12、1.15+版本
• 模板优化：模板独立文件化，优化CSS样式与格式化
• 配置增强：支持按路径设置max_age，而非全局配置
• 命令行标志：新增-l（监听地址）、-t（超时时间）、-c（配置文件）参数
• 根路径支持：修复根路径仓库访问问题
• 仓库类型自动检测：优化仓库类型识别逻辑

新功能

• 路径重定向：支持302重定向，适用于GitHub下载链接等场景
• 页面定制：索引页和包页面支持更多自定义配置
• 描述与Logo配置：可自定义描述文本和Logo
• 增强模板：提供更优的CSS/HTML模板

其他特性

• 集成badge数据收集功能，可从外部API（如Grafana）收集数据并生成徽章
• 支持配置文件禁用badge数据功能

使用场景和适用范围

• 个人开发者或组织需要自定义Go包导入路径
• 需在不同平台（Docker、Linux、macOS等）部署 vanity import服务
• 需要通过路径重定向管理包的下载或文档链接
• 希望自定义vanity import页面样式与内容

详细使用方法和配置说明

安装方式

Linux

通过脚本自动安装最新包（支持APT或YUM系统）：

bash
curl -s https://golift.io/repo.sh | sudo bash -s - turbovanityurls

非APT/YUM系统可从https://github.com/golift/turbovanityurls/releases下载安装包。

Docker

直接拉取镜像：

bash
docker pull docker.xuanyuan.run/golift/turbovanityurls

配置文件路径：/etc/turbovanityurls/config.yaml，需将本地配置文件挂载到容器内。

macOS

使用Homebrew安装：

bash
brew install golift/mugs/turbovanityurls

FreeBSD

从https://github.com/golift/turbovanityurls/releases下载对应包。

App Engine

编辑app.yaml后执行部署：

bash
gcloud app deploy

Docker部署示例

基本运行命令

bash
docker run -d \
  -p 8080:8080 \
  -v /path/to/local/config.yaml:/etc/turbovanityurls/config.yaml \
  --name turbovanityurls \
  docker.xuanyuan.run/golift/turbovanityurls

自定义监听地址和超时

bash
docker run -d \
  -p 80:8080 \
  -v /path/to/config.yaml:/etc/turbovanityurls/config.yaml \
  docker.xuanyuan.run/golift/turbovanityurls -l 0.0.0.0:8080 -t 30s

Nginx代理配置示例

在Docker环境中配合swag（nginx）使用时的配置：

nginx
server {
  # 指向turbovanityurls容器
  set $server http://golift:8080;
  server_name golift.io www.golift.io code.golift.io;

  listen 443 ssl http2;

  location @proxy {
    include  /config/nginx/proxy.conf;
    proxy_pass $server$request_uri;
  }

  location / {
    # 指向本地静态文件目录
    root /config/www/golift.io;
    try_files $uri @proxy;
  }
}

配置文件说明

配置文件示例可参考https://github.com/golift/turbovanityurls/blob/master/examples/config.yaml.example，支持以下主要配置项：

• 路径重定向规则
• 仓库类型与地址
• 页面描述与Logo
• badge数据收集开关
• 超时时间与监听地址

集成服务

以下服务为项目提供免费支持（存储、构建、分发等）：

https://packagecloud.io https://GitHub.com https://cloud.docker.com