jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 11:26:57 -05:00
Code Issues Projects Releases Wiki Activity

ran script/content-migrations/use-short-versions.js

Browse Source
This commit is contained in:
Sarah Schneider
2021-06-24 10:21:07 -04:00
parent 7de66fe4ef
commit cb12455649
1976 changed files with 6155 additions and 6133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md
View File

@@ -1,19 +1,19 @@
---
title: About authentication with SAML single sign-on
intro: 'You can access {% if currentVersion == "github-ae@latest" %}{% data variables.product.product_location %}{% elsif currentVersion == "free-pro-team@latest" %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% if currentVersion == "github-ae@latest" %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).{% if currentVersion == "free-pro-team@latest" %} After you authenticate with the IdP successfully from {% data variables.product.product_name %}, you must authorize any personal access token, SSH key, or {% data variables.product.prodname_oauth_app %} you would like to access the organization''s resources.{% endif %}'
intro: 'You can access {% ifversion ghae %}{% data variables.product.product_location %}{% elsif fpt %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% ifversion ghae %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).{% ifversion fpt %} After you authenticate with the IdP successfully from {% data variables.product.product_name %}, you must authorize any personal access token, SSH key, or {% data variables.product.prodname_oauth_app %} you would like to access the organization''s resources.{% endif %}'
product: '{% data reusables.gated-features.saml-sso %}'
redirect_from:
- /articles/about-authentication-with-saml-single-sign-on
- /github/authenticating-to-github/about-authentication-with-saml-single-sign-on
versions:
free-pro-team: '*'
github-ae: '*'
fpt: '*'
ghae: '*'
topics:
- SSO
---
## About authentication with SAML SSO
{% if currentVersion == "github-ae@latest" %}
{% ifversion ghae %}
SAML SSO allows an enterprise owner to centrally control and secure access to {% data variables.product.product_name %} from a SAML IdP. When you visit {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect you to your IdP to authenticate. After you successfully authenticate with an account on the IdP, the IdP redirects you back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access.
@@ -23,7 +23,7 @@ If you can't access {% data variables.product.product_name %}, contact your loca
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}.
@@ -51,5 +51,5 @@ After an enterprise or organization owner enables or enforces SAML SSO for an or
## Further reading
{% if currentVersion == "free-pro-team@latest" %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %}
{% if currentVersion == "github-ae@latest" %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %}
{% ifversion fpt %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %}
{% ifversion ghae %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %}

2
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md
View File

@@ -6,7 +6,7 @@ redirect_from:
- /articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on
- /github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on
versions:
free-pro-team: '*'
fpt: '*'
topics:
- SSO
---

2
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md
View File

@@ -6,7 +6,7 @@ redirect_from:
- /articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on
- /github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on
versions:
free-pro-team: '*'
fpt: '*'
topics:
- SSO
---

6
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/index.md
View File

@@ -1,13 +1,13 @@
---
title: Authenticating with SAML single sign-on
intro: 'You can authenticate to {% if currentVersion == "free-pro-team@latest" %}a {% data variables.product.product_name %} organization {% elsif currentVersion == "github-ae@latest" %}{% data variables.product.product_location %} {% endif %}with SAML single sign-on (SSO){% if currentVersion == "free-pro-team@latest" %} and view your active sessions{% endif %}.'
intro: 'You can authenticate to {% ifversion fpt %}a {% data variables.product.product_name %} organization {% elsif ghae %}{% data variables.product.product_location %} {% endif %}with SAML single sign-on (SSO){% ifversion fpt %} and view your active sessions{% endif %}.'
product: '{% data reusables.gated-features.saml-sso %}'
redirect_from:
- /articles/authenticating-to-a-github-organization-with-saml-single-sign-on/
- /articles/authenticating-with-saml-single-sign-on
versions:
free-pro-team: '*'
github-ae: '*'
fpt: '*'
ghae: '*'
topics:
- SSO
children:

2
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md
View File

@@ -5,7 +5,7 @@ redirect_from:
- /articles/viewing-and-managing-your-active-saml-sessions
- /github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions
versions:
free-pro-team: '*'
fpt: '*'
topics:
- SSO
---

10
content/github/authenticating-to-github/connecting-to-github-with-ssh/about-ssh.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/about-ssh
- /github/authenticating-to-github/about-ssh
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---
@@ -15,11 +15,11 @@ When you set up SSH, you will need to generate a new SSH key and add it to the s
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 "[Working with SSH key passphrases](/github/authenticating-to-github/working-with-ssh-key-passphrases)."
{% if currentVersion == "free-pro-team@latest" %}To use your SSH key with a repository owned by an organization that uses SAML single sign-on, you must authorize the key. For more information, see "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %}
{% ifversion fpt %}To use your SSH key with a repository owned by an organization that uses SAML single sign-on, you must authorize the key. For more information, see "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %}
To maintain account security, you can regularly review your SSH keys list and revoke any keys that are invalid or have been compromised. For more information, see "[Reviewing your SSH keys](/github/authenticating-to-github/reviewing-your-ssh-keys)."
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
If you haven't used your SSH key for a year, then {% data variables.product.prodname_dotcom %} will automatically delete your inactive SSH key as a security precaution. For more information, see "[Deleted or missing SSH keys](/articles/deleted-or-missing-ssh-keys)."
{% endif %}

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

@@ -5,9 +5,9 @@ redirect_from:
- /articles/adding-a-new-ssh-key-to-your-github-account
- /github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---
@@ -19,7 +19,7 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
{% data reusables.ssh.dsa-support %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% ifversion fpt or ghae or ghes %}
{% tip %}
**Tip**: You can also add an SSH key using the {% data variables.product.prodname_cli %}. For more information, see "[`gh ssh-key add`](https://cli.github.com/manual/gh_ssh-key_add)" in the {% data variables.product.prodname_cli %} documentation.
@@ -122,7 +122,7 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
{% endlinux %}
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Further reading
- "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)"

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

@@ -5,9 +5,9 @@ redirect_from:
- /articles/checking-for-existing-ssh-keys
- /github/authenticating-to-github/checking-for-existing-ssh-keys
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

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

