jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Part 1: First fourth content unordered lists from dash to asterisk (#51094)

Browse Source
This commit is contained in:
Grace Park
2024-06-13 10:39:07 -07:00
committed by GitHub
parent ef824b1e7e
commit 0b94935b77
738 changed files with 6267 additions and 6267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/authentication/connecting-to-github-with-ssh/about-ssh.md
View File

@@ -38,4 +38,4 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can provi
## Further reading
- "[AUTOTITLE](/authentication/troubleshooting-ssh)"
* "[AUTOTITLE](/authentication/troubleshooting-ssh)"

2
content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md
View File

@@ -84,5 +84,5 @@ gh ssh-key add ~/.ssh/id_ed25519.pub --type signing
## Further reading
- "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)"
* "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)"
{% endif %}

10
content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md
View File

@@ -35,9 +35,9 @@ Before you generate a new SSH key, you should check your local machine for 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.
- _id_rsa.pub_
- _id_ecdsa.pub_
- _id_ed25519.pub_
* _id_rsa.pub_
* _id_ecdsa.pub_
* _id_ed25519.pub_
{% tip %}
@@ -46,7 +46,7 @@ Before you generate a new SSH key, you should check your local machine for exist
{% endtip %}
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 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.
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)."

10
content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md
View File

@@ -104,20 +104,20 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
1. If you're using macOS Sierra 10.12.2 or later, you will need to modify your `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
- First, check to see if your `~/.ssh/config` file exists in the default location.
* First, check to see if your `~/.ssh/config` file exists in the default location.
```shell
$ open ~/.ssh/config
> The file /Users/YOU/.ssh/config does not exist.
```
- If the file doesn't exist, create the file.
* If the file doesn't exist, create the file.
```shell
touch ~/.ssh/config
```
- Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup.
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup.
```text copy
Host {% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %}
@@ -130,9 +130,9 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
**Notes:**
- If you chose not to add a passphrase to your key, you should omit the `UseKeychain` line.
* If you chose not to add a passphrase to your key, you should omit the `UseKeychain` line.
- If you see a `Bad configuration option: usekeychain` error, add an additional line to the configuration's' `Host *.{% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %}` section.
* If you see a `Bad configuration option: usekeychain` error, add an additional line to the configuration's' `Host *.{% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %}` section.
```text copy
Host {% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %}

66
content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md
View File

@@ -25,14 +25,14 @@ In many cases, especially in the beginning of a project, SSH agent forwarding is
### Pros of SSH agent forwarding
- You do not have to generate or keep track of any new keys.
- There is no key management; users have the same permissions on the server that they do locally.
- No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys.
* You do not have to generate or keep track of any new keys.
* There is no key management; users have the same permissions on the server that they do locally.
* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys.
### Cons of SSH agent forwarding
- Users **must** SSH in to deploy; automated deploy processes can't be used.
- SSH agent forwarding can be troublesome to run for Windows users.
* Users **must** SSH in to deploy; automated deploy processes can't be used.
* SSH agent forwarding can be troublesome to run for Windows users.
### Set up SSH agent forwarding
@@ -46,18 +46,18 @@ If you don't want to use SSH keys, you can use HTTPS with OAuth tokens.
### Pros of HTTPS cloning with OAuth tokens
- Anyone with access to the server can deploy the repository.
- Users don't have to change their local SSH settings.
- Multiple tokens (one for each user) are not needed; one token per server is enough.
- A token can be revoked at any time, turning it essentially into a one-use password.
* Anyone with access to the server can deploy the repository.
* Users don't have to change their local SSH settings.
* Multiple tokens (one for each user) are not needed; one token per server is enough.
* A token can be revoked at any time, turning it essentially into a one-use password.
{% ifversion ghes %}
- Generating new tokens can be easily scripted using [the OAuth API](/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization).
* Generating new tokens can be easily scripted using [the OAuth API](/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization).
{% endif %}
### Cons of HTTPS cloning with OAuth tokens
- You must make sure that you configure your token with the correct access scopes.
- Tokens are essentially passwords, and must be protected the same way.
* You must make sure that you configure your token with the correct access scopes.
* Tokens are essentially passwords, and must be protected the same way.
### Set up HTTPS cloning with OAuth tokens
@@ -71,15 +71,15 @@ See [our guide on creating a {% data variables.product.pat_generic %}](/authenti
### Pros of deploy keys
- Anyone with access to the repository and server has the ability to deploy the project.
- Users don't have to change their local SSH settings.
- Deploy keys are read-only by default, but you can give them write access when adding them to a repository.
* Anyone with access to the repository and server has the ability to deploy the project.
* Users don't have to change their local SSH settings.
* Deploy keys are read-only by default, but you can give them write access when adding them to a repository.
### Cons of deploy keys
- Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server.
- Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised.
- If the user who created the deploy key is removed from the repository, the deploy key will still be active as it isn't tied to the specific user, but rather to the repository.
* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server.
* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised.
* If the user who created the deploy key is removed from the repository, the deploy key will still be active as it isn't tied to the specific user, but rather to the repository.
### Set up deploy keys
@@ -111,9 +111,9 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif
IdentityFile=/home/user/.ssh/repo-1_deploy_key
```
- `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias.
- `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias.
- `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias.
* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias.
* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias.
* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias.
You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example:
@@ -129,15 +129,15 @@ Since {% data variables.product.prodname_github_apps %} are a first class actor
### Pros of installation access tokens
- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API).
- Dedicated rate limits that grow with your organization.
- Decoupled from {% data variables.product.prodname_dotcom %} user identities, so they do not consume any licensed seats.
- Never granted a password, so cannot be directly signed in to.
* Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API).
* Dedicated rate limits that grow with your organization.
* Decoupled from {% data variables.product.prodname_dotcom %} user identities, so they do not consume any licensed seats.
* Never granted a password, so cannot be directly signed in to.
### Cons of installation access tokens
- Additional setup is needed to create the {% data variables.product.prodname_github_app %}.
- Installation access tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code.
* Additional setup is needed to create the {% data variables.product.prodname_github_app %}.
* Installation access tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code.
### Set up installation access tokens
@@ -173,14 +173,14 @@ This means that you cannot automate the creation of accounts. But if you want to
### Pros of machine users
- Anyone with access to the repository and server has the ability to deploy the project.
- No (human) users need to change their local SSH settings.
- Multiple keys are not needed; one per server is adequate.
* Anyone with access to the repository and server has the ability to deploy the project.
* No (human) users need to change their local SSH settings.
* Multiple keys are not needed; one per server is adequate.
### Cons of machine users
- Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access.
- Machine user keys, like deploy keys, are usually not protected by a passphrase.
* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access.
* Machine user keys, like deploy keys, are usually not protected by a passphrase.
### Set up machine users
@@ -196,4 +196,4 @@ This means that you cannot automate the creation of accounts. But if you want to
## Further reading
- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options)
* [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options)

6
content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md
View File

@@ -15,9 +15,9 @@ shortTitle: Test your SSH connection
---
Before testing your SSH connection, you should have already:
- [Checked for existing SSH keys](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)
- [Generated a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
- [Added a new SSH key to your GitHub account](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
* [Checked for existing SSH keys](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)
* [Generated a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
* [Added a new SSH key to your GitHub account](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
You'll need to authenticate this action using your password, which is the SSH key passphrase you created earlier. See "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases)."

4
content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md
View File

@@ -96,8 +96,8 @@ The `ssh-agent` process will continue to run until you log out, shut down your c
On Mac OS X Leopard through OS X El Capitan, these default private key files are handled automatically:
- _.ssh/id_rsa_
- _.ssh/identity_
* _.ssh/id_rsa_
* _.ssh/identity_
The first time you use your key, you will be prompted to enter your passphrase. If you choose to save the passphrase with your keychain, you won't have to enter it again.