使用gitbook和hooks搭建自动更新的博客笔记

2020-03-18 本文已影响0人 tangyefei

前端整理学习的技术点有很多，个人喜欢以markdown笔记的形式记录，方便查阅。

本篇就介绍/记录下应用gitbook、nodejs、github hooks在服务器配置能自动同步的学习笔记。

具体涉及的点包括：

介绍gitbook的简单使用
在服务器上配置静态资源站点
配置github hooks
配置hooks所需的脚本

gitbook的介绍

gitbook 是一个写作工具，我们通过安装它的命令行工具 gitbook-cli 可以方便地将markdown文件生成静态html。

安装后如下几个命令基本可以满足需求：

gitbook init: 在当前文件夹初始book，包含_book文件夹用于输出html，SUMMARY.md代表了入口
gitbook serve: 会在本地启动一个web服务器，修改了目录下的文件会自动触发刷新
gitbook build: 将markdown文件生成html后打包到_book

书写好的markdown文件，经过gitbook serve或gitbook build后，就可以提交到在github新建的仓库了，比如：https://github.com/tangyefei/courses。

服务器配置

在自己的服务器上安装git，并拉取项目；然后安装nginx，将指定访问地址指向到自己的clone的项目文件夹下的_book即可访问（nginx会默认去该文件夹下找index.html文件）。

github hooks

github hooks简单来说就是Github提供钩子，能根据你的一些动作，来做一些响应。

这个"动作"可能是你向仓库push了代码，这里"响应"是Github会自动发送一个可访问的公网请求。

我们要做的就是，将这个公网请求的地址作为接口地址在服务器上实现，让它能在接收到Github发送的请求后，在服务器上进行代码同步操作。在Github上，打开项目的Setting界面，定位的hooks的栏目，单击新增按钮，需要配置的参数有三个：

Payload URL: 请求地址比如 http://mysite.org:8081
Secret: 请求密码，可以设置一个密码，用于服务器校验
Content type: 请求类型，考虑后面要用node.js的createServer进行处理，就选择application/json即可

hook add

配置脚本

我们在代码仓库中新增一个github-hooks.js，并提交并同步到服务器上，内容如下：

let crypto = require('crypto');
let secret = "THIS-IS-YOUR-SECRET";
let repo = "/home/courses";
let http = require('http');
let exec = require('child_process').exec;
let port = '8081';

function getSignature(buf) {
    var hmac = crypto.createHmac("sha1", secret);
    hmac.update(buf, "utf-8");
    return "sha1=" + hmac.digest("hex");
  }
  
function verifyRequest(req, res, buf) {
   // github基于密码发送的签名
    var expected = req.headers['x-hub-signature'];
   // 本地根据密码计算的签名
    var calculated = getSignature(buf);
    console.log("X-Hub-Signature:", expected, "Content:", "-" + buf.toString('utf8') + "-");
    // TODO the compare always not pass
    if (expected !== calculated) {
      console.error("Invalid signature.");
    //   throw new Error('wrong signature')
    } else {
      console.log("Valid signature!");
    }
}

http.createServer(function (req, res) {
   console.log('sync repo reach...');
   // 只要有请求进入，就会执行到此处
    req.on('data', function(chunk) {
       // POST类型的请求会到此处
        try {
            verifyRequest(req, res, chunk)
            exec('cd ' + repo + ' && git pull');
        } catch(e) {
            console.error(e)
        }
    });
    res.end();
}).listen(port);

我们可以通过node github-hooks.js 启动它，虽然它接收POST请求才能正常处理，但先确保在浏览器上访问 http://mysite.org:8081/ 能返回200状态（表示请求有效）。

下一步就可以在验证钩子是否生效，通过在个人电脑上提交代码，然后查看服务器上命令行中是否有 sync repo reach...的输出。

麻烦的是，我们需要在命令行执行Ctrl+C退出启动的github-hooks.js，然后去查看文件是否更新，或者手动重启下nginx。

forever后台运行脚本

为了在服务器上后台运行github-hooks.js，我们需要通过npm安装forever，然后通过命令后台启动：

$ npm install forever -g
$ nohup forever start github-hooks.js &

注：forever启动命令执行完成后，回车后可以回退到命令行继续操作。如果发现启动的服务Exit 了，需要检查是否拼写错误，比如 start github-hooks.js 写成了 start github-hooks；只有发现回车后，服务状态Done的状态才算启动成功。

当然也可以 forever list 查看启动的服务，它会列出服务相关的列参数（包括id）；可以使用forever kill id 来关闭服务。

使用自动更新提交自动触发

在个人电脑上书写的目录中，gitbook serve可以启动web服务器后，可以书写完成的时候用git命令提交。

代码提交后，就能在服务器上看到自己书写的最新的内容。

下图是Github Hooks中成功触发的信息，可以详情，也可以手动再次触发：

delivery history

下图是个人笔记站点上的内容，有代码提交就能直接同步到：

course home