前端整理學習的技術點有很多,個人喜歡以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
即可
配置腳本
我們在代碼倉庫中新增一個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中成功觸發的信息,可以詳情,也可以手動再次觸發:
下圖是個人筆記站點上的內容,有代碼提交就能直接同步到: