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；