diff --git a/docs/nodes/credentials/Github/README.md b/docs/nodes/credentials/Github/README.md index 52297a199..2f522f5f7 100644 --- a/docs/nodes/credentials/Github/README.md +++ b/docs/nodes/credentials/Github/README.md @@ -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. +
+ +
+ +The following video demonstrates the steps to authenticate the GitHub node on [n8n.cloud](https://n8n.cloud). + +
+ +
## 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. + +
+ +
diff --git a/docs/nodes/credentials/Github/using-access-token.gif b/docs/nodes/credentials/Github/using-access-token.gif deleted file mode 100644 index ed5032c42..000000000 Binary files a/docs/nodes/credentials/Github/using-access-token.gif and /dev/null differ diff --git a/docs/nodes/credentials/Github/using-oauth.gif b/docs/nodes/credentials/Github/using-oauth.gif deleted file mode 100644 index 992694090..000000000 Binary files a/docs/nodes/credentials/Github/using-oauth.gif and /dev/null differ