@@ -7,9 +7,9 @@ redirect_from:
- /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
- /github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---
@@ -17,7 +17,7 @@ topics:
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 "[Checking for existing SSH keys](/github/authenticating-to-github/checking-for-existing-ssh-keys)."
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
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).
@@ -177,7 +177,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
{% endlinux %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.1" %}
{% ifversion fpt or ghae-next or ghes > 3.1 %}
## Generating a new SSH key for a hardware security key
If you are using macOS or Linux, you may need to update your SSH client or install a new SSH client prior to generating a new SSH key. For more information, see "[Error: Unknown key type](/github/authenticating-to-github/error-unknown-key-type)."
@@ -236,6 +236,6 @@ If you are using macOS or Linux, you may need to update your SSH client or insta
- "[About SSH](/articles/about-ssh)"
- "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)"
{%- if currentVersion == "free-pro-team@latest" %}
{%- ifversion fpt %}
- "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)"
{%- endif %}

6
content/github/authenticating-to-github/connecting-to-github-with-ssh/index.md
View File

@@ -11,9 +11,9 @@ redirect_from:
- /articles/generating-an-ssh-key/
- /articles/connecting-to-github-with-ssh
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
children:

8
content/github/authenticating-to-github/connecting-to-github-with-ssh/testing-your-ssh-connection.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/testing-your-ssh-connection
- /github/authenticating-to-github/testing-your-ssh-connection
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---
@@ -33,7 +33,7 @@ When you test your connection, you'll need to authenticate this action using you
> Are you sure you want to continue connecting (yes/no)?
```
3. Verify that the fingerprint in the message you see matches {% if currentVersion == "free-pro-team@latest" %}[{% data variables.product.prodname_dotcom %}'s RSA public key fingerprint](/github/authenticating-to-github/githubs-ssh-key-fingerprints){% else %} your enterprise's public key fingerprint{% endif %}. If it does, then type `yes`:
3. Verify that the fingerprint in the message you see matches {% ifversion fpt %}[{% data variables.product.prodname_dotcom %}'s RSA public key fingerprint](/github/authenticating-to-github/githubs-ssh-key-fingerprints){% else %} your enterprise's public key fingerprint{% endif %}. If it does, then type `yes`:
```shell
> Hi <em>username</em>! You've successfully authenticated, but GitHub does not
> provide shell access.

6
content/github/authenticating-to-github/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md
View File

@@ -7,9 +7,9 @@ redirect_from:
- /articles/working-with-ssh-key-passphrases
- /github/authenticating-to-github/working-with-ssh-key-passphrases
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

8
content/github/authenticating-to-github/index.md
View File

@@ -1,7 +1,7 @@
---
title: Authenticating to GitHub
shortTitle: Authentication
intro: 'Keep your account and data secure with features like {% if currentVersion != "github-ae@latest" %}two-factor authentication, {% endif %}SSH{% if currentVersion != "github-ae@latest" %},{% endif %} and commit signature verification.'
intro: 'Keep your account and data secure with features like {% ifversion not ghae %}two-factor authentication, {% endif %}SSH{% ifversion not ghae %},{% endif %} and commit signature verification.'
redirect_from:
- /categories/56/articles/
- /categories/ssh/
@@ -14,9 +14,9 @@ redirect_from:
- /categories/security/
- /categories/authenticating-to-github
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- 2FA
- Identity

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/about-anonymized-urls.md
View File

@@ -7,7 +7,7 @@ redirect_from:
- /authenticating-to-github/about-anonymized-image-urls
- /github/authenticating-to-github/about-anonymized-urls
versions:
free-pro-team: '*'
fpt: '*'
topics:
- Identity
- Access management

16
content/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github.md
View File

@@ -2,9 +2,9 @@
title: About authentication to GitHub
intro: 'You can securely access your account''s resources by authenticating to {% data variables.product.product_name %}, using different credentials depending on where you authenticate.'
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -13,17 +13,17 @@ redirect_from:
---
## About authentication to {% data variables.product.prodname_dotcom %}
To keep your account secure, you must authenticate before you can access{% if currentVersion != "github-ae@latest" %} certain{% endif %} resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
To keep your account secure, you must authenticate before you can access{% ifversion not ghae %} certain{% endif %} resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
You can access your resources in {% data variables.product.product_name %} in a variety of ways: in the browser, via {% data variables.product.prodname_desktop %} or another desktop application, with the API, or via the command line. Each way of accessing {% data variables.product.product_name %} supports different modes of authentication.
- {% if currentVersion == "github-ae@latest" %}Your identity provider (IdP){% else %}Username and password with two-factor authentication{% endif %}
- {% ifversion ghae %}Your identity provider (IdP){% else %}Username and password with two-factor authentication{% endif %}
- Personal access token
- SSH key
## Authenticating in your browser
You can authenticate to {% data variables.product.product_name %} in your browser {% if currentVersion == "github-ae@latest" %}using your IdP. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)."{% else %}in different ways.
You can authenticate to {% data variables.product.product_name %} in your browser {% ifversion ghae %}using your IdP. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)."{% else %}in different ways.
- **Username and password only**
- You'll create a password when you create your user account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)."
@@ -55,9 +55,9 @@ You can access repositories on {% data variables.product.product_name %} from th
* You can work with all repositories on {% data variables.product.product_name %} over SSH, although firewalls and proxys might refuse to allow SSH connections. Using SSH requires you to generate an SSH public/private keypair on your local machine and add the public key to your {% data variables.product.product_name %} account. Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent). For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)."
{% if currentVersion == "free-pro-team@latest" %}To use a personal access token or SSH key to access resources owned by an organization that uses SAML single sign-on, you must also authorize the personal token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %}
{% ifversion fpt %}To use a personal access token or SSH key to access resources owned by an organization that uses SAML single sign-on, you must also authorize the personal token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
{% ifversion fpt or ghes > 3.1 or ghae-next %}
## {% data variables.product.company_short %}'s token formats

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md
View File

@@ -10,7 +10,7 @@ redirect_from:
- /articles/about-githubs-ip-addresses
- /github/authenticating-to-github/about-githubs-ip-addresses
versions:
free-pro-team: '*'
fpt: '*'
topics:
- Identity
- Access management

10
content/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps.md
View File

@@ -5,16 +5,16 @@ redirect_from:
- /articles/authorizing-oauth-apps
- /github/authenticating-to-github/authorizing-oauth-apps
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
---
When an {% data variables.product.prodname_oauth_app %} wants to identify you by your {% data variables.product.product_name %} account, you'll see a page with the app's developer contact information and a list of the specific data that's being requested.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
{% tip %}
@@ -71,7 +71,7 @@ When you want to use an {% data variables.product.prodname_oauth_app %} that int
When {% data variables.product.prodname_oauth_app %}s request new access permissions, they will notify you of the differences between their current permissions and the new permissions.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## {% data variables.product.prodname_oauth_app %}s and organizations

