microservices/github
microservices
这是一个遵循Open Microservice规范的GitHub微服务镜像，支持REST API请求、GraphQL查询、Webhook事件监听及登录服务，可配置企业版GitHub参数与身份验证方式。
1 次收藏下载次数: 0状态：社区镜像维护者：microservices仓库类型：镜像最近更新：6 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
GitHub Open Microservice
GitHub API、GraphQL、Webhook及登录服务
https://img.shields.io/badge/Open%20Microservice-1.0-477bf3.svg]([] https://withspectrum.github.io/badge/badge.svg]([] https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg](https://github.com/oms-services/.github/blob/master/CODE_OF_CONDUCT.md) https://img.shields.io/badge/commitizen-friendly-brightgreen.svg](http://commitizen.github.io/cz-cli/) https://img.shields.io/badge/PRs-welcome-brightgreen.svg]([***] https://img.shields.io/badge/License-MIT-blue.svg](https://opensource.org/licenses/MIT)
镜像概述
本镜像为Open Microservice规范的示例实现，该规范用于构建高可移植性微服务，暴露容器化软件的事件、操作与API。镜像封装GitHub核心功能，支持REST API调用、GraphQL查询、Webhook监听及多方式身份验证。
核心功能
- REST API请求：通过指定方法、URL等参数调用GitHub REST接口
- GraphQL查询：执行GitHub GraphQL查询获取仓库、用户等数据
- Webhook事件监听：订阅并处理GitHub事件（如push、PR）
- 身份验证：支持OAuth令牌、GitHub App ID/私钥等认证方式
- 企业版适配：可配置GitHub Enterprise的主机名与API地址
使用场景
- 自动化GitHub仓库管理与数据同步
- 构建基于GitHub事件的工作流（如PR自动审核、Issue通知）
- 集成GitHub身份验证到自定义应用
- 对接企业版GitHub服务的内部系统
配置说明
环境变量
| 变量名 | 类型 | 说明 |
|---|---|---|
| APP_ID | 整数 | GitHub App ID |
| APP_PRIVATE_KEY | 字符串 | GitHub App私钥（PEM格式） |
| HOSTNAME | 字符串 | GitHub主机名（企业版使用） |
| API_HOSTNAME | 字符串 | GitHub API主机名（默认：api.HOSTNAME） |
| CLIENT_ID | 字符串 | GitHub OAuth客户端ID |
| CLIENT_SECRET | 字符串 | GitHub OAuth客户端密钥 |
| OAUTH_TOKEN | 字符串 | 用户OAuth令牌 |
| WEBHOOK_SECRET | 字符串 | Webhook签名验证密钥 |
| USER_AGENT | 字符串 | GitHub要求的User-Agent头 |
操作示例
调用REST API
shelloms run api \ -a method='GET' \ -a url='/repos/oms-services/github' \ -e OAUTH_TOKEN=$YOUR_OAUTH_TOKEN \ -e USER_AGENT='MyApp/1.0'
执行GraphQL查询
shelloms run graphql \ -a query='query { repository(owner:"oms-services", name:"github") { name } }' \ -e OAUTH_TOKEN=$YOUR_OAUTH_TOKEN
订阅Webhook事件
shelloms subscribe webhooks \ -a events='["push", "pull_request"]' \ -e WEBHOOK_SECRET=$YOUR_WEBHOOK_SECRET \ -e USER_AGENT='MyApp/1.0'
安装与使用
安装OMS CLI
npm install -g @microservices/oms
运行镜像
需先安装OMS CLI，然后在项目根目录执行上述操作命令。
贡献指南
欢迎通过Issue提交建议或Fork仓库提交PR。本项目遵循https://github.com/oms-services/.github/blob/master/CODE_OF_CONDUCT.md%E8%A1%8C%E4%B8%BA%E5%87%86%E5%88%99%EF%BC%8C%E8%AF%A6%E6%83%85%E8%A7%81https://github.com/oms-services/.github/blob/master/CONTRIBUTING.md%E3%80%82
附加资源
- https://github.com/microservices/oms%EF%BC%9A%E5%BE%AE%E6%9C%8D%E5%8A%A1%E5%88%9B%E5%BB%BA%E3%80%81%E6%B5%8B%E8%AF%95%E5%B7%A5%E5%85%B7
- https://github.com/oms-services%EF%BC%9A%E5%A4%9A%E8%AF%AD%E8%A8%80OMS%E6%9C%8D%E5%8A%A1%E7%A4%BA%E4%BE%8B
- Storyscript Hub：OMS服务公共注册表
- 社区聊天：加入讨论想法与问题 ===END===
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 github 镜像标签
docker pull docker.xuanyuan.run/microservices/github:<标签>
DockerHub 原生拉取命令
docker pull microservices/github:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"