# GitHub

You can use these credentials to authenticate the following nodes with GitHub.

# Prerequisites

Create a GitHub (opens new window) account.

# Using OAuth

⛅️ Note for n8n.cloud users

You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your GitHub account to n8n.

  1. Open your GitHub dashboard (opens new window).
  2. Click on your user icon in the top right.
  3. Click on Settings.
  4. Click on Developer settings.
  5. Select OAuth Apps.
  6. Click on the Register a new application button.
  7. Enter the Application name and Homepage URL.
  8. Copy the OAuth Callback URL from n8n and paste it in the Authorization callback URL field.
  9. Click on the Register application button.
  10. Copy the displayed 'Client ID'.
  11. Enter the name for your credentials in the Credentials Name field in the 'Github OAuth2 API' credentials in n8n.
  12. Paste the client ID in the Client ID field in the 'Github OAuth2 API' credentials in n8n.
  13. On your application page, click on the Generate a new client secret button.
  14. Copy the displayed 'Client Secret'.
  15. Paste the client secret in the Client Secret field in the 'Github OAuth2 API' credentials in n8n.
  16. Click on the circle button in the OAuth section to connect a GitHub account to n8n.
  17. Click the Save button to save your credentials in n8n.

The following video demonstrates the steps mentioned above.

The following video demonstrates the steps to authenticate the GitHub node on n8n.cloud (opens new window).

# Using Access Token

  1. Open your GitHub dashboard (opens new window).
  2. Click on your user icon in the top right.
  3. Click on Settings.
  4. Click on Developer settings.
  5. Select Personal access tokens.
  6. Click on Generate new token.
  7. Enter a note in the Note field.
  8. Select the relevant scopes from the Select scopes section.
  9. Scroll down to the bottom and click on the Generate token button.
  10. Copy the displayed 'Personal access token'.
  11. Enter the name for your credentials in the Credentials Name field in the 'Github API' credentials in n8n.
  12. Enter your GitHub username in the User field in the 'Github API' credentials in n8n.
  13. Paste the access token in the Access Token field in the 'Github API' credentials in n8n.
  14. Click the Create button to save your credentials in n8n.

The following video demonstrates the steps mentioned above.