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

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

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

具体涉及的点包括:

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

gitbook的介绍

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

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

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

书写好的markdown文件,经过gitbook servegitbook 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.jscreateServer进行处理,就选择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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容