Zenn
🛟

GitHubにSSH接続する方法

2024/01/14に公開
GitHub
SSH
tech

はじめに

何番煎じだという感じですが、GitHubにSSH接続する方法を自分の備忘録も兼ねて書きます。

SSHとは？という詳細な解説はせずに、とりあえず公開鍵・秘密鍵を生成してGitHubにSSH接続する手順となります。

🧞‍♂️記事を読むうえでのお願い

初心者向けになるべく分かりやすいように記載したつもりですが、ご不明点などありましたら追記・修正していきますのでお気軽にコメントください💁
また、私自身もまだまだエンジニアとしての経験が浅く、一部おかしな記述があるかもしれません。
そのためもし間違いなどがありましたらご指摘いただけると幸いです。よろしくお願いします🙏

1. 公開鍵・秘密鍵を生成する

ターミナルで以下コマンドを実行すると公開鍵・秘密鍵を作成できます。

ターミナル
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
  • -b 4096：生成されるキーのビット長を4096ビットに指定するオプション。ビット長は自分で自由に設定可能。
  • -C "your_email@example.com"：メールアドレスはGitHubに登録されているものを使用してください。

上記を入力すると、以下のようにファイルパスを入力してくださいと表示されるため、必要に応じてファイルパスを入力します。

$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

Generating public/private rsa key pair.
Enter file in which to save the key (/Users/自身のユーザー名/.ssh/id_rsa):
  • 何も入力しない場合にはデフォルトの~/.ssh/id_rsaというパスで生成されます。

2. １で生成した公開鍵をコピーする

以下コマンドを実行して、１で生成した公開鍵の中身をターミナル上に表示します。

ターミナル
cat ~/.ssh/id_rsa.pub
  • id_rsaとid_rsa.pubというファイルが存在していると思いますが、.pubの方が公開鍵になります。

表示された公開鍵の中身をコピーします。

コピーする部分は、先頭から末尾のメールアドレスの前の「==」の部分までをコピーしてください。

3. GitHubアカウントのSSHキーを設定する

ご自身のGitHubアカウントを開いていただき、以下の順に遷移してください。

右上のアイコンボタン→「settings」→「SSH and GPG keys」→「New SSH key」

GitHub画面イメージ1

遷移した画面にて、「Title」と「Key」を入力します。

  • Title：任意の値を入力
  • Key：２でコピーした公開鍵の値を入力
    「Add SSH key」ボタンをクリックして入力内容を保存します。

GitHub画面イメージ2

4. 上記で設定したSSHが正しく設定されているか確認

以下コマンドを実行して確認します。

$ ssh -T git@github.com

Hi （自身のユーザー名）! You've successfully authenticated, but GitHub does not provide shell access.
  • 上記Hi以下の文章が表示されていれば問題なく、SSH接続が完了しています！

お疲れ様でした！
以上でGitHubのSSH接続の設定は完了です！

おわりに

簡単ではありますが、GihHubへのSSH接続の方法を解説いたしました。

この記事に関連するものとして、一台のPCで複数のGitHubアカウントをSSH接続管理する方法という記事も書いているので、一台のPCで複数のGitHubアカウントをSSH接続するにはどうしたらいいんだ？？という方はぜひこちらの記事も参考にしてください！

最後までお読みいただきありがとうございました！

Discussion