text stringlengths 12 91.7k | metadata dict |
|---|---|
About
are tools that extend 's functionality. can do things on like open issues, comment on pull requests, and manage projects. They can also do things outside of based on events that happen on . For example, a can post on Slack when an issue is opened on .
Finding
You can discover on . Developers can also sha... | {
"source": "github-docs/apps/using-github-apps/about-using-github-apps.md",
"title": "About using GitHub Apps"
} |
Occasionally, a that you have installed will request additional permissions. This may happen if the owner wants the app to make additional API requests or respond to additional webhook events. For more information about what different permissions enable a to do, see AUTOTITLE.
When a requests additional permissions... | {
"source": "github-docs/apps/using-github-apps/approving-updated-permissions-for-a-github-app.md",
"title": "Approving updated permissions for a GitHub App"
} |
About authorizing
Applications that are not owned by you, your organization, or may need to verify your identity or interact with on your behalf. These applications can request authorization for a to perform these actions. If an application requests authorization, it will redirect you to a page prompting you to a... | {
"source": "github-docs/apps/using-github-apps/authorizing-github-apps.md",
"title": "Authorizing GitHub Apps"
} |
Role Grant to teams Grant to existing users Grant to new users (on invite / SCIM provision)
---- ----- --------------------------- -----------------------------------
App manager
ESM
Enterprise owner
Billing manager
Guest collaborator
Custom role
User (inc. member, unaffiliated) | {
"source": "github-docs/apps/using-github-apps/index.md",
"title": "Using GitHub Apps"
} |
About installing
This article describes how to install a directly from the app owner instead of from . For more information on installing from , see AUTOTITLE and AUTOTITLE. For more information about installing that you own, see AUTOTITLE.
[!NOTE] This installation flow applies to any , whether it’s a third-party ... | {
"source": "github-docs/apps/using-github-apps/installing-a-github-app-from-a-third-party.md",
"title": "Installing a GitHub App from a third party"
} |
About
This article applies to installing and purchasing from . For more information on installing from a source other than , see AUTOTITLE.
If you install a on your organization account and you choose a paid plan, you will pay for your app subscription on your organization's current billing date using your organiza... | {
"source": "github-docs/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations.md",
"title": "Installing a GitHub App from GitHub Marketplace for your organizations"
} |
About
This article applies to installing and purchasing from . For more information on installing from a source other than , see AUTOTITLE.
If you install a on your personal account and you choose a paid plan, you will pay for your app subscription on your personal account's current billing date using your existing... | {
"source": "github-docs/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account.md",
"title": "Installing a GitHub App from GitHub Marketplace for your personal account"
} |
[!NOTE]
Enterprise-installed are in and subject to change.
About installing on your enterprise
Enterprise-installed are apps that request enterprise-level permissions and can perform operations on your enterprise account. Unlike organization or user installations, they do not have access to any organization or re... | {
"source": "github-docs/apps/using-github-apps/installing-a-github-app-on-your-enterprise.md",
"title": "Installing a GitHub App on your enterprise"
} |
About installing your own
After creating a , you can install it based on its visibility.
Only on this account: The can only be installed on the account that created it. This visibility is not available for apps created by a or registered by an enterprise.
Any account: You can install this on any account you contr... | {
"source": "github-docs/apps/using-github-apps/installing-your-own-github-app.md",
"title": "Installing your own GitHub App"
} |
Some are privileged apps. These apps are owned by and are granted special capabilities. For example, users can authorize these apps and use them to access data from an organization without requiring approval by the organization.
Some of these privileged apps are automatically included with and do not require user au... | {
"source": "github-docs/apps/using-github-apps/privileged-github-apps.md",
"title": "Privileged GitHub Apps"
} |
[!NOTE]
Currently, you can only request a from your organization owner when installing the directly from the owner, not when installing a from .
If you find a on that you want your organization owner to install, you must make the request from the 's public installation page. The URL for a public installation p... | {
"source": "github-docs/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner.md",
"title": "Requesting a GitHub App from your organization owner"
} |
About installed
users can install on their personal account or accounts they own. When you install a , you grant the app the enterprise or organization and repository permissions that it requested. If the app requested repository permissions, you also specify which repositories the can access. Installing an app on ... | {
"source": "github-docs/apps/using-github-apps/reviewing-and-modifying-installed-github-apps.md",
"title": "Reviewing and modifying installed GitHub Apps"
} |
About authorized
You may authorize a to give the app permission to access information on your account and to act on your behalf. For more information, see AUTOTITLE.
You should periodically review the that you have authorized. If you no longer use an app, consider revoking your authorization for that app.
The autho... | {
"source": "github-docs/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md",
"title": "Reviewing and revoking authorization of GitHub Apps"
} |
Authorizing for users
If your organization or enterprise uses SSO, you may not be able to see your organization's resources or enterprise's internal resources after you authorize a . For example, if the app displays a list of repositories, you may not see repositories owned by your organization. To resolve this issue,... | {
"source": "github-docs/apps/using-github-apps/saml-and-github-apps.md",
"title": "SAML and GitHub Apps"
} |
About passkeys
Passkeys are pairs of cryptographic keys (a public key and a private key) that are stored by an authenticator you control. The authenticator can prove that a user is present and is authorized to use the passkey. Authenticators prove authorization with a PIN, passcode, biometric, or device password, depen... | {
"source": "github-docs/authentication/authenticating-with-a-passkey/about-passkeys.md",
"title": "About passkeys"
} |
About managing your passkeys
If you are connecting to from an eligible device and browser, may prompt you to register the device as a passkey during sign-in. You can also add passkeys to your account from your account settings. For more information, see Adding a passkey to your account.
If you use two-factor authenti... | {
"source": "github-docs/authentication/authenticating-with-a-passkey/managing-your-passkeys.md",
"title": "Managing your passkeys"
} |
About signing in with a passkey
You must first add a passkey to your account before you can use the passkey to sign in to in the browser. For more information, see AUTOTITLE.
Once you have added a passkey to your account, you can use the passkey to sign in safely and securely to without having to enter your password,... | {
"source": "github-docs/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md",
"title": "Signing in with a passkey"
} |
About authentication with SSO
Organization owners can invite your personal account on to join their organization that uses SSO, which allows you to contribute to the organization and retain your existing identity and contributions on .
Access to SSO protected internal resources in an enterprise, such as repositories,... | {
"source": "github-docs/authentication/authenticating-with-single-sign-on/about-authentication-with-single-sign-on.md",
"title": "About authentication with single sign-on"
} |
If you use a , you must authenticate through your identity provider (IdP) to access . The location where you can authenticate depends on whether your enterprise uses SAML or OIDC authentication.
Supported authentication locations
Authentication location SAML OIDC
--- --- ---
IdP application portal
Login page ... | {
"source": "github-docs/authentication/authenticating-with-single-sign-on/authenticating-with-a-managed-user-account.md",
"title": "Authenticating with {% data variables.product.prodname_emus %}"
} |
You must authorize your after creation before the token can access an organization that uses SAML single sign-on (SSO). Access to internal resources (repositories, projects, and packages) in an enterprise requires an SSO authorization for an organization within an enterprise. For more information about creating a new ... | {
"source": "github-docs/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on.md",
"title": "Authorizing a personal access token for use with single sign-on"
} |
About authorizing apps with SSO
If your organization or enterprise uses single sign-on (SSO) and you want to access the organization or enterprise's resources through an or , you must set up an active SSO session and then authorize the app.
If you do not have an SSO session with an organization's identity provider whe... | {
"source": "github-docs/authentication/authenticating-with-single-sign-on/authorizing-an-app-for-single-sign-on.md",
"title": "Authorizing an app for single sign-on"
} |
About authorization of SSH keys
You can authorize an existing SSH key, or create a new SSH key and then authorize it. For more information about creating a new SSH key, see AUTOTITLE.
[!NOTE]
If your SSH key authorization is revoked by an organization, you will not be able to reauthorize the same key. You will need t... | {
"source": "github-docs/authentication/authenticating-with-single-sign-on/authorizing-an-ssh-key-for-use-with-single-sign-on.md",
"title": "Authorizing an SSH key for use with single sign-on"
} |
You can view a list of devices that have logged into your account, and revoke any SSO sessions that you don't recognize.
1. Under "Web sessions," you can see your active SSO sessions.
1. To see the session details, next to the session, click See more.
1. To revoke a session, in the session details, click Revoke session... | {
"source": "github-docs/authentication/authenticating-with-single-sign-on/viewing-and-managing-your-active-sso-sessions.md",
"title": "Viewing and managing your active SSO sessions"
} |
For more information about SSH, see Secure Shell on Wikipedia.
When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on before you use the key to authenticate or sign commits. For more information, see AUTOTITLE, AUTOTITLE... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/about-ssh.md",
"title": "About SSH"
} |
About addition of SSH keys to your account
For more information, see AUTOTITLE.
You can also use SSH to sign commits and tags. For more information about commit signing, see AUTOTITLE.
After you generate an SSH key pair, you must add the public key to to enable SSH access for your account.
Prerequisites
Before addin... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md",
"title": "Adding a new SSH key to your GitHub account"
} |
About SSH keys
You can use SSH to perform Git operations in repositories. For more information, see AUTOTITLE.
If you have an existing SSH key, you can use the key to authenticate Git operations over SSH.
Checking for existing SSH keys
Before you generate a new SSH key, you should check your local machine for existing... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md",
"title": "Checking for existing SSH keys"
} |
About SSH key passphrases
For more information, see AUTOTITLE.
When you generate an SSH key, you can add a passphrase to further secure the key. Whenever you use the key, you must enter the passphrase. If your key has a passphrase and you don't want to enter the passphrase every time you use the key, you can add your ... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md",
"title": "Generating a new SSH key and adding it to the ssh-agent"
} |
You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users.
SSH agent forwarding
In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding ... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md",
"title": "Managing deploy keys"
} |
Before testing your SSH connection, you should have already:
Checked for existing SSH keys
Generated a new SSH key
Added a new SSH key to your GitHub account
You'll need to authenticate this action using your password, which is the SSH key passphrase you created earlier. See AUTOTITLE.
[!NOTE]
1. Enter the followi... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md",
"title": "Testing your SSH connection"
} |
SSH agent forwarding can be used to make deploying to a server simple. It allows you to use your local SSH keys instead of leaving keys (without passphrases!) sitting on your server.
If you've already set up an SSH key to interact with , you're probably familiar with ssh-agent. It's a program that runs in the backgroun... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md",
"title": "Using SSH agent forwarding"
} |
About passphrases for SSH keys
With SSH keys, if someone gains access to your computer, the attacker can 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. To avoid entering the passphrase every time you connect, you can securely cache the key in... | {
"source": "github-docs/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md",
"title": "Working with SSH key passphrases"
} |
To host your images, uses the open-source project Camo. Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. On , the URL starts https://<subdomain.githubusercontent.com/, with different subdomains depending on how you uploaded the image.
Videos... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md",
"title": "About anonymized URLs"
} |
About authentication to
To keep your account secure, you must authenticate before you can access certain resources on . When you authenticate to , 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 in a variety of ways: in the... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md",
"title": "About authentication to GitHub"
} |
You can retrieve a list of the IP addresses for your environment from the meta API endpoint. For more information, see AUTOTITLE.
[!NOTE]
The list of IP addresses returned by the Meta API is not intended to be an exhaustive list. For example, IP addresses for some services might not be listed, such as LFS or .
The... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md",
"title": "About GitHub's IP addresses"
} |
You must choose or generate a password for your account on that is at least:
Eight 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:
Use a password manager to generate a... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md",
"title": "Creating a strong password"
} |
These are 's public key fingerprints:
You can add the following ssh key entries to your ~/.ssh/knownhosts file to avoid manually verifying hosts:
For more information, see AUTOTITLE. | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints.md",
"title": "GitHub's SSH key fingerprints"
} |
[!WARNING]
Treat your access tokens like passwords. For more information, see Keeping your s secure.
About s
s are an alternative to using passwords for authentication to when using the API or the command line.
s are intended to access resources on behalf of yourself. To access resources on behalf of an organizati... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md",
"title": "Managing your personal access tokens"
} |
requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members.
After changing your password, you should perform these actions to make sure that your account is secure:
Enable two-factor authentication on your account so that access requires more than... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/preventing-unauthorized-access.md",
"title": "Preventing unauthorized access"
} |
About removing sensitive data from a repository
When altering your repository's history using tools like git-filter-repo, it's crucial to understand the implications. Rewriting history requires careful coordination with collaborators to successfully execute, and has a number of side effects that must be managed.
It is... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md",
"title": "Removing sensitive data from a repository"
} |
1. In the "Security" section of the sidebar, click Deploy keys.
1. On the "Deploy keys" page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out of date, click Delete. If there are valid deploy keys you'd like to keep, click Approve.
For more information, see... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md",
"title": "Reviewing your deploy keys"
} |
Accessing your security log
The security log lists all actions performed within the last 90 days.
1. In the "Archives" section of the sidebar, click Security log.
Searching your security log
Search based on the action performed
The events listed in your security log are triggered by your actions. Actions are grouped... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md",
"title": "Reviewing your security log"
} |
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.
1. Under "SSH keys", take note of the SSH keys associated with your account. For those that you don't recognize, or that are out-of-... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md",
"title": "Reviewing your SSH keys"
} |
If you believe your account may be compromised, your hardware was lost or stolen, or you otherwise need to immediately revoke all access associated with your account, you can take action on all of your credentials at once to quickly reduce risk.
Depending on your account type, the following actions are available:
Revo... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/revoking-your-credentials.md",
"title": "Revoking your credentials"
} |
[!NOTE]
This article contains the events available in the latest version of . Some of the events may not be available in previous versions.
This article contains the events that may appear in your user account's security log. For the events that can appear in an organization's audit log or the audit log for an ente... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/security-log-events.md",
"title": "Security log events"
} |
About sudo mode
To maintain the security of your account when you perform a potentially sensitive action on , you must authenticate even though you're already signed in. For example, considers the following actions sensitive because each action could allow a new person or system to access your account.
Modification o... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/sudo-mode.md",
"title": "Sudo mode"
} |
If you need to use multiple accounts on , you can sign in to your accounts and switch between them without always being required to reauthenticate. You can use the account switcher if you have a personal account and service accounts (sometimes called machine users) or if you need to switch between your personal account... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/switching-between-accounts.md",
"title": "Switching between accounts"
} |
When a token has expired or has been revoked, it can no longer be used to authenticate Git and API requests. It is not possible to restore an expired or revoked token, you or the application will need to create a new token.
This article explains the possible reasons your token might be revoked or expire.
[!NOTE]
Whe... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md",
"title": "Token expiration and revocation"
} |
[!NOTE]
Requesting a new password
1. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials:
If you have added a passkey or a security key to your account, click Use passkey or security key.
If you have set up , you will be sent a push notification to verify your identity... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md",
"title": "Updating your GitHub access credentials"
} |
About device verification
To keep your account secure when two-factor authentication (2FA) is not enabled, may ask you to verify your sign-in attempt when you access your account from an unrecognized device for the first time. This is called device verification. An unrecognized device requiring verification may includ... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in.md",
"title": "Verifying new devices when signing in"
} |
You can view a list of devices that have logged into your account, and revoke any sessions that you don't recognize.
1. Under "Web sessions", you can see your active web sessions.
Under " sessions", you can see a list of devices that have logged into your account via the app.
1. To see the web session details, clic... | {
"source": "github-docs/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md",
"title": "Viewing and managing your sessions"
} |
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, SSH, or S/MIME signature that is cryptographically verifiable, marks the commit or tag "Verified" or "Partially verified.""Verified."
If a... | {
"source": "github-docs/authentication/managing-commit-signature-verification/about-commit-signature-verification.md",
"title": "About commit signature verification"
} |
About addition of GPG keys to your account
To sign commits associated with your account on , you can add a public GPG key to your personal account. Before you add a key, you should check for existing keys. If you don't find any existing keys, you can generate and copy a new key. For more information, see AUTOTITLE and ... | {
"source": "github-docs/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md",
"title": "Adding a GPG key to your GitHub account"
} |
If you're using a GPG key that matches your committer identity and your verified email address associated with your account on , then you can begin signing commits and signing tags.
1. Enter gpg --edit-key GPG key ID, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is 3AA5C343... | {
"source": "github-docs/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md",
"title": "Associating an email with your GPG key"
} |
[!NOTE]
GPG does not come installed by default on macOS or Windows. To install GPG command line tools, see GnuPG's Download page.
1. Check the command output to see if you have a GPG key pair.
If there are no GPG key pairs or you don't want to use any that are available for signing commits and tags, then generate... | {
"source": "github-docs/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md",
"title": "Checking for existing GPG keys"
} |
About vigilant mode
When you work locally on your computer, Git allows you to set the author of your changes and the identity of the committer. This, potentially, makes it difficult for other people to be confident that commits and tags you create were actually created by you. To help solve this problem you can sign yo... | {
"source": "github-docs/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md",
"title": "Displaying verification statuses for all of your commits"
} |
Generating a GPG key
[!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. For more information, see AUTOTITLE.
1. Download and install the GPG command line tools for your operating system... | {
"source": "github-docs/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md",
"title": "Generating a new GPG key"
} |
[!TIP]
To configure your Git client to sign commits by default for a local repository, in Git versions 2.0.0 and above, run git config commit.gpgsign true. To sign all commits by default in any local repository on your computer, run git config --global commit.gpgsign true.
To store your GPG key passphrase so you don'... | {
"source": "github-docs/authentication/managing-commit-signature-verification/signing-commits.md",
"title": "Signing commits"
} |
[!TIP]
To configure your Git client to sign tags by default for a local repository, in Git versions 2.23.0 and above, run git config tag.gpgsign true. To sign all tags by default in any local repository on your computer, run git config --global tag.gpgsign true.
1. To sign a tag, add -s to your git tag command.
she... | {
"source": "github-docs/authentication/managing-commit-signature-verification/signing-tags.md",
"title": "Signing tags"
} |
Telling Git about your GPG key
If you're using a GPG key that matches your committer identity and your verified email address associated with your account on , then you can begin signing commits and signing tags.
[!NOTE]
If you don't have a GPG key that matches your committer identity, you need to associate an email ... | {
"source": "github-docs/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md",
"title": "Telling Git about your signing key"
} |
About eligibility for mandatory 2FA
Your account is selected for mandatory 2FA if you have taken some action on that shows you are a contributor. Eligible actions include:
Publishing an app or action for others
Creating a release for your repository
Contributing to specific high-importance repositories, such as the... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md",
"title": "About mandatory two-factor authentication"
} |
For , the second form of authentication is a code that's generated by an application on your mobile device or sent as a text message (SMS). After you enable 2FA, generates an authentication code any time someone attempts to sign into your account. The only way someone can sign into your account is if they know both yo... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md",
"title": "About two-factor authentication"
} |
With two-factor authentication (2FA) enabled, you'll need to use a second factor when accessing through your browser. When you first configure 2FA, your account will enter a check up period for 28 days to ensure your account's 2FA methods are setup correctly. You can exit the check up period by successfully performing... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md",
"title": "Accessing GitHub using two-factor authentication"
} |
You can reconfigure your two-factor authentication (2FA) settings or add new 2FA methods without disabling 2FA entirely, allowing you to keep both your recovery codes and your membership in organizations that require 2FA.
Changing an existing two-factor authentication method
You can configure a different authenticator... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md",
"title": "Changing your two-factor authentication method"
} |
In addition to securely storing your two-factor authentication (2FA) recovery codes, we strongly recommend configuring two or more authentication methods to avoid losing access to your account. For more information, see AUTOTITLE.
As well as configuring authentication methods, we'd also strongly suggest setting up some... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md",
"title": "Configuring two-factor authentication recovery methods"
} |
You can configure two-factor authentication (2FA) using a TOTP app on mobile or desktop or via text message. After you have configured 2FA using a TOTP app or via text message, you can then also add security keys as alternate 2FA methods.
We strongly recommend using a time-based one-time password (TOTP) application to ... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md",
"title": "Configuring two-factor authentication"
} |
If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see AUTOTITLE.
Supported countries and regions for SMS authentication
If your country or region is not on this list, then we aren't currently ... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md",
"title": "Countries where SMS authentication is supported"
} |
[!WARNING]
If you're a member or billing manager to a repository of an organization that requires two-factor authentication and you disable 2FA, you'll lose your access to their repositories. To regain access to the organization, re-enable 2FA.
We strongly recommend using two-factor authentication (2FA) to secure your... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md",
"title": "Disabling two-factor authentication for your personal account"
} |
[!WARNING]
[!NOTE]
Using a two-factor authentication recovery code
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... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md",
"title": "Recovering your account if you lose your 2FA credentials"
} |
If you are receiving a "Two-factor authentication failed" error when authenticating with two-factor authentication (2FA), the authentication code you are entering is incorrect. You can try troubleshooting your configured authentication methods before attempting account recovery.
Troubleshooting authentication using a ... | {
"source": "github-docs/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md",
"title": "Troubleshooting two-factor authentication issues"
} |
Checking your commit signature verification status
1. On , navigate to your pull request.
1. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified, partially verified, or unverified.
!Screenshot of a commit in the commit list for a repository. "Verified" i... | {
"source": "github-docs/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md",
"title": "Checking your commit and tag signature verification status"
} |
If you need to verify your GitHub email address, see AUTOTITLE. If you need to update or add an email address to your GPG key, see AUTOTITLE.
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 t... | {
"source": "github-docs/authentication/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md",
"title": "Using a verified email address in your GPG key"
} |
automatically deletes inactive SSH keys to help keep accounts safe, such as after someone leaves a job or loses a computer.
You can check if you haven't used an SSH key in a year by reviewing your account's security log. For more information, see AUTOTITLE.
After your inactive SSH key is deleted, you must generate a ne... | {
"source": "github-docs/authentication/troubleshooting-ssh/deleted-or-missing-ssh-keys.md",
"title": "Deleted or missing SSH keys"
} |
When trying to SSH into on a Linux computer, you may see the following message in your terminal:
$ ssh -vT git@{% data variables.product.product_url %}
> ...
> Agent admitted failure to sign using the key.
> debug1: No more authentication methods to try.
> Permission denied (publickey).
For more details, see this issu... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md",
"title": "Error: Agent admitted failure to sign"
} |
When running remote Git commands or SSH, your connection might time out:
$ ssh -vT git@{% data variables.product.product_url %}
> OpenSSH_8.1p1, LibreSSL 2.7.3
> debug1: Connecting to {% data variables.product.product_url %} [207.97.227.239] port 22.
> debug1: connect to address 207.97.227.239 port 22: Connection timed... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-bad-file-number.md",
"title": "Error: Bad file number"
} |
This error means that the server to which you're connecting presented a key that doesn't match the keys seen for this server in the past.
You may see this error if the server has changed its keys unexpectedly, in which case you should be able to find an official report from a trustworthy source announcing the change. I... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-host-key-verification-failed.md",
"title": "Error: Host key verification failed"
} |
Finding where the key has been used
To determine where the key has already been used, open a terminal and type the ssh command. Use the -i flag to provide the path to the key you want to check:
$ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.product.product_url %}
# Connect to {% data variables.location.product_locati... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-key-already-in-use.md",
"title": "Error: Key already in use"
} |
[!NOTE]
Should the sudo command or elevated privileges be used with Git?
You should not be using the sudo command or elevated privileges, such as administrator permissions, with Git.
If you have a very good reason you must use sudo, then ensure you are using it with every command. If you generate SSH keys without sud... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-permission-denied-publickey.md",
"title": "Error: Permission denied (publickey)"
} |
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. | {
"source": "github-docs/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-other-user.md",
"title": "Error: Permission to user/repo denied to other-user"
} |
To fix this, remove the deploy key from the repository, and add the key to your personal account instead.
If the key you are using is intended to be a deploy key, check out our guide on deploy keys for more details. | {
"source": "github-docs/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md",
"title": "Error: Permission to user/repo denied to user/other-repo"
} |
The --apple-use-keychain 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 --apple-use-keychain.
Solving the issue
To add your SSH private key to ... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain.md",
"title": "Error: ssh-add: illegal option -- apple-use-keychain"
} |
The error you receive may look like the following:
$ git push -u github.main
> fatal: 'github.main' does not appear to be a git repository
> fatal: The remote end hung up unexpectedly
$ git pull -u github
> error: SSL certificate problem, verify that the CA cert is OK. Details:
> error:14090086:SSL routines:SSL3_GET_SE... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md",
"title": "Error: SSL certificate problem, verify that the CA cert is OK"
} |
About the unknown key type error
When you generate a new SSH key, you may receive an unknown key type error if your SSH client does not support the key type that you specify.To solve this issue on macOS, you can update your SSH client or install a new SSH client.
Prerequisites
You must have Homebrew installed. For mor... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-unknown-key-type.md",
"title": "Error: Unknown key type"
} |
When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys.
ERROR: We're doing an SSH key audit.
Reason: unverified due to lack of use
Please visit https://github.com/settings/ssh
to approve this key so we know it's safe.
Fingerprint: ab:08:46:83:ff:f6:c4:f8:a9:4e:... | {
"source": "github-docs/authentication/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md",
"title": "Error: We''re doing an SSH key audit"
} |
If you configured your SSH passphrase with the macOS keychain, you may be able to recover it.
1. In Finder, search for the Keychain Access app.
1. In Keychain Access, search for SSH.
1. Double click on the entry for your SSH key to open a new dialog box.
1. In the lower-left corner, select Show password.
1. You'll be p... | {
"source": "github-docs/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md",
"title": "Recovering your SSH key passphrase"
} |
[!WARNING]
users: Accessing via SSH over the HTTPS port is currently not supported.
users: Accessing via SSH over the HTTPS port is currently not supported.
To test if SSH over the HTTPS port is possible, run this SSH command:
$ ssh -T -p 443 git@ssh.github.com
# Hi USERNAME! You've successfully authenticated, bu... | {
"source": "github-docs/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md",
"title": "Using SSH over the HTTPS port"
} |
Payment using an Azure subscription
You can pay for use through an Azure subscription by connecting the subscription to . See AUTOTITLE.
installs a Subscription Permission Validation app (SPV app) on the Azure tenant, which it uses to get a list of available subscriptions from active directory. Installing the SPV app... | {
"source": "github-docs/billing/concepts/azure-subscriptions.md",
"title": "Azure subscription payments"
} |
Your billing experience depends on whether your products are metered, volume-based, or a combination of both. Some products, like and , can be either volume-based or metered, depending on when and how your account was created.
Metered: Pay monthly for the number of licenses you use
Volume-based: Traditional annual s... | {
"source": "github-docs/billing/concepts/billing-cycles.md",
"title": "Billing cycles"
} |
Budgets and alerts allow you to track spending on metered products for your enterprise, organizations, cost centers (enterprise only), users, and repositories. Budgets and alerts are not available for pre-paid volume licenses.
By setting a monthly budget, you can monitor your spending and receive notifications by email... | {
"source": "github-docs/billing/concepts/budgets-and-alerts.md",
"title": "Budgets and alerts"
} |
Cost centers allow you to attribute usage and spending to business units, improving accountability, forecasting, and cost allocation. You can also apply one or more budgets to them to control costs.
Cost center creation
Enterprise owners and billing managers can create and edit cost centers for any resource.
Organiz... | {
"source": "github-docs/billing/concepts/cost-centers.md",
"title": "Cost centers"
} |
[!TIP]
Discounts for an account's plan do not apply to other subscriptions or usage-based billing.
Discounts for personal accounts
In addition to the unlimited public and private repositories for students and faculty with , verified students can apply for the to receive additional benefits from partners. For more i... | {
"source": "github-docs/billing/concepts/discounted-plans.md",
"title": "Discounted plans for GitHub accounts"
} |
customers can use Azure DevOps without additional costs per user. For customers using Microsoft Entra, users can sign in with the same credentials on and Azure DevOps.
No additional setup is required for enterprises hosted on . users are detected automatically when they sign in to Azure DevOps. See User and permissio... | {
"source": "github-docs/billing/concepts/enterprise-billing/azure-devops-licenses.md",
"title": "Combined use of GitHub Enterprise and Azure DevOps"
} |
What's included in my bill?
Each month, you're billed for:
The number of licenses you use, determined by the number of unique users in your enterprise
Any usage of features like or , beyond the allowances included in your plan
Any extra features you purchase, such as or licenses
For prices and monthly allowanc... | {
"source": "github-docs/billing/concepts/enterprise-billing/billing-for-enterprises.md",
"title": "Billing for GitHub Enterprise"
} |
About enterprise deployments
If you use both and , you'll have an enterprise account for each. Even if you only use , we recommend creating an enterprise account on . This will make it easier to contact and share support bundles with them. To create an additional enterprise account, contact 's Sales team.
For most ad... | {
"source": "github-docs/billing/concepts/enterprise-billing/combined-enterprise-use.md",
"title": "Combined GitHub Enterprise cloud and server use"
} |
About license files
In order to use a instance, you must upload a license file that provides when you purchase, renew, or add user licenses to .
A license file has an expiration date and controls the number of people who can use . After you download and install , you must upload the license file to unlock the applica... | {
"source": "github-docs/billing/concepts/enterprise-billing/ghes-license-files.md",
"title": "License files for GitHub Enterprise Server"
} |
Usage-based billing means you pay each month for the number of licenses actually consumed in your enterprise account, instead of committing to a fixed number in advance. This model provides flexibility and can be more cost-efficient than traditional volume licensing.
For how billing cycles work and how mid-cycle change... | {
"source": "github-docs/billing/concepts/enterprise-billing/usage-based-licenses.md",
"title": "Usage-based billing for enterprise licenses"
} |
[!NOTE] Customers with a bundle can switch to usage-based billing for licenses. This allows you to pay for licenses on a flexible monthly cycle for users who are not part of your subscription. See AUTOTITLE.
is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, se... | {
"source": "github-docs/billing/concepts/enterprise-billing/visual-studio-subs.md",
"title": "About Visual Studio subscriptions with GitHub Enterprise"
} |
How plan changes affect billing
When you change your paid plan, the impact on billing depends on the type of change:
Scenario When is billing affected? Is proration applied? When does access change?
---------------------------------------------------------------------------------------------... | {
"source": "github-docs/billing/concepts/impact-of-plan-changes.md",
"title": "Impact of changing your plan on billing"
} |
How sandbox usage is measured
Billing applies to cloud sandboxing only. Local sandboxing is included in the standard seat at no additional cost.
A cloud sandbox session incurs charges across three meters:
Compute: the time a cloud sandbox session is running.
Memory: the memory allocated to a cloud sandbox session wh... | {
"source": "github-docs/billing/concepts/product-billing/cloud-and-local-sandboxes.md",
"title": "Billing for cloud and local sandboxes for {% data variables.product.prodname_copilot %}"
} |
How use of is measured
Previously, billing used pre-paid data packs. These have been removed and replaced with metered billing and you only pay for what you actually use.
Each account includes a quota of free bandwidth and storage for ().
Bandwidth: Your free quota resets at the start of each billing cycle.
Stora... | {
"source": "github-docs/billing/concepts/product-billing/git-lfs.md",
"title": "Git Large File Storage billing"
} |
Plan Bandwidth Storage
------- ------- ---------
for organizations
Using more than your included quota
If you use more than your included quota of storage without a payment method on file:
You can still clone repositories with large assets
You will only retrieve the pointer files, see AUTOTITLE
You will... | {
"source": "github-docs/billing/concepts/product-billing/git-lfs.md",
"title": "Git Large File Storage billing"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.