10
content/github/authenticating-to-github/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/connecting-with-third-party-applications
- /github/authenticating-to-github/connecting-with-third-party-applications
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -59,12 +59,12 @@ There are several types of data that applications can request.
| --- | --- |
| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they <em>can</em> read and write status information against a specific commit. |
| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. |
| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% if currentVersion != "github-ae@latest" %}both your public and{% else %}both your internal and{% endif %} secret Gists. |
| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% ifversion not ghae %}both your public and{% else %}both your internal and{% endif %} secret Gists. |
| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. |
| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. |
| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. |
| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. |
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories on a user-wide level. |
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% ifversion not ghae %}public{% else %}internal{% endif %} or private repositories on a user-wide level. |
| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. |
## Requesting updated permissions

22
content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token.md
View File

@@ -8,22 +8,22 @@ redirect_from:
- /github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
- /github/authenticating-to-github/creating-a-personal-access-token
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
---
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).
{% if currentVersion == "free-pro-team@latest" %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %}
{% ifversion fpt %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %}
{% if currentVersion == "free-pro-team@latest" %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %}
{% ifversion fpt %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %}
## Creating a token
{% if currentVersion == "free-pro-team@latest" %}1. [Verify your email address](/github/getting-started-with-github/verifying-your-email-address), if it hasn't been verified yet.{% endif %}
{% ifversion fpt %}1. [Verify your email address](/github/getting-started-with-github/verifying-your-email-address), if it hasn't been verified yet.{% endif %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.developer_settings %}
{% data reusables.user_settings.personal_access_tokens %}
@@ -32,17 +32,17 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
5. Give your token a descriptive name.
![Token description field](/assets/images/help/settings/token_description.png)
6. Select the scopes, or permissions, you'd like to grant this token. To use your token to access repositories from the command line, select **repo**.
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
{% ifversion fpt or ghes %}
![Selecting token scopes](/assets/images/help/settings/token_scopes.gif)
{% elsif currentVersion == "github-ae@latest" %}
{% elsif ghae %}
![Selecting token scopes](/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png)
{% endif %}
7. Click **Generate token**.
![Generate token button](/assets/images/help/settings/generate_token.png)
8. Click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
![Newly created token](/assets/images/help/settings/personal_access_tokens.png)
{% elsif currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
{% elsif ghes > 3.1 or ghae-next %}
![Newly created token](/assets/images/help/settings/personal_access_tokens_ghe.png)
{% else %}
![Newly created token](/assets/images/help/settings/personal_access_tokens_ghe_legacy.png)
@@ -53,7 +53,7 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
{% endwarning %}
{% if currentVersion == "free-pro-team@latest" %}9. To use your token to authenticate to an organization that uses SAML SSO, [authorize the token for use with a SAML single-sign-on organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).{% endif %}
{% ifversion fpt %}9. To use your token to authenticate to an organization that uses SAML SSO, [authorize the token for use with a SAML single-sign-on organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).{% endif %}
## Using a token on the command line

8
content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password.md
View File

@@ -6,14 +6,14 @@ redirect_from:
- /articles/creating-a-strong-password
- /github/authenticating-to-github/creating-a-strong-password
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- Identity
- Access management
---
You must choose or generate a password for your {% data variables.product.product_name %} account that is at least:
- {% if enterpriseServerVersions contains currentVersion %}Seven{% else %}Eight{% endif %} characters long, if it includes a number and a lowercase letter, or
- {% ifversion ghes %}Seven{% else %}Eight{% endif %} characters long, if it includes a number and a lowercase letter, or
- 15 characters long with any combination of characters
To keep your account secure, we recommend you follow these best practices:
@@ -26,7 +26,7 @@ To keep your account secure, we recommend you follow these best practices:
You can only use your password to log on to {% data variables.product.product_name %} using your browser. When you authenticate to {% data variables.product.product_name %} with other means, such as the command line or API, you should use other credentials. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)."
{% if currentVersion == "free-pro-team@latest" %}{% data reusables.user_settings.password-authentication-deprecation %}{% endif %}
{% ifversion fpt %}{% data reusables.user_settings.password-authentication-deprecation %}{% endif %}
## Further reading

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints.md
View File

@@ -7,7 +7,7 @@ redirect_from:
- /articles/githubs-ssh-key-fingerprints
- /github/authenticating-to-github/githubs-ssh-key-fingerprints
versions:
free-pro-team: '*'
fpt: '*'
topics:
- Identity
- Access management

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/index.md
View File

@@ -4,9 +4,9 @@ intro: 'To protect your personal information, you should keep both your {% data
redirect_from:
- /articles/keeping-your-account-and-data-secure
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/preventing-unauthorized-access.md
View File

