5分钟快速上手Webhook：从安装到第一个webhook配置

想要快速搭建自动化部署系统吗？webhook是一个轻量级的Go语言工具，能够让你轻松创建HTTP端点来执行服务器命令。通过webhook，你可以实现GitHub推送自动部署、Slack命令执行等各种自动化场景。本文将为你展示如何在5分钟内完成webhook的安装和基础配置。

📦 快速安装webhook

webhook提供多种安装方式，选择最适合你的方法：

使用包管理器安装（推荐）

# Ubuntu/Debian系统
sudo apt-get install webhook

# FreeBSD系统  
pkg install webhook

下载预编译二进制文件 访问GitHub Releases页面下载对应架构的二进制文件，解压后即可使用。

从源码构建 确保已安装Go 1.21+环境：

go build github.com/adnanh/webhook

⚙️ 创建第一个webhook配置

安装完成后，创建配置文件hooks.json：

[
  {
    "id": "redeploy-webhook",
    "execute-command": "/var/scripts/redeploy.sh",
    "command-working-directory": "/var/webhook"
  }
]

这个配置定义了一个名为redeploy-webhook的端点，当访问该端点时，会执行/var/scripts/redeploy.sh脚本。

🚀 启动webhook服务

使用以下命令启动webhook服务：

webhook -hooks hooks.json -verbose

服务默认在端口9000启动，你的webhook端点地址为：

http://yourserver:9000/hooks/redeploy-webhook

🔒 添加安全规则

为了防止未经授权的访问，建议添加触发规则：

{
  "trigger-rule": {
    "and": [
      {
        "match": {
          "type": "value",
          "value": "mysecret",
          "parameter": {
            "source": "url", 
            "name": "token"
          }
        }
      }
    ]
  }
}

现在需要携带token参数才能触发webhook：

http://yourserver:9000/hooks/redeploy-webhook?token=mysecret

🎯 高级配置选项

webhook支持丰富的配置参数，可以通过-h查看所有选项：

• -port：指定服务端口
• -ip：绑定特定IP地址
• -hotreload：配置文件热重载
• -secure：启用HTTPS支持

💡 实用技巧

1. 使用YAML配置：除了JSON，webhook也支持YAML格式配置
2. 环境变量传递：可以通过pass-environment-to-command向脚本传递环境变量
3. 响应自定义：使用response-message和response-headers自定义HTTP响应

📋 下一步探索

完成基础配置后，你可以：

• 查看hooks.json.example获取更多配置示例
• 阅读Hook定义文档了解高级功能
• 探索触发规则实现更复杂的安全控制

webhook是一个强大而简单的自动化工具，通过HTTP端点触发服务器命令，大大简化了持续集成和自动化部署流程。现在就开始你的webhook之旅吧！