jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 19:06:49 -05:00
Code Issues Projects Releases Wiki Activity

GitHub AE (GHAE) (#16090)

Browse Source
This commit is contained in:
Laura Coursen
2020-11-02 15:12:44 -06:00
committed by GitHub
parent 63328d6725
commit a3e1733aa1
1410 changed files with 29166 additions and 89868 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
content/github/authenticating-to-github/about-authentication-to-github.md
View File

@@ -4,27 +4,29 @@ intro: 'You can securely access your account''s resources by authenticating to {
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### About authentication to {% data variables.product.prodname_dotcom %}
To keep your account secure, you must authenticate before you can access certain 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{% 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.
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.
- Username and password with two-factor authentication
- {% if currentVersion == "github-ae@latest" %}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 in different ways.
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.
- **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)."
- **Two-factor authentication (2FA)** (recommended)
- If you enable 2FA, we'll also prompt you to provide a code that's generated by an application on your mobile device or sent as a text message (SMS) after you successfully enter your username and password. For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)."
- In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
{% endif %}
### Authenticating with {% data variables.product.prodname_desktop %}
@@ -32,7 +34,7 @@ You can authenticate with {% data variables.product.prodname_desktop %} using yo
### Authenticating with the API
You can authenticate with the {% data variables.product.product_name %} API in different ways.
You can authenticate with the API in different ways.
- **Personal access tokens**
- In limited situations, such as testing, you can use a personal access token to access the API. Using a personal access token enables you to revoke access at any time. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."

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

@@ -1,13 +1,26 @@
---
title: About authentication with SAML single sign-on
intro: 'You can access an organization that uses SAML single sign-on (SSO) by authenticating through an identity provider (IdP). To authenticate with the API or Git on the command line when an organization enforces SAML SSO, you must authorize your personal access token or SSH key.'
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" %}To authenticate with the API or Git on the command line when an organization enforces SAML SSO, you must authorize your personal access token or SSH key.{% endif %}'
product: '{% data reusables.gated-features.saml-sso %}'
redirect_from:
- /articles/about-authentication-with-saml-single-sign-on
versions:
free-pro-team: '*'
github-ae: '*'
---
{% if currentVersion == "github-ae@latest" %}
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.
{% data reusables.saml.you-must-periodically-authenticate %}
If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems.
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
{% 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 %}.
When you access resources within an organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} will redirect you to the organization's SAML IdP to authenticate. After you successfully authenticate with your account on the IdP, the IdP redirects you back to {% data variables.product.prodname_dotcom %}, where you can access the organization's resources.
@@ -16,7 +29,7 @@ When you access resources within an organization that uses SAML SSO, {% data var
If you have recently authenticated with your organization's SAML IdP in your browser, you are automatically authorized when you access a {% data variables.product.prodname_dotcom %} organization that uses SAML SSO. If you haven't recently authenticated with your organization's SAML IdP in your browser, you must authenticate at the SAML IdP before you can access the organization.
You must periodically authenticate with your SAML IdP to authenticate and gain access to the organization's resources on {% data variables.product.prodname_dotcom %}. The duration of this login period is specified by your IdP and is generally 24 hours. This periodic login requirement limits the length of access and requires you to re-identify yourself to continue. You can view and manage your active SAML sessions in your security settings. For more information, see "[Viewing and managing your active SAML sessions](/articles/viewing-and-managing-your-active-saml-sessions)."
{% data reusables.saml.you-must-periodically-authenticate %}
To use the API or Git on the command line to access protected content in an organization that uses SAML SSO, you will need to use an authorized personal access token over HTTPS or an authorized SSH key. {% data variables.product.prodname_oauth_app %} access tokens are authorized by default.
@@ -26,6 +39,9 @@ To use a new or existing personal access token or SSH key with an organization t
You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %}.
{% endif %}
### Further reading
- "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on)"
{% if currentVersion == "free-pro-team@latest" %}- "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/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 %}

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

@@ -1,6 +1,6 @@
---
title: About commit signature verification
intro: 'Using GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or S/MIME{% endif %}, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can trust that the changes come from a trusted source.'
intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can trust that the changes come from a trusted source.'
redirect_from:
- /articles/about-gpg-commit-and-tag-signatures/
- /articles/about-gpg/
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### About commit signature verification

3
content/github/authenticating-to-github/about-ssh.md
View File

@@ -1,11 +1,12 @@
---
title: About SSH
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username or password at each visit.'
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.'
redirect_from:
- /articles/about-ssh
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
When you set up SSH, you'll [generate an SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and then [add the key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account). Adding the SSH key to the ssh-agent ensures that your SSH key has an extra layer of security through the use of a passphrase. For more information, see "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)."

1
content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
Before adding a new GPG key to your {% data variables.product.product_name %} account, you should have:

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

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
Before adding a new SSH key to your {% data variables.product.product_name %} account, you should have:

1
content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% note %}

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

@@ -1,11 +1,13 @@
---
title: Authenticating with SAML single sign-on
intro: 'You can authenticate to a {% data variables.product.product_name %} organization with SAML single sign-on (SSO) and view your active sessions.'
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 %}.'
mapTopic: true
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: '*'
---

1
content/github/authenticating-to-github/authorizing-oauth-apps.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
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.

1
content/github/authenticating-to-github/checking-for-existing-gpg-keys.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.gpg.supported-gpg-key-algorithms %}

1
content/github/authenticating-to-github/checking-for-existing-ssh-keys.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.ssh.dsa-support %}

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

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### Checking your commit signature verification status

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

@@ -14,5 +14,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---

1
content/github/authenticating-to-github/connecting-with-third-party-applications.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested.

1
content/github/authenticating-to-github/creating-a-personal-access-token.md
View File

@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/v3/auth/#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).

1
content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md
View File

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
When trying to SSH into {% data variables.product.product_location %} on a Linux computer, you may see the following message in your terminal:

1
content/github/authenticating-to-github/error-bad-file-number.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
When running remote Git commands or SSH, your connection might time out:

1
content/github/authenticating-to-github/error-key-already-in-use.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### Finding where the key has been used

11
content/github/authenticating-to-github/error-permission-denied-publickey.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### Should the `sudo` command be used with Git?
@@ -51,7 +52,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@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```shell
# start the ssh-agent in the background
$ eval "$(ssh-agent -s)"
@@ -86,7 +87,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@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```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)
@@ -108,7 +109,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@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```shell
# start the ssh-agent in the background
$ eval "$(ssh-agent -s)"
@@ -186,7 +187,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@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```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)
@@ -218,7 +219,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@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```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)

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

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
To fix this, the owner of the repository (`user`) needs to add your account (`other-user`) as a collaborator on the repository or to a team that has write access to the repository.

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

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead.

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

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
The `-K` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `-K`.

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

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys.

1
content/github/authenticating-to-github/generating-a-new-gpg-key.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.gpg.supported-gpg-key-algorithms %}

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

@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
If you don't already have an SSH key, you must [generate a new SSH key](#generating-a-new-ssh-key). If you're unsure whether you already have an SSH key, check for [existing keys](/articles/checking-for-existing-ssh-keys).

3
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 two-factor authentication, SSH, and commit signature verification.'
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.'
redirect_from:
- /categories/56/articles/
- /categories/ssh/
@@ -16,6 +16,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---

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

@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---

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

@@ -1,6 +1,6 @@
---
title: Managing commit signature verification
intro: 'You can sign your work locally using GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or S/MIME{% endif %}. {% 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.{% 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 %}'
redirect_from:
- /articles/generating-a-gpg-key/
- /articles/signing-commits-with-gpg/
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---

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

@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% mac %}

1
content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md
View File

@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
The `git filter-branch` command and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository.

1
content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.user_settings.access_settings %}

1
content/github/authenticating-to-github/reviewing-your-authorized-integrations.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### Reviewing your authorized {% data variables.product.prodname_oauth_app %}s

1
content/github/authenticating-to-github/reviewing-your-deploy-keys.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}

27
content/github/authenticating-to-github/reviewing-your-security-log.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
### Accessing your security log
@@ -13,7 +14,7 @@ versions:
The security log lists all actions performed within the last 90 days{% if currentVersion ver_lt "enterprise-server@2.20" %}, up to 50{% endif %}.
{% data reusables.user_settings.access_settings %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
2. In the user settings sidebar, click **Security log**.
![Security log tab](/assets/images/help/settings/audit-log-tab.png)
{% else %}
@@ -24,7 +25,7 @@ The security log lists all actions performed within the last 90 days{% if curren
![Security log](/assets/images/help/settings/user_security_history_action.png)
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
### Searching your security log
{% data reusables.audit_log.audit-log-search %}
@@ -48,9 +49,9 @@ Actions listed in your security log are grouped within the following categories:
| `project` | Contains all activities related to project boards.
| `public_key` | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
| `repo` | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion %}
| `team` | Contains all activities related to teams you are a part of.{% endif %}
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/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` | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %}
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %}
| `user` | Contains all activities related to your account.
A description of the events within these categories is listed below.
@@ -142,7 +143,7 @@ A description of the events within these categories is listed below.
| 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_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).{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
| 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).
@@ -191,7 +192,7 @@ A description of the events within these categories is listed below.
| 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 %}
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
#### The `team` category
@@ -206,26 +207,28 @@ A description of the events within these categories is listed below.
{% endif %}
{% if currentVersion != "github-ae@latest" %}
#### The `two_factor_authentication` category
| Action | Description
|------------------|-------------------
| enabled | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled.
| disabled | Triggered when two-factor authentication is disabled.
{% endif %}
#### The `user` category
| Action | Description
|--------------------|---------------------
| add_email | Triggered when you [add a new email address](/articles/changing-your-primary-email-address).
| 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 %}.
| create | Triggered when you create a new user account.
| remove_email | Triggered when you remove an email address.
| rename | Triggered when you rename your account.
| rename | Triggered when you rename your account.{% if currentVersion != "github-ae@latest" %}
| 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).
| forgot_password | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %}
| login | Triggered when you log in to {% data variables.product.product_location %}.
| failed_login | Triggered when you failed to log in successfully.
| 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).
| failed_login | Triggered when you failed to log in successfully.{% if currentVersion != "github-ae@latest" %}
| 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 %}
| show_private_contributions_count | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).
| hide_private_contributions_count | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion == "free-pro-team@latest" %}
| report_content | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %}