@@ -5,8 +5,8 @@ redirect_from:
- /articles/preventing-unauthorized-access
- /github/authenticating-to-github/preventing-unauthorized-access
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- Identity
- Access management
@@ -17,7 +17,7 @@ After changing your password, you should perform these actions to make sure that
- [Enable two-factor authentication](/articles/about-two-factor-authentication) on your account so that access requires more than just a password.
- [Review your SSH keys](/articles/reviewing-your-ssh-keys), [deploy keys](/articles/reviewing-your-deploy-keys), and [authorized integrations](/articles/reviewing-your-authorized-integrations) and revoke unauthorized or unfamiliar access in your SSH and Applications settings.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
- [Verify all your email addresses](/articles/verifying-your-email-address). If an attacker added their email address to your account, it could allow them to force an unintended password reset.
{% endif %}
- [Review your account's security log](/github/authenticating-to-github/reviewing-your-security-log). This provides an overview on various configurations made to your repositories. For example, you can ensure that no private repositories were turned public, or that no repositories were transferred.

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md
View File

@@ -8,9 +8,9 @@ redirect_from:
- /articles/removing-sensitive-data-from-a-repository
- /github/authenticating-to-github/removing-sensitive-data-from-a-repository
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

8
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-authorized-applications-oauth.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/reviewing-your-authorized-applications-oauth
- /github/authenticating-to-github/reviewing-your-authorized-applications-oauth
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -18,6 +18,6 @@ topics:
{% data reusables.user_settings.review-oauth-apps %}
## Further reading
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
- "[About integrations](/articles/about-integrations)"{% endif %}
- "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)"

8
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-authorized-integrations.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/reviewing-your-authorized-integrations
- /github/authenticating-to-github/reviewing-your-authorized-integrations
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -29,6 +29,6 @@ topics:
![List of authorized {% data variables.product.prodname_github_app %}](/assets/images/help/settings/revoke-github-app.png)
## Further reading
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
- "[About integrations](/articles/about-integrations)"{% endif %}
- "[Reviewing your authorized applications (OAuth)](/articles/reviewing-your-authorized-applications-oauth)"

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/reviewing-your-deploy-keys
- /github/authenticating-to-github/reviewing-your-deploy-keys
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

52
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/reviewing-your-security-log
- /github/authenticating-to-github/reviewing-your-security-log
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -18,7 +18,7 @@ topics:
The security log lists all actions performed within the last 90 days.
{% data reusables.user_settings.access_settings %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% ifversion fpt or ghae or ghes %}
2. In the user settings sidebar, click **Security log**.
![Security log tab](/assets/images/help/settings/audit-log-tab.png)
{% else %}
@@ -29,7 +29,7 @@ The security log lists all actions performed within the last 90 days.
![Security log](/assets/images/help/settings/user_security_history_action.png)
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% ifversion fpt or ghae or ghes %}
## Searching your security log
{% data reusables.audit_log.audit-log-search %}
@@ -42,24 +42,24 @@ The security log lists all actions performed within the last 90 days.
The events listed in your security log are triggered by your actions. Actions are grouped into the following categories:
| Category name | Description
|------------------|-------------------{% if currentVersion == "free-pro-team@latest" %}
|------------------|-------------------{% ifversion fpt %}
| [`account_recovery_token`](#account_recovery_token-category-actions) | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods).
| [`billing`](#billing-category-actions) | Contains all activities related to your billing information.
| [`codespaces`](#codespaces-category-actions) | Contains all activities related to {% data variables.product.prodname_codespaces %}. For more information, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces)."
| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement.
| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}
| [`oauth_access`](#oauth_access-category-actions) | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% if currentVersion == "free-pro-team@latest" %}
| [`oauth_access`](#oauth_access-category-actions) | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% ifversion fpt %}
| [`payment_method`](#payment_method-category-actions) | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %}
| [`profile_picture`](#profile_picture-category-actions) | Contains all activities related to your profile picture.
| [`project`](#project-category-actions) | Contains all activities related to project boards.
| [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
| [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
| [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %}
| [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% ifversion fpt %}
| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% ifversion ghes or ghae %}
| [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% ifversion not ghae %}
| [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %}
| [`user`](#user-category-actions) | Contains all activities related to your account.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Exporting your security log
@@ -72,7 +72,7 @@ The events listed in your security log are triggered by your actions. Actions ar
An overview of some of the most common actions that are recorded as events in the security log.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
### `account_recovery_token` category actions
@@ -124,7 +124,7 @@ An overview of some of the most common actions that are recorded as events in th
| `create` | Triggered when you [grant access to an {% data variables.product.prodname_oauth_app %}](/articles/authorizing-oauth-apps).
| `destroy` | Triggered when you [revoke an {% data variables.product.prodname_oauth_app %}'s access to your account](/articles/reviewing-your-authorized-integrations).
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
### `payment_method` category actions
@@ -167,16 +167,16 @@ An overview of some of the most common actions that are recorded as events in th
| Action | Description
|------------------|-------------------
| `access` | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
| `add_member` | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
| `add_member` | Triggered when a {% data variables.product.product_name %} user is {% ifversion fpt %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
| `add_topic` | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
| `archived` | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion %}
| `archived` | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% ifversion ghes %}
| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %}
| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository).
| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %}
| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% if currentVersion == "free-pro-team@latest" %}
| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% ifversion fpt %}
| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}{% ifversion fpt %}
| `enable` | Triggered when a repository is re-enabled.{% endif %}
| `remove_member` | Triggered when a {% data variables.product.product_name %} user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository).
| `remove_topic` | Triggered when a repository owner removes a topic from a repository.
@@ -185,7 +185,7 @@ An overview of some of the most common actions that are recorded as events in th
| `transfer_start` | Triggered when a repository transfer is about to occur.
| `unarchived` | Triggered when a repository owner unarchives a repository.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
### `sponsors` category actions
| Action | Description
@@ -209,7 +209,7 @@ An overview of some of the most common actions that are recorded as events in th
| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
### `successor_invitation` category actions
| Action | Description
@@ -221,7 +221,7 @@ An overview of some of the most common actions that are recorded as events in th
| `revoke` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
{% endif %}
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
{% ifversion ghes or ghae %}
### `team` category actions
@@ -236,7 +236,7 @@ An overview of some of the most common actions that are recorded as events in th
{% endif %}
{% if currentVersion != "github-ae@latest" %}
{% ifversion not ghae %}
### `two_factor_authentication` category actions
| Action | Description
@@ -249,20 +249,20 @@ An overview of some of the most common actions that are recorded as events in th
| Action | Description
|--------------------|---------------------
| `add_email` | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.{% if currentVersion == "free-pro-team@latest" %}
| `add_email` | Triggered when you {% ifversion not ghae %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.{% ifversion fpt %}
| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.
| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. {% endif %}
| `create` | Triggered when you create a new user account.{% if currentVersion != "github-ae@latest" %}
| `create` | Triggered when you create a new user account.{% ifversion not ghae %}
| `change_password` | Triggered when you change your password.
| `forgot_password` | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %}
| `hide_private_contributions_count` | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).
| `login` | Triggered when you log in to {% data variables.product.product_location %}.{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
| `login` | Triggered when you log in to {% data variables.product.product_location %}.{% ifversion ghes > 2.22 or ghae %}
`mandatory_message_viewed` | Triggered when you view a mandatory message (see "[Customizing user messages](/admin/user-management/customizing-user-messages-for-your-enterprise)" for details) | {% endif %}
| `failed_login` | Triggered when you failed to log in successfully.
| `remove_email` | Triggered when you remove an email address.
| `rename` | Triggered when you rename your account.{% if currentVersion == "free-pro-team@latest" %}
| `rename` | Triggered when you rename your account.{% ifversion fpt %}
| `report_content` | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).{% endif %}
| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion != "github-ae@latest" %}
| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% ifversion not ghae %}
| `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %}
### `user_status` category actions

12
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md
View File

@@ -7,9 +7,9 @@ redirect_from:
- /articles/reviewing-your-ssh-keys
- /github/authenticating-to-github/reviewing-your-ssh-keys
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -33,7 +33,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% data reusables.command_line.start_ssh_agent %}
6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
6. Find and take a note of your public key fingerprint. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 <em>a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)
@@ -73,7 +73,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %}
6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
6. Find and take a note of your public key fingerprint. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 <em>a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)
@@ -111,7 +111,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% data reusables.command_line.start_ssh_agent %}
6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
6. Find and take a note of your public key fingerprint. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 <em>a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)

4
content/github/authenticating-to-github/keeping-your-account-and-data-secure/sudo-mode.md
View File

@@ -5,8 +5,8 @@ redirect_from:
- /articles/sudo-mode
- /github/authenticating-to-github/sudo-mode
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- Identity
- Access management

16
content/github/authenticating-to-github/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md
View File

@@ -1,30 +1,30 @@
---
title: Updating your GitHub access credentials
intro: '{% data variables.product.product_name %} credentials include{% if currentVersion != "github-ae@latest" %} not only your password, but also{% endif %} the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.'
intro: '{% data variables.product.product_name %} credentials include{% ifversion not ghae %} not only your password, but also{% endif %} the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.'
redirect_from:
- /articles/rolling-your-credentials/
- /articles/how-can-i-reset-my-password/
- /articles/updating-your-github-access-credentials
- /github/authenticating-to-github/updating-your-github-access-credentials
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
---
{% if currentVersion != "github-ae@latest" %}
{% ifversion not ghae %}
## Requesting a new password
1. To request a new password, visit {% if currentVersion == "free-pro-team@latest" %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}.
1. To request a new password, visit {% ifversion fpt %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}.
2. Enter the email address associated with your personal {% data variables.product.product_name %} account, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured.
![Password reset email request dialog](/assets/images/help/settings/password-recovery-email-request.png)
3. We'll email you a link that will allow you to reset your password. You must click on this link within 3 hours of receiving the email. If you didn't receive an email from us, make sure to check your spam folder.
4. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials. Type your 2FA credentials or one of your 2FA recovery codes and click **Verify**.
![Two-factor authentication prompt](/assets/images/help/2fa/2fa-password-reset.png)
5. Type a new password, confirm your new password, and click **Change password**. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)."
{% if currentVersion == "free-pro-team@latest" %}![Password recovery box](/assets/images/help/settings/password-recovery-page.png){% else %}
{% ifversion fpt %}![Password recovery box](/assets/images/help/settings/password-recovery-page.png){% else %}
![Password recovery box](/assets/images/enterprise/settings/password-recovery-page.png){% endif %}
{% tip %}
@@ -61,7 +61,7 @@ See "[Reviewing your SSH keys](/articles/reviewing-your-ssh-keys)" for instructi
If you have any applications registered with {% data variables.product.product_name %}, you'll want to reset their OAuth tokens. For more information, see the "[Reset an authorization](/rest/reference/apps#reset-an-authorization)" endpoint.
{% if currentVersion != "github-ae@latest" %}
{% ifversion not ghae %}
## Preventing unauthorized access
For more tips on securing your account and preventing unauthorized access, see "[Preventing unauthorized access](/articles/preventing-unauthorized-access)."

14
content/github/authenticating-to-github/managing-commit-signature-verification/about-commit-signature-verification.md
View File

@@ -7,20 +7,20 @@ redirect_from:
- /articles/about-commit-signature-verification
- /github/authenticating-to-github/about-commit-signature-verification
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
---
## About commit signature verification
You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% if currentVersion == "free-pro-team@latest" %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %}
You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %}
![Verified commit](/assets/images/help/commits/verified-commit.png)
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)."
{% data reusables.identity-and-permissions.vigilant-mode-beta-note %}
@@ -45,7 +45,7 @@ Repository administrators can enforce required commit signing on a branch to blo
{% data reusables.identity-and-permissions.verification-status-check %}
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface, except for when you squash and merge a pull request that you are not the author of. Commits signed by {% data variables.product.product_name %} will have a verified status on {% data variables.product.product_name %}. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. You can optionally choose to have {% data variables.product.product_name %} sign commits you make in {% data variables.product.prodname_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)."
{% endif %}
@@ -80,7 +80,7 @@ To sign commits using S/MIME and have those commits verified on {% data variable
You don't need to upload your public key to {% data variables.product.product_name %}.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Signature verification for bots
Organizations and {% data variables.product.prodname_github_app %}s that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag as verified.

6
content/github/authenticating-to-github/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/adding-a-new-gpg-key-to-your-github-account
- /github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

8
content/github/authenticating-to-github/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/associating-an-email-with-your-gpg-key
- /github/authenticating-to-github/associating-an-email-with-your-gpg-key
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -29,7 +29,7 @@ If you're using a GPG key that matches your committer identity and your verified
```shell
$ gpg> adduid
```
6. Follow the prompts to supply your real name, email address, and any comments. You can modify your entries by choosing `N`, `C`, or `E`. {% data reusables.gpg.private-email %} {% if currentVersion == "free-pro-team@latest" %} For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."{% endif %}
6. Follow the prompts to supply your real name, email address, and any comments. You can modify your entries by choosing `N`, `C`, or `E`. {% data reusables.gpg.private-email %} {% ifversion fpt %} For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."{% endif %}
```shell
Real Name: <em>Octocat</em>
Email address: <em>octocat@github.com</em>

