Remove product_name from authentication directory (#53993)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: About SSH
|
||||
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and {% data variables.product.pat_generic %} at each visit. You can also use an SSH key to sign commits.'
|
||||
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.github %} without supplying your username and {% data variables.product.pat_generic %} at each visit. You can also use an SSH key to sign commits.'
|
||||
redirect_from:
|
||||
- /articles/about-ssh
|
||||
- /github/authenticating-to-github/about-ssh
|
||||
@@ -15,7 +15,7 @@ topics:
|
||||
|
||||
{% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia.
|
||||
|
||||
When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate or sign commits. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent), [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) and [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification).
|
||||
When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.github %} before you use the key to authenticate or sign commits. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent), [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) and [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification).
|
||||
|
||||
You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases).
|
||||
|
||||
@@ -28,7 +28,7 @@ If you haven't used your SSH key for a year, then {% data variables.product.prod
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.product_name %}. If you're using an SSH certificate, you cannot use the certificate to access forks of the organization's repositories, if the fork is owned by your personal account. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities) in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.github %}. If you're using an SSH certificate, you cannot use the certificate to access forks of the organization's repositories, if the fork is owned by your personal account. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities) in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
|
||||
{% else ghec or ghes %}
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
@@ -34,7 +34,7 @@ Before you generate a new SSH key, you should check your local machine for exist
|
||||
# Lists the files in your .ssh directory, if they exist
|
||||
```
|
||||
|
||||
1. Check the directory listing to see if you already have a public SSH key. By default, the filenames of supported public keys for {% data variables.product.product_name %} are one of the following.
|
||||
1. Check the directory listing to see if you already have a public SSH key. By default, the filenames of supported public keys for {% data variables.product.github %} are one of the following.
|
||||
* _id_rsa.pub_
|
||||
* _id_ecdsa.pub_
|
||||
* _id_ed25519.pub_
|
||||
@@ -44,6 +44,6 @@ Before you generate a new SSH key, you should check your local machine for exist
|
||||
|
||||
1. Either generate a new SSH key or upload an existing key.
|
||||
* If you don't have a supported public and private key pair, or don't wish to use any that are available, generate a new SSH key.
|
||||
* If you see an existing public and private key pair listed (for example, _id_rsa.pub_ and _id_rsa_) that you would like to use to connect to {% data variables.product.product_name %}, you can add the key to the ssh-agent.
|
||||
* If you see an existing public and private key pair listed (for example, _id_rsa.pub_ and _id_rsa_) that you would like to use to connect to {% data variables.product.github %}, you can add the key to the ssh-agent.
|
||||
|
||||
For more information about generation of a new SSH key or addition of an existing key to the ssh-agent, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
|
||||
|
||||
@@ -24,7 +24,7 @@ When you generate an SSH key, you can add a passphrase to further secure the key
|
||||
|
||||
If you don't already have an SSH key, you must generate a new SSH key to use for authentication. If you're unsure whether you already have an SSH key, you can check for existing keys. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).
|
||||
|
||||
If you want to use a hardware security key to authenticate to {% data variables.product.product_name %}, you must generate a new SSH key for your hardware security key. You must connect your hardware security key to your computer when you authenticate with the key pair. For more information, see the [OpenSSH 8.2 release notes](https://www.openssh.com/txt/release-8.2).
|
||||
If you want to use a hardware security key to authenticate to {% data variables.product.github %}, you must generate a new SSH key for your hardware security key. You must connect your hardware security key to your computer when you authenticate with the key pair. For more information, see the [OpenSSH 8.2 release notes](https://www.openssh.com/txt/release-8.2).
|
||||
|
||||
## Generating a new SSH key
|
||||
|
||||
@@ -39,7 +39,7 @@ If you are a site administrator for {% data variables.location.product_location_
|
||||
{% data reusables.ssh.key-type-support %}
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Paste the text below, replacing the email used in the example with your {% data variables.product.product_name %} email address.
|
||||
1. Paste the text below, replacing the email used in the example with your {% data variables.product.github %} email address.
|
||||
|
||||
```shell
|
||||
ssh-keygen -t ed25519 -C "your_email@example.com"
|
||||
@@ -188,7 +188,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta
|
||||
1. Insert your hardware security key into your computer.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
|
||||
1. Paste the text below, replacing the email address in the example with the email address associated with your account on {% data variables.product.product_name %}.
|
||||
1. Paste the text below, replacing the email address in the example with the email address associated with your {% data variables.product.github %} account.
|
||||
|
||||
{% mac %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Connecting to GitHub with SSH
|
||||
intro: 'You can connect to {% data variables.product.product_name %} using the Secure Shell Protocol (SSH), which provides a secure channel over an unsecured network.'
|
||||
intro: 'You can connect to {% data variables.product.github %} using the Secure Shell Protocol (SSH), which provides a secure channel over an unsecured network.'
|
||||
redirect_from:
|
||||
- /key-setup-redirect
|
||||
- /linux-key-setup
|
||||
|
||||
@@ -133,7 +133,7 @@ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com
|
||||
|
||||
If your server needs to access repositories across one or more organizations, you can use a {% data variables.product.prodname_github_app %} to define the access you need, and then generate _tightly-scoped_, installation access tokens from that {% data variables.product.prodname_github_app %}. The installation access tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents.
|
||||
|
||||
Since {% data variables.product.prodname_github_apps %} are a first class actor on {% data variables.product.product_name %}, the installation access tokens are decoupled from any {% data variables.product.prodname_dotcom %} user, which makes them comparable to "service tokens". Additionally, installation access tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/apps/creating-github-apps/setting-up-a-github-app/rate-limits-for-github-apps).
|
||||
Since {% data variables.product.prodname_github_apps %} are a first class actor on {% data variables.product.github %}, the installation access tokens are decoupled from any {% data variables.product.github %} user, which makes them comparable to "service tokens". Additionally, installation access tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/apps/creating-github-apps/setting-up-a-github-app/rate-limits-for-github-apps).
|
||||
|
||||
### Pros of installation access tokens
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ You'll need to authenticate this action using your password, which is the SSH ke
|
||||
|
||||
```shell copy
|
||||
ssh -T git@{% data variables.product.product_url %}
|
||||
# Attempts to ssh to {% data variables.product.product_name %}
|
||||
# Attempts to ssh to {% data variables.product.github %}
|
||||
```
|
||||
|
||||
You may see a warning like this:
|
||||
|
||||
@@ -19,7 +19,7 @@ shortTitle: SSH agent forwarding
|
||||
|
||||
SSH agent forwarding can be used to make deploying to a server simple. It allows you to use your local SSH keys instead of leaving keys (without passphrases!) sitting on your server.
|
||||
|
||||
If you've already set up an SSH key to interact with {% data variables.product.product_name %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer.
|
||||
If you've already set up an SSH key to interact with {% data variables.product.github %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer.
|
||||
|
||||
Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explanation of SSH agent forwarding.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user