beevelop/shields

Shields.io Docker镜像

镜像概述和主要用途

本镜像为https://github.com/badges/shields%E7%9A%84Docker%E5%8C%96%E9%83%A8%E7%BD%B2%E7%89%88%E6%9C%AC%EF%BC%8CShields.io%E6%98%AF%E4%B8%80%E4%B8%AA%E7%94%A8%E4%BA%8E%E7%94%9F%E6%88%90%E5%90%84%E7%B1%BB%E5%BE%BD%E7%AB%A0%EF%BC%88Badge%EF%BC%89%E7%9A%84%E6%9C%8D%E5%8A%A1%E3%80%82%E9%80%9A%E8%BF%87%E6%9C%AC%E9%95%9C%E5%83%8F%E5%8F%AF%E5%BF%AB%E9%80%9F%E9%83%A8%E7%BD%B2%E8%87%AA%E6%89%98%E7%AE%A1%E7%9A%84%E5%BE%BD%E7%AB%A0%E7%94%9F%E6%88%90%E6%9C%8D%E5%8A%A1%EF%BC%8C%E5%B9%B6%E6%94%AF%E6%8C%81%E9%9B%86%E6%88%90Varnish%E4%BD%9C%E4%B8%BA%E7%BC%93%E5%AD%98%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%8C%E4%BB%A5%E6%8F%90%E9%AB%98%E6%80%A7%E8%83%BD%E5%B9%B6%E9%99%8D%E4%BD%8E%E6%9C%8D%E5%8A%A1%E5%99%A8%E8%B4%9F%E8%BD%BD%E3%80%82

核心功能和特性

• 提供自托管的Shields.io徽章生成服务
• 支持通过Docker Compose集成Varnish缓存，提升响应速度
• 可通过环境变量灵活配置服务参数
• 支持GitHub API认证，避免公共API的请求配额限制（每小时60次请求）

使用场景和适用范围

• 需要自定义徽章生成服务的企业或个人开发者
• 对徽章服务响应速度和稳定性有较高要求的场景
• 希望避免依赖公共Shields.io服务，防止请求配额限制的应用

使用方法和配置说明

使用Docker Compose运行

通过docker-compose.yml可便捷部署包含Varnish缓存的Shields服务，步骤如下：

bash
# 克隆仓库
# 根据需求调整docker-compose.yml（如配置INFOSITE等参数）
docker-compose up -d
docker-compose logs -f

手动运行

如需直接运行容器，可使用以下命令：

bash
docker run -d --name shields -p 80:80 \
    -e INFOSITE="http://shields.example.com" \
    beevelop/shields

服务启动后，访问地址为：http://shields.example.com/try.html（需添加try.html路径，根目录默认重定向至官方shields.io）

配置参数

服务可通过以下环境变量进行配置：

• GH_CLIENT_ID（默认值：null）：GitHub客户端ID，用于GitHub API认证
• GH_CLIENT_SECRET（默认值：null）：GitHub客户端密钥，用于GitHub API认证
• INFOSITE（默认值："http://shields.io"）：信息站点URL

注意：务必配置GH_CLIENT_ID和GH_CLIENT_SECRET变量，以避免达到GitHub API每小时60次请求的配额限制。