6
content/github/authenticating-to-github/managing-commit-signature-verification/checking-for-existing-gpg-keys.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/checking-for-existing-gpg-keys
- /github/authenticating-to-github/checking-for-existing-gpg-keys
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

2
content/github/authenticating-to-github/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md
View File

@@ -3,7 +3,7 @@ title: Displaying verification statuses for all of your commits
shortTitle: Displaying verification for all commits
intro: You can enable vigilant mode for commit signature verification to mark all of your commits and tags with a signature verification status.
versions:
free-pro-team: '*'
fpt: '*'
topics:
- Identity
- Access management

10
content/github/authenticating-to-github/managing-commit-signature-verification/generating-a-new-gpg-key.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/generating-a-new-gpg-key
- /github/authenticating-to-github/generating-a-new-gpg-key
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -18,7 +18,7 @@ topics:
{% note %}
**Note:** Before generating a new GPG key, make sure you've verified your email address. If you haven't verified your email address, you won't be able to sign commits and tags with GPG.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %}
**Note:** Before generating a new GPG key, make sure you've verified your email address. If you haven't verified your email address, you won't be able to sign commits and tags with GPG.{% ifversion fpt %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %}
{% endnote %}
@@ -41,7 +41,7 @@ topics:
{% note %}
**Note:** When asked to enter your email address, ensure that you enter the verified email address for your GitHub account. {% data reusables.gpg.private-email %} {% if currentVersion == "free-pro-team@latest" %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)" and "[Setting your commit email address](/articles/setting-your-commit-email-address)."{% endif %}
**Note:** When asked to enter your email address, ensure that you enter the verified email address for your GitHub account. {% data reusables.gpg.private-email %} {% ifversion fpt %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)" and "[Setting your commit email address](/articles/setting-your-commit-email-address)."{% endif %}
{% endnote %}

