insidiousfiddler/vanity

Go Vanity URL Server

Go Vanity URL Server 简化了Go包自定义URL的创建，尤其适用于GitHub托管的包。它作为重定向服务，为自定义包路径提供go get操作支持。

核心功能与特性

• 通过简单的YAML文件进行配置
• 支持Go包的自定义路径
• 设计便于功能增强和日常维护

使用场景与适用范围

适用于需要为Go包创建自定义URL的开发者，特别是托管在GitHub上的项目，可通过自定义域名或路径统一管理Go包的导入路径，提升包的可识别性和易用性。

使用方法与配置说明

前提条件

• Docker环境：需安装Docker，可通过docker --version验证安装状态。未安装可从Docker官方网站下载。

获取Docker镜像

通过以下命令拉取预构建的Docker镜像：

bash
docker pull docker.xuanyuan.run/insidiousfiddler/vanity

运行Docker容器

使用本地配置文件

将包含vanity.yaml的本地目录挂载到容器中，默认配置路径为/etc/vanity：

bash
docker run -p 8080:8080 -v /path/to/your/config/directory:/etc/vanity docker.xuanyuan.run/insidiousfiddler/vanity

使用远程配置文件

通过环境变量VANITY_CONFIG_URL指定远程配置文件URL：

bash
docker run -p 8080:8080 -e VANITY_CONFIG_URL="https://example.com/vanity.yaml" docker.xuanyuan.run/insidiousfiddler/vanity

配置说明

配置文件（vanity.yaml）

服务器行为由vanity.yaml控制，示例配置：

yaml
domain: "go.example.com"
disableRootPackagesPage: false
poweredBy: true
packages:
  - path: "mylib"
    repo: "https://github.com/username/mylib"
    vcs: "git"
  - path: "myotherlib"
    repo: "https://github.com/username/myotherlib"
    vcs: "git"

• domain: 托管Go包的自定义域名
• disableRootPackagesPage: 是否禁用根路径的包列表网页（默认false）
• poweredBy: 是否显示"Powered by..."标识（默认true）
• packages: 包列表，每个包包含：
  • path: 包路径
  • repo: 仓库URL
  • vcs: 版本控制系统（如git）

配置验证：可在vanity.yaml顶部添加以下内容启用YAML schema验证：

• VSCode本地项目：# yaml-language-server: $schema=schema/vanity-schema.json
• 其他编辑器：# yaml-language-server: $schema=https://raw.githubusercontent.com/Codycody31/go-vanity/main/schema/vanity-schema.json

环境变量

• VANITY_PORT: 服务器监听端口（默认8080）
• VANITY_CONFIG: 本地配置文件路径（默认/etc/vanity/vanity.yaml）
• VANITY_CONFIG_URL: 远程配置文件URL（用于集中配置管理）

示例用法

配置示例：

yaml
domain: "go.codycody31.dev"
disableRootPackagesPage: false
poweredBy: true
packages:
  - path: "vanity"
    repo: "https://github.com/Codycody31/go-vanity"
    vcs: "git"
  - path: "woodpecker/woodpecker/v2"
    repo: "https://github.com/woodpecker/woodpecker"
    vcs: "git"
  - path: "logger"
    repo: "https://github.com/Codycody31/logger"
    vcs: "git"

使用go get导入：

bash
go get go.codycody31.dev/vanity
go get go.codycody31.dev/woodpecker/woodpecker/v2
go get go.codycody31.dev/logger

服务器会将请求重定向到对应的GitHub仓库。根路径会显示包列表网页（需disableRootPackagesPage: false）。

高级配置

可通过docker-compose.yml实现更复杂的部署，例如配置网络、日志等。示例：

yaml
version: '3'
services:
  vanity:
    image: docker.xuanyuan.run/insidiousfiddler/vanity
    ports:
      - "8080:8080"
    volumes:
      - ./config:/etc/vanity
    environment:
      - VANITY_PORT=8080
    restart: unless-stopped

贡献指南

欢迎社区贡献：

1. Fork仓库
2. 创建特性分支（git checkout -b feature/AmazingFeature）
3. 提交更改（git commit -am 'Add some AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 提交Pull Request

许可证

本项目采用MIT许可证 - 详见LICENSE文件。