|
| 1 | +# Authenticating to GitHub |
| 2 | + |
| 3 | +## How to sign in to GitHub |
| 4 | + |
| 5 | +1. Open the **GitHub** window by going to the top level **Window** menu and selecting **GitHub**, as shown below. |
| 6 | + |
| 7 | + <img src="images/github-menu-item.png" alt="GitHub menu item in the Window menu" width="500px"/> |
| 8 | + |
| 9 | +1. Click the **Sign in** button at the top right of the window. |
| 10 | + |
| 11 | + <img src="images/github-sign-in-button.png" alt="GitHub menu item in the Window menu" width="500px"/> |
| 12 | + |
| 13 | +1. In the **Authenticate** dialog, enter your username or email and password |
| 14 | + |
| 15 | + <img src="images/github-authenticate.png" alt="GitHub menu item in the Window menu" width="350px"/> |
| 16 | + |
| 17 | + If your account requires Two Factor Authentication, you will be prompted for your auth code. |
| 18 | + |
| 19 | + <img src="images/github-two-factor.png" alt="GitHub menu item in the Window menu" width="350px"/> |
| 20 | + |
| 21 | +You will need to create a GitHub account before you can sign in, if you don't have one already. |
| 22 | + |
| 23 | +- For more information on creating a GitHub account, see "[Signing up for a new GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/)". |
| 24 | + |
| 25 | +### Personal access tokens |
| 26 | + |
| 27 | +If the sign in operation above fails, you can manually create a personal access token and use it as your password. |
| 28 | + |
| 29 | +The scopes for the personal access token are: `user`, `repo`. |
| 30 | +- *user* scope: Grants access to the user profile data. We currently use this to display your avatar and check whether your plans lets you publish private repositories. |
| 31 | +- *repo* scope: Grants read/write access to code, commit statuses, invitations, collaborators, adding team memberships, and deployment statuses for public and private repositories and organizations. This is needed for all git network operations (push, pull, fetch), and for getting information about the repository you're currently working on. |
| 32 | + |
| 33 | +For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). |
| 34 | + |
| 35 | +For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)." |
0 commit comments