8
content/github/authenticating-to-github/managing-commit-signature-verification/index.md
View File

@@ -1,14 +1,14 @@
---
title: Managing commit signature verification
intro: 'You can sign your work locally using GPG or S/MIME. {% data variables.product.product_name %} will verify these signatures so other people will know that your commits come from a trusted source.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}'
intro: 'You can sign your work locally using GPG or S/MIME. {% data variables.product.product_name %} will verify these signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}'
redirect_from:
- /articles/generating-a-gpg-key/
- /articles/signing-commits-with-gpg/
- /articles/managing-commit-signature-verification
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

6
content/github/authenticating-to-github/managing-commit-signature-verification/signing-commits.md
View File

@@ -7,9 +7,9 @@ redirect_from:
- /articles/signing-commits
- /github/authenticating-to-github/signing-commits
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

6
content/github/authenticating-to-github/managing-commit-signature-verification/signing-tags.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/signing-tags
- /github/authenticating-to-github/signing-tags
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

6
content/github/authenticating-to-github/managing-commit-signature-verification/telling-git-about-your-signing-key.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/telling-git-about-your-signing-key
- /github/authenticating-to-github/telling-git-about-your-signing-key
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

10
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md
View File

@@ -5,12 +5,12 @@ redirect_from:
- /articles/about-two-factor-authentication
- /github/authenticating-to-github/about-two-factor-authentication
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
---
For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% if currentVersion == "free-pro-team@latest" %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone.
For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% ifversion fpt %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone.
{% data reusables.two_fa.after-2fa-add-security-key %}
@@ -24,7 +24,7 @@ For more information, see "[Accessing {% data variables.product.prodname_dotcom
{% data reusables.two_fa.about-recovery-codes %} For more information, see "[Recovering your account if you lose your 2FA credentials](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)."
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
{% warning %}
@@ -36,6 +36,6 @@ For more information, see "[Accessing {% data variables.product.prodname_dotcom
## Requiring two-factor authentication in your organization
Organization owners can require that organization members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators use two-factor authentication to secure their personal accounts. For more information, see "[Requiring two-factor authentication in your organization](/articles/requiring-two-factor-authentication-in-your-organization)."
Organization owners can require that organization members{% ifversion fpt %}, billing managers,{% endif %} and outside collaborators use two-factor authentication to secure their personal accounts. For more information, see "[Requiring two-factor authentication in your organization](/articles/requiring-two-factor-authentication-in-your-organization)."
{% data reusables.two_fa.auth_methods_2fa %}

8
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md
View File

@@ -8,8 +8,8 @@ redirect_from:
- /articles/accessing-github-using-two-factor-authentication
- /github/authenticating-to-github/accessing-github-using-two-factor-authentication
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
---
@@ -17,7 +17,7 @@ With two-factor authentication enabled, you'll need to provide an authentication
## Providing a 2FA code when signing in to the website
After you sign in to {% data variables.product.product_name %} using your password, you'll be prompted to provide an authentication code from {% if currentVersion == "free-pro-team@latest" %}a text message or{% endif %} your TOTP app.
After you sign in to {% data variables.product.product_name %} using your password, you'll be prompted to provide an authentication code from {% ifversion fpt %}a text message or{% endif %} your TOTP app.
{% data variables.product.product_name %} will only ask you to provide your 2FA authentication code again if you've logged out, are using a new device, or your session expires.
@@ -27,7 +27,7 @@ If you chose to set up two-factor authentication using a TOTP application on you
If you delete the mobile application after configuring two-factor authentication, you'll need to provide your recovery code to get access to your account. For more information, see "[Recovering your account if you lose your two-factor authentication credentials](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)"
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
### Receiving a text message

2
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md
View File

@@ -6,7 +6,7 @@ redirect_from:
- /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device
- /github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device
versions:
free-pro-team: '*'
fpt: '*'
topics:
- 2FA
---

6
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md
View File

@@ -10,8 +10,8 @@ redirect_from:
- /articles/configuring-two-factor-authentication-recovery-methods
- /github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
---
@@ -51,7 +51,7 @@ Once you use a recovery code to regain access to your account, it cannot be reus
You can set up a security key as a secondary two-factor authentication method, and use the security key to regain access to your account. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Setting a fallback authentication number

16
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md
View File

@@ -8,19 +8,19 @@ redirect_from:
- /articles/configuring-two-factor-authentication
- /github/authenticating-to-github/configuring-two-factor-authentication
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
---
You can configure two-factor authentication using a mobile app{% if currentVersion == "free-pro-team@latest" %} or via text message{% endif %}. You can also add a security key.
You can configure two-factor authentication using a mobile app{% ifversion fpt %} or via text message{% endif %}. You can also add a security key.
We strongly recommend using a time-based one-time password (TOTP) application to configure 2FA.{% if currentVersion == "free-pro-team@latest" %} TOTP applications are more reliable than SMS, especially for locations outside the United States.{% endif %} TOTP apps support the secure backup of your authentication codes in the cloud and can be restored if you lose access to your device.
We strongly recommend using a time-based one-time password (TOTP) application to configure 2FA.{% ifversion fpt %} TOTP applications are more reliable than SMS, especially for locations outside the United States.{% endif %} TOTP apps support the secure backup of your authentication codes in the cloud and can be restored if you lose access to your device.
{% warning %}
**Warning:**
- If you're a member{% if currentVersion == "free-pro-team@latest" %}, billing manager,{% endif %} or outside collaborator to a private repository of an organization that requires two-factor authentication, you must leave the organization before you can disable 2FA on {% data variables.product.product_location %}.
- If you're a member{% ifversion fpt %}, billing manager,{% endif %} or outside collaborator to a private repository of an organization that requires two-factor authentication, you must leave the organization before you can disable 2FA on {% data variables.product.product_location %}.
- If you disable 2FA, you will automatically lose access to the organization and any private forks you have of the organization's private repositories. To regain access to the organization and your forks, re-enable two-factor authentication and contact an organization owner.
{% endwarning %}
@@ -54,7 +54,7 @@ A time-based one-time password (TOTP) application automatically generates an aut
![TOTP Enable field](/assets/images/help/2fa/totp-enter-code.png)
{% data reusables.two_fa.test_2fa_immediately %}
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Configuring two-factor authentication using text messages
@@ -87,9 +87,9 @@ Before using this method, be sure that you can receive text messages. Carrier ra
On most devices and browsers, you can use a physical security key over USB or NFC. Some browsers can use the fingerprint reader, facial recognition, or password/PIN on your device as a security key.
Authentication with a security key is *secondary* to authentication with a TOTP application{% if currentVersion == "free-pro-team@latest" %} or a text message{% endif %}. If you lose your security key, you'll still be able to use your phone's code to sign in.
Authentication with a security key is *secondary* to authentication with a TOTP application{% ifversion fpt %} or a text message{% endif %}. If you lose your security key, you'll still be able to use your phone's code to sign in.
1. You must have already configured 2FA via a TOTP mobile app{% if currentVersion == "free-pro-team@latest" %} or via SMS{% endif %}.
1. You must have already configured 2FA via a TOTP mobile app{% ifversion fpt %} or via SMS{% endif %}.
2. Ensure that you have a WebAuthn compatible security key inserted into your computer.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}

