使用 GitLab WebHooks 功能在 Linux 下自动

Web hooks 用于当 GitLab 上的项目有变化的时侯以 HTTP 接口的形式通知第三方

webhooksline.png

Web Hooks 脚本

---

在更新服务目录下新建 githooks.php
代码如下:

<?php
//GitLab 服务器上项目目录
$www_file='/www/gittest';

//打开网站目录下的hooks.log文件 需要在服务器上创建 并给写权限
$fs = fopen($www_file.'hooks.log', 'a');

//脚本执行用户
$who=exec('whoami');
fwrite($fs, $who.'================ Update Start ==============='.PHP_EOL.PHP_EOL);

//自定义字串掩码 用于验证
$access_token = 'e1bfd762321e409cee4ac0b6e849876c';

//接受的ip数组，也就是允许哪些IP访问这个文件 这里是 GitLab 服务器IP
$access_ip = array('8.8.8.8');

//获取请求端的 IP 和 token
$client_token = $_GET['token'];
$client_ip = $_SERVER['REMOTE_ADDR'];

//把请求的 IP 和时间写进 log
fwrite($fs, 'Request on ['.date("Y-m-d H:i:s").'] from ['.$client_ip.']'.PHP_EOL);

//验证 Token 有错就写进日志并退出
if ($client_token !== $access_token)
{
    echo "error 403";
    fwrite($fs, "Invalid token [{$client_token}]".PHP_EOL);
    exit(0);
}

//验证 IP
if ( !in_array($client_ip, $access_ip))
{
    echo "error 503";
    fwrite($fs, "Invalid ip [{$client_ip}]".PHP_EOL);
    exit(0);
}

//获取请求端发送来的信息，具体格式参见 GitLab 的文档
$json = file_get_contents('php://input');
$data = json_decode($json, true);

//如果有需要 可以打开下面，把传送过来的信息写进log
fwrite($fs, 'Data: '.print_r($data, true).PHP_EOL);

//执行shell命令并把返回信息写进日志
$output=shell_exec("cd $www_file && git checkout master && git pull origin master 2>&1");
fwrite($fs, 'Info:'. $output.PHP_EOL);

fwrite($fs,PHP_EOL. '================ Update End ==============='.PHP_EOL.PHP_EOL);

$fs and fclose($fs);

设置 Deploy Keys

---

1. 通过 $who=exec('whoami') 的命令日志，可以知晓脚本的执行用户，以 www 用户为例
2. 切换到 www 用户 : su www
3. 使用 www 用户生成 SSH Keys, 复制 SSH Keys;
4. 登录到 GitLab 选择 Project -> Setting -> Deploy Keys -> New Deploy Keys，添加 SSH Keys . Deploy Keys 只有 read-only 权限，用于项目部署；
   deploykeys.png
5. 将 GitLab 上的项目 手动 pull 到 www_file 目录下；

添加 Web Hooks 地址

---

1. 拼写 Web Hooks 地址:
   http://git.redoca.com/xxx/githooks.php?token= e1bfd762321e409cee4ac0b6e849876c
   token为自定义，与 githooks.php 中的 token 一致即可；
2. 登录到 GitLab 选择 Project -> Setting -> Web Hooks 添加 Web Hooks 地址，Trigger 选择 Push events;
   webhooks.png
3. 在本地机器 push 一次提交，验证是否同步更新至服务器；如遇问题查看 gittesthooks.log；