getconvoy/convoy

Convoy Webhooks 网关

!convoy image

镜像概述

Convoy 是一款开源高性能 webhooks 网关，用于安全摄入、持久化、调试、交付和可靠管理数百万事件，具备重试、限流、静态 IP、熔断、滚动密钥等丰富功能。作为云原生解决方案，它部署在网络边缘，保护内部系统不暴露于公网，同时提供可独立扩展的组件以满足不同规模需求。

核心功能和特性

• Webhooks 网关
  部署在网络边缘，可从微服务流式传输 webhooks 并发送给用户，同时接收来自服务提供商的 webhooks 并路由到所需服务，确保内部系统不暴露于公网。

• 可扩展性
  作为 webhooks 的专用消息队列，设计为水平可扩展。包含 api server、workers、scheduler 和 socket server 等组件，可独立扩展以满足业务需求。

• 安全性
  内置多种安全特性，包括 payload 签名确保消息完整性、Bearer Token 认证用于已认证端点，以及静态 IP 支持严格防火墙环境。

• 扇出（Fan Out）
  支持根据事件类型或 payload 结构将单个事件路由到多个目标端点。

• 限流（Rate Limiting）
  可高速摄入事件，同时按每个端点的可配置速率限制事件向端点的交付频率。

• 重试与批量重试
  提供恒定时间重试和带抖动的指数退避重试算法；当自动重试不足时，支持对连续失败端点进行批量重试。

• 用户面向仪表盘
  支持生成嵌入式仪表盘（通过 iframe），用户可调试 webhooks、重试事件、管理端点及配置订阅。

• 端点故障通知
  端点连续失败时自动禁用并发送通知，支持电子邮件和 Slack 两种通知渠道。

使用场景和适用范围

Convoy 适用于以下场景：

• 微服务架构：作为服务间事件流转枢纽，确保跨服务事件可靠传递
• SaaS 应用：为用户提供 webhooks 管理能力，提升事件可见性和调试效率
• 大规模事件处理：电商订单事件、***交易通知等需处理数百万级事件的场景
• 安全敏感环境：需确保 webhooks 完整性、认证和访问控制的企业级应用
• 多端点分发：需根据事件属性动态路由到多个目标系统的业务场景

使用方法和配置说明

前提条件

• Docker 19.03+ 环境
• PostgreSQL 数据库（用于事件持久化）

核心配置项

Convoy 支持通过环境变量或配置文件配置，关键配置包括：

• 数据库连接信息（CONVOY_DATABASE_URL）
• API 服务端口（PORT，默认 8080）
• 日志级别（LOG_LEVEL，默认 info）
• 安全密钥（CONVOY_API_KEY）

详细配置说明参见 官方文档。

部署示例

基础 Docker 部署

bash
docker run -d \
  --name convoy \
  -p 8080:8080 \
  -e CONVOY_DATABASE_URL="postgresql://user:password@postgres-host:5432/convoy?sslmode=disable" \
  -e CONVOY_API_KEY="your-secure-api-key" \
  frain-dev/convoy:latest

Docker Compose 部署

yaml
version: '3.8'

services:
  convoy:
    image: frain-dev/convoy:latest
    ports:
      - "8080:8080"
    environment:
      - CONVOY_DATABASE_URL=postgresql://convoy:convoy-pass@db:5432/convoy?sslmode=disable
      - CONVOY_API_KEY=your-secure-api-key
      - LOG_LEVEL=info
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:14-alpine
    environment:
      - POSTGRES_USER=convoy
      - POSTGRES_PASSWORD=convoy-pass
      - POSTGRES_DB=convoy
    volumes:
      - postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  postgres-data:

启动服务：

bash
docker-compose up -d

参考资源

• 官方网站：getconvoy.io
• 文档：docs.getconvoy.io
• 社区论坛：Convoy Community
• Slack 社区：Join the Community

许可证

本镜像基于 https://github.com/frain-dev/convoy/blob/main/LICENSE 许可。