GitHubのDeploy keyを設定してサーバーからSSHでgit pullする
GitHubで管理しているコードを、サーバー上から直接 git clone / git pull するための設定手順。
Deploy keyとは
Deploy key(デプロイキー)は、GitHubの特定のリポジトリにSSHでアクセスするための認証鍵。
- リポジトリ単位でアクセス権限を設定
- デフォルトは読み取り専用
- GitHubアカウント全体へのアクセス権限は不要
- 1つのDeploy keyは原則1リポジトリ専用
複数のリポジトリで同じ鍵を使い回すことはできず、Key is already in use というエラーが出ることがある。
今回はサーバーからコードを取得するだけなので、読み取り専用で設定する。
サーバー上でSSH鍵を生成
SSHでサーバーにログインし、デプロイ専用の鍵を生成。
mkdir -p ~/.ssh
chmod 700 ~/.ssh
ssh-keygen -t ed25519 -C "deploy-key@github" -f ~/.ssh/id_ed25519_repo_deploy -N ""
主なオプション:
-t ed25519: 鍵の種類-C: 識別用コメント-f: 鍵の保存先-N "": パスフレーズなし
生成されるファイル:
~/.ssh/id_ed25519_repo_deploy # 秘密鍵
~/.ssh/id_ed25519_repo_deploy.pub # 公開鍵
※パスフレーズなしの秘密鍵が漏洩すると、対象リポジトリへの不正アクセスを許すおそれがある。読み取り専用で運用し、秘密鍵の管理に注意する。
公開鍵をGitHubに登録
公開鍵を表示。
cat ~/.ssh/id_ed25519_repo_deploy.pub
表示された内容をコピーし、GitHubの対象リポジトリで以下を開く。
Settings → Deploy keys → Add deploy key
- Title:任意の識別名
- Key:コピーした公開鍵
- Allow write access:チェックしない
「Add key」で登録。
※登録するのは .pub の公開鍵。秘密鍵は登録しない。
SSH接続設定(~/.ssh/config)
使用する秘密鍵を指定するため、SSHの接続設定を追加。
cat << 'EOF' >> ~/.ssh/config
Host github-repo
HostName github.com
User git
IdentityFile ~/.ssh/id_ed25519_repo_deploy
IdentitiesOnly yes
EOF
github-repoは任意の接続名。複数リポジトリを扱う場合は、リポジトリごとに別の鍵とHost設定を用意する。
ファイルのパーミッションも設定。
chmod 600 ~/.ssh/config
chmod 600 ~/.ssh/id_ed25519_repo_deploy
git clone
SSH設定で指定したHost名を使ってcloneする。
git clone git@github-repo:username/repo.git
username/repo は対象リポジトリに置き換える。
通常のSSH URLの github.com 部分を、設定した github-repo に変更することで、指定の秘密鍵が使用される。
以降は対象ディレクトリでpullするだけ。
.gitディレクトリへの外部アクセスを遮断
Web公開領域内にリポジトリを配置する場合、.git ディレクトリが外部から参照できないようにしておく。
Apacheで .htaccess が利用できる環境でのアクセス遮断設定の例。
RedirectMatch 404 (^|/)\.git(/|$)
リポジトリのルートに .htaccess を配置する場合は、cloneする前にアクセス制限を準備しておく。
設定後は、ブラウザやcurlなどで .git/config にアクセスし、内容が取得できないことを確認する。
可能であれば、Gitの管理情報をWeb公開領域の外に置く構成が望ましい。