2
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md
View File

@@ -5,7 +5,7 @@ redirect_from:
- /articles/countries-where-sms-authentication-is-supported
- /github/authenticating-to-github/countries-where-sms-authentication-is-supported
versions:
free-pro-team: '*'
fpt: '*'
topics:
- 2FA
---

6
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md
View File

@@ -5,8 +5,8 @@ redirect_from:
- /articles/disabling-two-factor-authentication-for-your-personal-account
- /github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
---
@@ -14,7 +14,7 @@ We strongly recommend using two-factor authentication to secure your account. If
{% warning %}
**Warning:** If you're a member{% if currentVersion == "free-pro-team@latest" %}, billing manager,{% endif %} or outside collaborator to a public repository of an organization that requires two-factor authentication and you disable 2FA, you'll be automatically removed from the organization, and you'll lose your access to their repositories. To regain access to the organization, re-enable two-factor authentication and contact an organization owner.
**Warning:** If you're a member{% ifversion fpt %}, billing manager,{% endif %} or outside collaborator to a public repository of an organization that requires two-factor authentication and you disable 2FA, you'll be automatically removed from the organization, and you'll lose your access to their repositories. To regain access to the organization, re-enable two-factor authentication and contact an organization owner.
{% endwarning %}

4
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/index.md
View File

@@ -6,8 +6,8 @@ redirect_from:
- /categories/two-factor-authentication-2fa/
- /articles/securing-your-account-with-two-factor-authentication-2fa
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
children:

12
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md
View File

@@ -7,12 +7,12 @@ redirect_from:
- /articles/recovering-your-account-if-you-lose-your-2fa-credentials
- /github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials
versions:
free-pro-team: '*'
enterprise-server: '*'
fpt: '*'
ghes: '*'
topics:
- 2FA
---
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
{% warning %}
@@ -26,7 +26,7 @@ topics:
Use one of your recovery codes to automatically regain entry into your account. You may have saved your recovery codes to a password manager or your computer's downloads folder. The default filename for recovery codes is `github-recovery-codes.txt`. For more information about recovery codes, see "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods#downloading-your-two-factor-authentication-recovery-codes)."
{% data reusables.two_fa.username-password %}{% if currentVersion == "free-pro-team@latest" %}
{% data reusables.two_fa.username-password %}{% ifversion fpt %}
2. Under "Having Problems?", click **Enter a two-factor recovery code**.
![Link to use a recovery code](/assets/images/help/2fa/2fa-recovery-code-link.png){% else %}
2. On the 2FA page, under "Don't have your phone?", click **Enter a two-factor recovery code**.
@@ -34,7 +34,7 @@ Use one of your recovery codes to automatically regain entry into your account.
3. Type one of your recovery codes, then click **Verify**.
![Field to type a recovery code and Verify button](/assets/images/help/2fa/2fa-type-verify-recovery-code.png)
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Authenticating with a fallback number
If you lose access to your primary TOTP app or phone number, you can provide a two-factor authentication code sent to your fallback number to automatically regain access to your account.
@@ -44,7 +44,7 @@ If you lose access to your primary TOTP app or phone number, you can provide a t
If you configured two-factor authentication using a security key, you can use your security key as a secondary authentication method to automatically regain access to your account. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Authenticating with a verified device, SSH token, or personal access token
If you know your {% data variables.product.product_name %} password but don't have the two-factor authentication credentials or your two-factor authentication recovery codes, you can have a one-time password sent to your verified email address to begin the verification process and regain access to your account.

14
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/checking-your-commit-and-tag-signature-verification-status
- /github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
@@ -17,9 +17,9 @@ topics:
1. On {% data variables.product.product_name %}, navigate to your pull request.
{% data reusables.repositories.review-pr-commits %}
3. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified{% if currentVersion == "free-pro-team@latest" %}, partially verified,{% endif %} or unverified.
3. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified{% ifversion fpt %}, partially verified,{% endif %} or unverified.
![Signed commit](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png)
4. To view more detailed information about the commit signature, click **Verified**{% if currentVersion == "free-pro-team@latest" %}, **Partially verified**,{% endif %} or **Unverified**.
4. To view more detailed information about the commit signature, click **Verified**{% ifversion fpt %}, **Partially verified**,{% endif %} or **Unverified**.
![Verified signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png)
## Checking your tag signature verification status
@@ -28,9 +28,9 @@ topics:
{% data reusables.repositories.releases %}
2. At the top of the Releases page, click **Tags**.
![Tags page](/assets/images/help/releases/tags-list.png)
3. Next to your tag description, there is a box that shows whether your tag signature is verified{% if currentVersion == "free-pro-team@latest" %}, partially verified,{% endif %} or unverified.
3. Next to your tag description, there is a box that shows whether your tag signature is verified{% ifversion fpt %}, partially verified,{% endif %} or unverified.
![verified tag signature](/assets/images/help/commits/gpg-signed-tag-verified.png)
4. To view more detailed information about the tag signature, click **Verified**{% if currentVersion == "free-pro-team@latest" %}, **Partially verified**,{% endif %} or **Unverified**.
4. To view more detailed information about the tag signature, click **Verified**{% ifversion fpt %}, **Partially verified**,{% endif %} or **Unverified**.
![Verified signed tag](/assets/images/help/commits/gpg-signed-tag-verified-details.png)
## Further reading

6
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/index.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/troubleshooting-gpg/
- /articles/troubleshooting-commit-signature-verification
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

6
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/updating-an-expired-gpg-key.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/updating-an-expired-gpg-key
- /github/authenticating-to-github/updating-an-expired-gpg-key
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management

