WebhockTransfer

Webhock

Go to file

houhuan 2bc7460f1f feat: 初始化Webhook中继系统项目 - 添加FastAPI应用基础结构，包括主入口、路由和模型定义 - 实现Webhook接收端点(/webhook/{namespace})和健康检查(/health) - 添加管理后台路由和模板，支持端点、目标、渠道和模板管理 - 包含SQLite数据库模型定义和初始化逻辑 - 添加日志记录和统计服务 - 包含Dockerfile和配置示例文件 - 添加项目文档，包括设计、流程图和验收标准		2025-12-21 18:43:12 +08:00
.trae/documents	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
app	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
config	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
docs/webhook-relay	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
samples	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
scripts	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
templates/admin	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
123.josn	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
Dockerfile	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
README.md	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00
requirements.txt	feat: 初始化Webhook中继系统项目	2025-12-21 18:43:12 +08:00

项目简介

这是一个可配置的 Webhook 中继与通知系统，用于：

核心特性：

主要目录：

安装依赖：
- 可选：创建虚拟环境
- 执行：pip install -r requirements.txt
初始化数据库并启动服务：
- 进入项目根目录：cd e:\2025Code\python\webhock
- 启动：uvicorn app.main:app --host 0.0.0.0 --port 8080 --reload
访问入口：
- Webhook 接口：POST http://localhost:8080/webhook/{namespace}
- 健康检查：GET http://localhost:8080/health
- 管理后台：GET http://localhost:8080/admin/endpoints

项目包含 Dockerfile，可直接构建镜像部署：

构建镜像：
- 在项目根目录执行
  docker build -t webhook-relay .
运行容器（基础示例）：
- docker run -d --name webhook-relay -p 8080:8080 webhook-relay
默认配置：
- 工作目录：/app
- 配置与数据库目录：/app/config
- 默认数据库：sqlite:///./config/data.db
使用持久化存储：
- 在宿主机创建配置/数据目录，例如：/srv/webhook-relay/config
- 将初始配置文件与数据库（可选）放入该目录
- 启动容器时挂载目录：
  - docker run -d --name webhook-relay -p 8080:8080 -v /srv/webhook-relay/config:/app/config webhook-relay
自定义数据库：
- 通过环境变量 DB_PATH 覆盖默认数据库连接：
  - 例如：-e DB_PATH="sqlite:///./config/data.db"（默认值）
  - 或者：-e DB_PATH="postgresql+psycopg2://user:pass@host:5432/dbname"（需要自行安装驱动并调整镜像）

管理后台主要页面：

典型流程：

在 “Targets” 中配置内部系统的 Webhook URL
在 “Channels” 中配置飞书/企微机器人地址
在 “Templates” 中配置通用或专用消息模板
在 “Endpoints” 中创建业务端点，并在详情页中：
- 创建根规则，按 remark 或其他字段区分不同业务来源
- 在子规则中根据 event_define_no 等字段区分事件类型
- 为规则添加 Forward/Notify 动作，绑定目标、渠道与模板变量

在本地完成配置与验证后，将整个仓库推送到 Gitea：
- 初始化 git 仓库（如尚未初始化）：git init
- 添加远程并推送到 Gitea 项目
在服务器上通过 Gitea 拉取代码：
- 使用 Gitea 的 “克隆” 地址在服务器执行 git clone
在服务器上构建并运行 Docker 镜像：
- docker build -t webhook-relay .
- 准备持久化目录并挂载配置/数据库
- docker run -d --name webhook-relay -p 8080:8080 -v /srv/webhook-relay/config:/app/config webhook-relay
如需进一步自动化（CI/CD）：
- 可以在 Gitea 中配置 Actions 或 Webhook，在推送时自动触发服务器上的构建与重启逻辑
- 具体流水线脚本可根据你的服务器环境与习惯单独设计

更详细的架构、流程与用例说明可参考：