webhooks服务器_github hooks钩子的搭建(代码同步功能,webhooks)

钩子是什么，就是将本地代码推送至github后自动将代码同步至服务器。

搭建步骤

在服务器查找运行php的用户，为他生成deploy-key，保存在github上

在服务器拉取项目仓库

在服务器项目根目录下建立代码同步的deploy.php

github上设置仓库的webhooks

本地拉取仓库提交代码测试

1.设置deploy-key

查找php是什么用户运行的

ps aux | grep php

我的显示是www用户 但是查看所有用户

cat /etc/passwd | grep www

查找出来是www-data

查找用户组

cat /etc/group | grep www

查找出来也是www-data

所以我判定我的php执行用户是www-data 属于www-data用户组

配置服务器git:

git config --global user.name "name"

git config --global user.email "email"

执行命令

sudo -Hu www-data ssh-keygen -t rsa

生成www-data用户的deploy-key(为什么要给www-data用户生成key，因为在本地提交代码时，github会请求服务器的php文件从而同步服务器代码)。

这时候报错

报错.png

报错原因是无法在目录下创建目录以及找不到目录

原来www目录属于root用户组 权限是rwxr-xr-x

image.png

我们需要进入www目录创建.ssh目录后更改目录用户权限

chown -R www-data:www-data ./.ssh/

这时候再次执行命令 sudo -Hu www-data ssh-keygen -t rsa ，生成deploy-key。将生成的id_rsa.pub文件内容，添加到项目中的 deploy keys中。

打开github上的项目仓库，给项目添加deploy-key

image.png

2. 在服务器上拉取自己的仓库(使用ssh方式)

3.建立代码同步的deploy.php

在仓库根目录下建立deploy.php文件

@file_put_contents('./req.log',json_encode($_POST).PHP_EOL, FILE_APPEND|LOCK_EX);

class Deployment {

public $serect = 'zjh19971010.'; //自定义的webhooks中配置的密钥

public function deploy()

{

$requestBody = file_get_contents('php://input'); //每次推送的时候，会接收到post过来的数据。

$payload = json_decode($requestBody, true); //将数据转成数组，方便取值。

if(empty($payload)){

//写日志

$this->write_log('send fail from github is empty');exit;

}else{

//获取github推送代码时经过哈希加密密钥的值

$signature = $_SERVER['HTTP_X_HUB_SIGNATURE'];

}

if (strlen($signature) > 8 && $this->isFromGithub($requestBody,$signature)) {

//验证密钥是否正确，如果正确执行命令。

$res = shell_exec("cd /var/www/html/ball_mation/ball_mation/ &&

git pull 2>&1"); // 项目目录

$res_log = "\n -------------------------".PHP_EOL;

$res_log .= '['.$payload['commits'][0]['author']['name'] . ']' . '向[' . $payload['repository']['name'] . ']项目的' . $payload['ref'] . '分支'.$_SERVER['X-GitHub-Event'].'了代码。commit信息是：'.$payload['commits']['message'].'。详细信息如下：' . PHP_EOL;

$res_log .= $res.PHP_EOL;

http_response_code(200);

$this->write_log($res_log);

}else{

$this->write_log('git 提交失败！');

abort(403);

}

}

public function isFromGithub($payload,$signature)

{

//$hash是github的密钥。然后与本地的密钥做对比。

list($algo, $hash) = explode("=", $signature, 2);

return $hash === hash_hmac($algo, $payload, $this->serect);

}

public function write_log($data)

{

// 此处加载日志类，用来记录git push信息，可以自行写。

file_put_contents('./push_push.log', $data.PHP_EOL, FILE_APPEND|LOCK_EX);

}

}

$deploy = new Deployment();

if($_SERVER['REQUEST_METHOD'] == 'POST'){

//触发此代码的时候，git是以post方式触发

$signature = $deploy->deploy();

}

代码中的$serect跟shell_exec()函数中的项目路径需要更改为自己的

4.设置仓库的webhooks

image.png

填写自己的serect跟deploy.php访问url即可，传输方式选择json

image.png

5.本地测试

拉取仓库代码在本地修改提交后，检查服务器代码是否同步，若同步即为成功