8
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md
View File

@@ -5,14 +5,14 @@ redirect_from:
- /articles/using-a-verified-email-address-in-your-gpg-key
- /github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Identity
- Access management
---
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
If you need to verify your GitHub email address, see "[Verifying your email address](/articles/verifying-your-email-address/)." {% endif %}If you need to update or add an email address to your GPG key, see "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)."
Commits and tags may contain several email addresses. For commits, there is the author — the person who wrote the code — and the committer — the person who added the commit to the tree. When signing a commit with Git, whether it be during a merge, cherry-pick, or normal `git commit`, the committer email address will be yours, even if the author email address isn't. Tags are more simple: The tagger email address is always the user who created the tag.

2
content/github/authenticating-to-github/troubleshooting-ssh/deleted-or-missing-ssh-keys.md
View File

@@ -5,7 +5,7 @@ redirect_from:
- /articles/deleted-or-missing-ssh-keys
- /github/authenticating-to-github/deleted-or-missing-ssh-keys
versions:
free-pro-team: '*'
fpt: '*'
topics:
- SSH
---

6
content/github/authenticating-to-github/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/error-agent-admitted-failure-to-sign
- /github/authenticating-to-github/error-agent-admitted-failure-to-sign
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

10
content/github/authenticating-to-github/troubleshooting-ssh/error-bad-file-number.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/error-bad-file-number
- /github/authenticating-to-github/error-bad-file-number
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---
@@ -41,7 +41,7 @@ $ git clone https://{% data variables.command_line.codeblock %}/<em>username</em
If you can connect the computer to another network that doesn't have a firewall, you can try testing your SSH connection to {% data variables.product.product_name %}. If everything works as it should, contact your network administrator for help on changing the firewall settings to allow your SSH connection to {% data variables.product.product_name %} to succeed.
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
### Using SSH over the HTTPS port
@@ -49,7 +49,7 @@ If using HTTPS is not an option, and your firewall admin refuses to allow SSH co
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
## Further reading

6
content/github/authenticating-to-github/troubleshooting-ssh/error-key-already-in-use.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/error-key-already-in-use
- /github/authenticating-to-github/error-key-already-in-use
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

18
content/github/authenticating-to-github/troubleshooting-ssh/error-permission-denied-publickey.md
View File

@@ -5,9 +5,9 @@ redirect_from:
- /articles/error-permission-denied-publickey
- /github/authenticating-to-github/error-permission-denied-publickey
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---
@@ -30,7 +30,7 @@ $ ssh -vT git@{% data variables.command_line.codeblock %}
> debug1: Connecting to {% data variables.command_line.codeblock %} port 22.
```
The connection should be made on port 22{% if currentVersion == "free-pro-team@latest" %}, unless you're overriding settings to use [SSH over HTTPS](/articles/using-ssh-over-the-https-port){% endif %}.
The connection should be made on port 22{% ifversion fpt %}, unless you're overriding settings to use [SSH over HTTPS](/articles/using-ssh-over-the-https-port){% endif %}.
## Always use the "git" user
@@ -54,7 +54,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
{% mac %}
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
2. Verify that you have a private key generated and loaded into SSH. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
# start the ssh-agent in the background
$ eval "$(ssh-agent -s)"
@@ -89,7 +89,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
1. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %}
{% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %}
2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
2. Verify that you have a private key generated and loaded into SSH. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 <em>a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>you</em>/.ssh/id_rsa (RSA)
@@ -111,7 +111,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
{% linux %}
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
2. Verify that you have a private key generated and loaded into SSH. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
# start the ssh-agent in the background
$ eval "$(ssh-agent -s)"
@@ -189,7 +189,7 @@ You must provide your public key to {% data variables.product.product_name %} to
$ eval "$(ssh-agent -s)"
> Agent pid 59566
```
3. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
3. Find and take a note of your public key fingerprint. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 <em>a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)
@@ -221,7 +221,7 @@ You must provide your public key to {% data variables.product.product_name %} to
$ ssh-agent -s
> Agent pid 59566
```
3. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
3. Find and take a note of your public key fingerprint. {% ifversion ghes < 3.0 %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 <em>a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)

6
content/github/authenticating-to-github/troubleshooting-ssh/error-permission-to-userrepo-denied-to-other-user.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/error-permission-to-userrepo-denied-to-other-user
- /github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

6
content/github/authenticating-to-github/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/error-permission-to-userrepo-denied-to-userother-repo
- /github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

6
content/github/authenticating-to-github/troubleshooting-ssh/error-ssh-add-illegal-option----k.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/error-ssh-add-illegal-option----k
- /github/authenticating-to-github/error-ssh-add-illegal-option----k
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

2
content/github/authenticating-to-github/troubleshooting-ssh/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md
View File

@@ -5,7 +5,7 @@ redirect_from:
- /articles/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok
- /github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok
versions:
free-pro-team: '*'
fpt: '*'
topics:
- SSH
---

6
content/github/authenticating-to-github/troubleshooting-ssh/error-unknown-key-type.md
View File

@@ -2,9 +2,9 @@
title: 'Error: Unknown key type'
intro: 'This error means that the SSH key type you used was unrecognized or is unsupported by your SSH client. '
versions:
free-pro-team: '*'
enterprise-server: '>=3.2'
github-ae: next
fpt: '*'
ghes: '>=3.2'
ghae: next
topics:
- SSH
redirect_from:

6
content/github/authenticating-to-github/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md
View File

@@ -6,9 +6,9 @@ redirect_from:
- /articles/error-were-doing-an-ssh-key-audit
- /github/authenticating-to-github/error-were-doing-an-ssh-key-audit
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

6
content/github/authenticating-to-github/troubleshooting-ssh/index.md
View File

@@ -4,9 +4,9 @@ intro: 'When using SSH to connect and authenticate to {% data variables.product.
redirect_from:
- /articles/troubleshooting-ssh
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
children:

6
content/github/authenticating-to-github/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md
View File

@@ -7,9 +7,9 @@ redirect_from:
- /articles/recovering-your-ssh-key-passphrase
- /github/authenticating-to-github/recovering-your-ssh-key-passphrase
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- SSH
---

2
content/github/authenticating-to-github/troubleshooting-ssh/using-ssh-over-the-https-port.md
View File

@@ -5,7 +5,7 @@ redirect_from:
- /articles/using-ssh-over-the-https-port
- /github/authenticating-to-github/using-ssh-over-the-https-port
versions:
free-pro-team: '*'
fpt: '*'
topics:
- SSH
---