Git WebHook

一個使用 Python Flask + SQLAchemy + Celery + Redis + React 開發(fā)的用于迅速搭建并使用 WebHook 進(jìn)行自動化部署和運(yùn)維系統(tǒng)，支持：Github / GitLab / GitOsc。

• 技術(shù)棧簡單，部署容易;
• 代碼簡潔易懂，二次開發(fā)毫無壓力;
• 支持 Github / GitLab / GitOsc;
• 使用 SSH 方式，支持多服務(wù)配置;

Online DEMO Website: http://webhook.hust.cc/，使用 gunicorn + gevent + ngxin 部署。

一、如何使用 ?

1.下載本項目代碼：

git clone git@github.com:NetEaseGame/git-webhook.git 

2.安裝 Python 依賴

pip install -r requirements.txt 

3.配置 config.py 拷貝一份 config_example.py 到同目錄 config.py， 然后對應(yīng)修改配置內(nèi)容。主要需要配置三點(diǎn)：

• DATABASE_URI: 數(shù)據(jù)庫地址，理論上可以使用任何關(guān)系數(shù)據(jù)庫;推薦使用 sqlite 和 mysql (經(jīng)過測試);
• CELERY REDIS: Redis URI 配置，主要用于 Celery 后臺任務(wù);
• GITHUB: GitHub 登陸配置，可以到 OAuth applications 自行申請，登陸 Callback 地址為： your_domain/github/callback.

4.初始化數(shù)據(jù)庫結(jié)構(gòu)

python scripts.py build_db 

5.運(yùn)行應(yīng)用

python run_webhook.py 

運(yùn)行之后，打開 http://127.0.0.1:18340 即可訪問。使用 GitHub 賬號登陸。

添加WebHook 在工具中添加 Git 項目，獲得 WebHook URL，并填寫到 Github / GitLab / OscGit 的 WebHook 配置中。

三、效果預(yù)覽

• 首頁

• WebHook列表

• 服務(wù)器列表

• WebHook 歷史記錄

四、部署

代碼使用 Flask 框架開發(fā)，線上部署使用 gunicorn + gevent + nginx 已經(jīng)是比較成熟的方案了，本應(yīng)用當(dāng)然也可以使用這種方式部署。

主要的服務(wù)器依賴環(huán)境：

• 數(shù)據(jù)庫環(huán)境(自行選擇，推薦 mysql 和 sqlite);
• Redis，利用 Celery 做后臺任務(wù);

五、貢獻(xiàn)

項目使用 SSH 私鑰的方式，直接登陸 Linux 服務(wù)器，執(zhí)行部署或者運(yùn)維的 Shell 命令，安全可靠，當(dāng)然因為涉及到私鑰，所以為了安全起見，建議在內(nèi)網(wǎng)搭建使用(這些是我們的使用情景)。

后端開發(fā)使用：Python Flask + SQLAchemy + Celery + Redis，常規(guī)的技術(shù)棧;

前端開發(fā)使用 React + Webpack，并沒有使用其他消息通信框架。

所以整體項目代碼非常簡單，大部分都能夠修改和更新代碼，并提交 Pull Request，目前系統(tǒng) TODO 包括，我個人也將注意完善：

• Celery 進(jìn)程情況顯示(當(dāng) Celery 進(jìn)程沒有執(zhí)行的時候，在頁面上提示，類似于 Sentry);
• 系統(tǒng)狀態(tài)和統(tǒng)計(任務(wù)隊列實時情況，WebHook 執(zhí)行的統(tǒng)計圖表);
• 發(fā)布為 pip 包，使得安裝部署更加容易;
• Document 使用文檔 & 幫助文檔;