使用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閱讀 230,825評論 6 546
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,814評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,980評論 0 384
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 64,064評論 1 319
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,779評論 6 414
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,109評論 1 330
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,099評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,287評論 0 291
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,799評論 1 338
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,515評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,750評論 1 375
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,221評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,933評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,327評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,667評論 1 296
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,492評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,703評論 2 380

推薦閱讀更多精彩內容