Skip to main content

新增 SSH 密钥到 GitHub 帐户

要在 您的 GitHub Enterprise Server 实例 上配置帐户以使用新的(或现有的)SSH 密钥,还需要将密钥添加到帐户。

About addition of SSH keys to your account

You can access and write data in repositories on 您的 GitHub Enterprise Server 实例 using SSH (Secure Shell Protocol). When you connect via SSH, you authenticate using a private key file on your local machine. 更多信息请参阅“关于 SSH”。

After you generate an SSH key pair, you must add the public key to 您的 GitHub Enterprise Server 实例 to enable SSH access for your account.

基本要求

Before adding a new SSH key to your account on 您的 GitHub Enterprise Server 实例, complete the following steps.

  1. Check for existing SSH keys. 更多信息请参阅“检查现有 SSH 密钥”。
  2. Generate a new SSH key and add it to your machine's SSH agent. 更多信息请参阅“生成新的 SSH 密钥并添加到 ssh-agent”。

Adding a new SSH key to your account

在向您在 您的 GitHub Enterprise Server 实例 上的帐户添加新 SSH 密钥后,您可以重新配置任何本地存储库以使用 SSH。 更多信息请参阅“将远程 URL 从 HTTPS 转换为 SSH”。

  1. 将 SSH 公钥复制到剪贴板。

    如果您的 SSH 公钥文件与示例代码不同,请修改文件名以匹配您当前的设置。 在复制密钥时,请勿添加任何新行或空格。

    $ pbcopy < ~/.ssh/id_ed25519.pub
    # Copies the contents of the id_ed25519.pub file to your clipboard

    提示:如果 pbcopy 不可用,可找到隐藏的 .ssh 文件夹,在常用的文本编辑器中打开该文件,并将其复制到剪贴板。

  2. 在任何页面的右上角,单击您的个人资料照片,然后单击 Settings(设置)

    用户栏中的 Settings 图标

  3. 在边栏的“Access(访问)”部分中,单击 SSH 和 GPG 密钥

  4. 单击 New SSH key(新 SSH 密钥)Add SSH key(添加 SSH 密钥)SSH 密钥按钮

  5. 在 "Title"(标题)字段中,为新密钥添加描述性标签。 例如,如果您使用的是个人 Mac,此密钥名称可能是 "Personal MacBook Air"。

  6. 将密钥粘贴到 "Key"(密钥)字段。 密钥字段

  7. 单击 Add SSH key(添加 SSH 密钥)添加密钥按钮

  8. If prompted, confirm access to your account on GitHub Enterprise Server. For more information, see "Sudo mode."

  1. 将 SSH 公钥复制到剪贴板。

    如果您的 SSH 公钥文件与示例代码不同,请修改文件名以匹配您当前的设置。 在复制密钥时,请勿添加任何新行或空格。

    $ clip < ~/.ssh/id_ed25519.pub
    # Copies the contents of the id_ed25519.pub file to your clipboard

    提示:如果 clip 不可用,可找到隐藏的 .ssh 文件夹,在常用的文本编辑器中打开该文件,并将其复制到剪贴板。

  2. 在任何页面的右上角,单击您的个人资料照片,然后单击 Settings(设置)

    用户栏中的 Settings 图标

  3. 在边栏的“Access(访问)”部分中,单击 SSH 和 GPG 密钥

  4. 单击 New SSH key(新 SSH 密钥)Add SSH key(添加 SSH 密钥)SSH 密钥按钮

  5. 在 "Title"(标题)字段中,为新密钥添加描述性标签。 例如,如果您使用的是个人 Mac,此密钥名称可能是 "Personal MacBook Air"。

  6. 将密钥粘贴到 "Key"(密钥)字段。 密钥字段

  7. 单击 Add SSH key(添加 SSH 密钥)添加密钥按钮

  8. If prompted, confirm access to your account on GitHub Enterprise Server. For more information, see "Sudo mode."

  1. 将 SSH 公钥复制到剪贴板。

    如果您的 SSH 公钥文件与示例代码不同,请修改文件名以匹配您当前的设置。 在复制密钥时,请勿添加任何新行或空格。

    $ cat ~/.ssh/id_ed25519.pub
    # Then select and copy the contents of the id_ed25519.pub file
    # displayed in the terminal to your clipboard

    提示:或者,您也可以找到隐藏的 .ssh 文件夹,在常用的文本编辑器中打开该文件,并将其复制到剪贴板。

  2. 在任何页面的右上角,单击您的个人资料照片,然后单击 Settings(设置)

    用户栏中的 Settings 图标

  3. 在边栏的“Access(访问)”部分中,单击 SSH 和 GPG 密钥

  4. 单击 New SSH key(新 SSH 密钥)Add SSH key(添加 SSH 密钥)SSH 密钥按钮

  5. 在 "Title"(标题)字段中,为新密钥添加描述性标签。 例如,如果您使用的是个人 Mac,此密钥名称可能是 "Personal MacBook Air"。

  6. 将密钥粘贴到 "Key"(密钥)字段。 密钥字段

  7. 单击 Add SSH key(添加 SSH 密钥)添加密钥按钮

  8. If prompted, confirm access to your account on GitHub Enterprise Server. For more information, see "Sudo mode."

要了解有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。

在使用 GitHub CLI 将 SSH 密钥添加到帐户之前,必须向 GitHub CLI 进行身份验证。 更多信息请参阅 GitHub CLI 文档中的 gh auth login

要将 SSH 密钥添加到您的 GitHub 帐户,请使用 ssh-key add 子命令,指定您公钥。

gh ssh-key add key-file

要包括新密钥的标题,请使用 -t--title 标记。

gh ssh-key add key-file --title "personal laptop"

如果按照“生成新的 SSH 密钥”中的说明生成了 SSH 密钥,则可以使用此命令将密钥添加到您的帐户。

gh ssh-key add ~/.ssh/id_ed25519.pub