mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'creds/github'

Browse Source
This commit is contained in:
Tanay Pant 2021-01-26 11:19:37 +01:00
commit e0fac1c60a
3 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/nodes/credentials/Github/README.md
View File

@ -20,7 +20,7 @@ Create a [GitHub](https://github.com/) account.
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. Access your GitHub dashboard.
1. Open your GitHub [dashboard](https://github.com).
2. Click on your user icon in the top right.
3. Click on ***Settings***.
4. Click on ***Developer settings***.
@ -28,24 +28,47 @@ You'll only need to enter the Credentials Name and click on the circle button in
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. Use the provided ***Client ID*** and ***Client Secret*** with your GitHub node credentials in n8n.
10. Click on the circle button in the OAuth section to connect a GitHub account to n8n.
11. Click the ***Save*** button to save your credentials in n8n.
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.
![Getting GitHub OAuth credentials](./using-oauth.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/O1kEes6mQcs" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
The following video demonstrates the steps to authenticate the GitHub node on [n8n.cloud](https://n8n.cloud).
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/WtjRxIVVCIg" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Access your GitHub dashboard.
1. Open your GitHub [dashboard](https://github.com).
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. Select the relevant scopes from the ***Select scopes*** section.
8. Click on the ***Generate token*** button.
8. Use the ***Personal access token*** with your GitHub node credentials in n8n.
9. Click the ***Save*** button to save your credentials in n8n.
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.
![Getting GitHub Access Token](./using-access-token.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zookYdMldt4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/Github/using-access-token.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.7 MiB

BIN
docs/nodes/credentials/Github/using-oauth.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 395 KiB