# GitLabNotify

**Repository Path**: DLarpx/GitLabNotify

## Basic Information

- **Project Name**: GitLabNotify
- **Description**: GitLabNotify 是一个轻量级的 Webhook 中继服务，专为 GitLab 老版本无法直接集成企业微信转发插件的场景设计。
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-07
- **Last Updated**: 2026-07-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GitLabNotify

[中文](README.md) | [English](README.en.md)

**文档**：[用户使用说明](docs/用户使用说明.md) · [开发说明](docs/开发说明.md)

> GitLab Webhook 转发服务 —— 接收 GitLab 回调，格式化后转发到企业微信、钉钉、飞书等群机器人。

## 能做什么

- 接收 GitLab Push 等 Webhook（架构可扩展其他事件）
- 格式化为目标平台消息并转发（企业微信 / 钉钉 / 飞书 / 通用 HTTP）
- 失败自动重试；记录写入 SQLite，便于排查
- Token 鉴权与健康检查，适合 Docker 部署

## 程序怎样工作

1. GitLab 向本服务投递 Webhook  
2. 鉴权通过后入队并立即应答，后台异步格式化并推送到群机器人  
3. 结果落库；失败按配置重试，错误内容不会当作消息发到群里  

## 快速开始

**Docker（推荐）**

```bash
git clone <repo-url>
cd GitLabNotify
cp .env.example .env
# 编辑 .env：填写 GitLab 口令与机器人地址
docker-compose up -d
curl http://localhost:8080/health
```

**本地开发**

```bash
dotnet run --project src/GitLabNotify
```

在 GitLab 项目 Settings → Webhooks 中填写 `http://你的主机:端口/webhook`，Secret Token 与配置一致，勾选 Push events。

更完整的使用步骤见 [用户使用说明](docs/用户使用说明.md)。

## 目录示意

`src/` 业务与测试 · `docs/` 文档 · `scripts/` 脚本 · 根目录 `Dockerfile` / `docker-compose.yml`

## 项目说明

| 项 | 内容 |
|----|------|
| 产品名 | GitLabNotify |
| 命名空间根 | `Larpx.PersonalTools.GitLabNotify` |
| 技术栈 | .NET 10 · ASP.NET Core · SQLite · Serilog · Docker |
| 解决方案 | `GitLabNotify.slnx` |

## License

见 [LICENSE](LICENSE)（MIT）。