HugoサイトをGihubリポジトリからオンプレへデプロイする
目次
概要
fono09/hugo-deploy-on-premises: Githubに置いたHugoをオンプレにデプロイしてくれるやつ
こいつを作って、設定して、この記事を自動デプロイした。
どうして
このサイトをより手軽に更新したかった。要するに、更新時には毎回サーバーに入って毎回git pull、hugoを打つのは面倒。
また、 自宅サーバーでhugo server記事をプレビューしながら書くときに、VPNで自宅に繋いだ手元端末からプレビューが見れるよう、わざとバインドアドレスを設定しなければならない。
e.g.hugo server -D --bind 192.168.0.222
解決法
実際の動きを以下のシーケンス図で示す。
要するにGithubのWebhookでgit pullしてhugo動かして
workstation: 手元端末Github: 謎の設計図共有サイトnginx: 謎のウェブサイト高速配信システムdeploy: 今回作ったやつhugo: 謎のウェブサイト高速生成システム
sequenceDiagram
participant workstation
participant Github
participant nginx
participant deploy
participant hugo
workstation->>Github: git push
Github-->workstation: pushed
Github->>nginx: HTTP Post(Webhook)
nginx->>deploy: HTTP Post(Webhook)
deploy->>Github: git pull
Github-->deploy: contents
deploy->>Github: git submodule update --init --recursive
Github-->deploy: submodules(theme)
deploy->>hugo: render
hugo-->deploy: rendered
workstation->>nginx: HTTP Get
nginx-->workstation: contents
これでリモートからpushしても自動でデプロイされます。
ハマりポイント
Githubの多要素認証でもデプロイしたい
当初は専用の秘密鍵を預けてsshでやるつもりだったが、パーミッション諸々で設計が汚くなったのでやめた。 以下のドキュメントにしたがって発行できるGithubのPersonal Access Tokenを使う。
コマンドライン用の個人アクセストークンを作成する - GitHub ヘルプ
ワーキングディレクトリでhugo打ってクリーンアップするとpublicも一緒に消える
CI/CDでよくあるArtifactsと同じ発想で1階層上に吐き出すようにした。
下記のコマンドで解決。
hugo -d ../public