lukasmartinelli/ghrr

GitHub实时中继（GHRR）

镜像概述

该镜像实现了GitHub实时事件中继功能，通过socket.io从GitHub公共事件中轮询数据并通过websocket转发，是构建基于GitHub实时数据应用的简单工具。注：此仓库已不再由Lukas Martinelli维护。

核心功能

1. 实时事件接收：获取GitHub所有公共实时事件
2. 多客户端支持：兼容Node服务器和Web应用连接
3. 事件类型订阅：可针对特定GitHub事件类型（如push事件）订阅
4. 统计数据获取：提供事件类型使用统计数据
5. 自主部署：支持自行搭建中继服务，需配置GitHub OAuth token

使用场景

• 实时监控GitHub公共事件动态
• 构建GitHub事件统计分析页面
• 开发基于GitHub实时数据的应用（如代码质量检测、项目更新提醒等）

配置说明

服务器端（Node）连接

1. 安装socket.io-client：

bash
npm install socket.io-client

2. 订阅事件示例：

javascript
var url = 'http://ghrr.lukasmartinelli.ch:80/events';
var socket = require('socket.io-client')(url);

socket.on('pushevent', function(event){
   console.log('推送事件：' + event.repository.full_name);
});

3. 获取统计数据示例：

javascript
var url = 'http://ghrr.lukasmartinelli.ch:80';
var io = require('socket.io-client')(url);
io('/statistics').on('types', function(typeCounts) {
    console.log('推送事件数量：' + typeCounts.pushevent);
});

Web应用连接

1. 引入socket.io客户端：

html
<script src="//cdn.jsdelivr.net/socket.io-client/1.2.0/socket.io.js"></script>

2. 连接示例：

javascript
var url = 'http://ghrr.lukasmartinelli.ch:80/events';
var socket = io(url);

socket.on('pushevent', function (event) {
   console.log('推送事件：' + event.repository.full_name);
});

自主部署

1. 拉取镜像：

bash
docker pull lukasmartinelli/ghrr

2. 运行镜像（需替换为自己的GitHub OAuth token）：

bash
docker run -e GITHUB_TOKEN="你的OAuth令牌" -p 3000:3000 lukasmartinelli/ghrr

（注：部署时需设置轮询频率和端口，示例中轮询频率为1000ms，端口为3000）