一.Webhook 介绍与作用简介
Webhook,顾名思义就是钩子,简而言之,可以在特定情况下触发特定的操作。例如在远程git仓库中进行了push、tag等操作时,自动在远程server端自动拉取、编译代码。 以下是一个push代码到远程仓库后,自动拉取代码进行编译后,将生成的Webassembly相关的文件(.js,.wasm)和版本号push到远程仓库中的demo。
2. PHP代码实现
- /path/to/www/hooks/hooks.php //hook.php 放到php对应的www目录下 保证url能正常访问到对应的hook.php文件 例如:localhost/hooks/hooks.php
<?php // 本地仓库路径 $local = '/data/wwwroot/demo'; // 安全验证字符串,为空则不验证 $token = '123456'; // payload为字符串,需要经过解析 $payload = file_get_contents('php://input'); if (!$payload) { header('HTTP/1.1 400 Bad Request'); die('HTTP HEADER or POST is missing.'); } $content = json_decode($payload, true); // 如果启用验证,并且验证失败,返回错误 if ($token && $content['password'] != $token) { header('HTTP/1.1 403 Permission Denied'); die('Permission denied.'); } //最后会执行一个脚本编译代码,然后再push代码到远程 //所以会重复触发WebHooks,因此此处判断是否是本地的推送 if($content['commits'][0]['author']['name'] == 'handsomeTaoTao'){ header('HTTP/1.1 403 Permission Denied'); die('self push.'); } /* * 这里有几点需要注意: * * 1.确保PHP正常执行系统命令。写一个PHP文件,内容: * `<?php echo shell_exec('ls -la')` * 在通过浏览器访问这个文件,能够输出目录结构说明PHP可以运行系统命令。 * * 2、PHP一般使用www-data或者nginx用户运行,PHP通过脚本执行系统命令也是用这个用户, * 在通过浏览器访问这个文件,能够输出目录结构说明PHP可以运行系统命令。 * * 2、PHP一般使用www-data或者nginx用户运行,PHP通过脚本执行系统命令也是用这个用户, * 所以必须确保在该用户家目录(一般是/home/www-data或/home/nginx)下有.ssh目录和 * 一些授权文件,以及git配置文件,如下: * ``` * + .ssh * - authorized_keys * - config * - id_rsa * - id_rsa.pub * - known_hosts * - .gitconfig * ``` * * 3.在执行的命令后面加上2>&1可以输出详细信息,确定错误位置 * * 4.git目录权限问题。比如: * `fatal: Unable to create '/data/www/html/awaimai/.git/index.lock': Permission denied` * 那就是PHP用户没有写权限,需要给目录授予权限: * `` * sudo chown -R :www-data /data/www/html/awaimai` * sudo chmod -R g+w /data/www/html/awaimai * ``` * * 5.SSH认证问题。如果是通过SSH认证,有可能提示错误: * `Could not create directory '/.ssh'.` * 或者 * `Host key verification failed.` * */ // shell_exec函数默认是禁止的,无法使用的话需要进php.ini修改相关配置 //执行shell时,没有sudo仿佛会执行不成功,只执行一小段,加了sudo之后执行成功,可以为运行php的用户添加sudo权限,参考资料有相关问题 //git reset 重置服务器修改为最新版本(防止修改了服务器文件,然后拉取的时候报错) //git pull 项目拉取 echo shell_exec("cd {$local} && git reset --hard && git pull");
三.Git使用ssh链接仓库的时候的配置
1.创建秘钥(注:使用www用户创建 ,防止执行的时候没有权限)
sudo -u www ssh-keygen -t rsa //根据提示进行对应的ssh配置
2.如果改用户下有多个ssh文件 一定要修改 ~/.ssh/config 否则在ssh链接的时候 默认会使用id_rsa中的秘钥 这样会导致链接验证失败
//~/.ssh/config 设置如下 host gitee.com //ssh链接的服务器 IdentityFile ~/.ssh/ssh_demo //使用的对应的秘钥
转载请注明:cooljun小窝 » git使用webhooks做自动部署