7
content/github/authenticating-to-github/reviewing-your-ssh-keys.md
View File

@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
You can delete unauthorized (or possibly compromised) SSH keys to ensure that an attacker no longer has access to your repositories. You can also approve existing SSH keys that are valid.
@@ -29,7 +30,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
5. {% data reusables.command_line.start_ssh_agent %}
6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```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)
@@ -69,7 +70,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@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```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)
@@ -107,7 +108,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
5. {% data reusables.command_line.start_ssh_agent %}
6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
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:
```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)

3
content/github/authenticating-to-github/signing-commits.md
View File

@@ -1,6 +1,6 @@
---
title: Signing commits
intro: 'You can sign commits locally using GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or S/MIME{% endif %}.'
intro: You can sign commits locally using GPG or S/MIME.
redirect_from:
- /articles/signing-commits-and-tags-using-gpg/
- /articles/signing-commits-using-gpg/
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.gpg.desktop-support-for-commit-signing %}

1
content/github/authenticating-to-github/signing-tags.md
View File

@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% data reusables.gpg.desktop-support-for-commit-signing %}

3
content/github/authenticating-to-github/telling-git-about-your-signing-key.md
View File

@@ -1,12 +1,13 @@
---
title: Telling Git about your signing key
intro: 'To sign commits locally, you need to inform Git that there''s a GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or X.509{% endif %} key you''d like to use.'
intro: "To sign commits locally, you need to inform Git that there's a GPG or X.509 key you'd like to use."
redirect_from:
- /articles/telling-git-about-your-gpg-key/
- /articles/telling-git-about-your-signing-key
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% mac %}

1
content/github/authenticating-to-github/testing-your-ssh-connection.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
Before testing your SSH connection, you should have:

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

@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---

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

@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---

1
content/github/authenticating-to-github/updating-an-expired-gpg-key.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
If your key is expired, you must [update the expiration](https://www.gnupg.org/gph/en/manual/c235.html#AEN328), export the new key, delete the expired key in your GitHub account, and [upload the new key to GitHub](/articles/adding-a-new-gpg-key-to-your-github-account/). Your previous commits and tags will show as verified, as long as the key meets all other verification requirements.

8
content/github/authenticating-to-github/updating-your-github-access-credentials.md
View File

@@ -1,6 +1,6 @@
---
title: Updating your GitHub access credentials
intro: '{% data variables.product.product_name %} credentials include not only your password, but also 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{% 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.'
redirect_from:
- /articles/rolling-your-credentials/
- /articles/how-can-i-reset-my-password/
@@ -8,8 +8,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% if currentVersion != "github-ae@latest" %}
### 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 %}.
@@ -40,7 +42,7 @@ To avoid losing your password in the future, we suggest using a secure password
For greater security, enable two-factor authentication in addition to changing your password. See [About two-factor authentication](/articles/about-two-factor-authentication) for more details.
{% endtip %}
{% endif %}
### Updating your access tokens
See "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)" for instructions on reviewing and deleting access tokens. To generate new access tokens, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
@@ -53,6 +55,8 @@ 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" %}
### Preventing unauthorized access
For more tips on securing your account and preventing unauthorized access, see "[Preventing unauthorized access](/articles/preventing-unauthorized-access)."
{% endif %}

1
content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md
View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}

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

@@ -24,4 +24,4 @@ versions:
### Further reading
- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)"
- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)"

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

@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it.