GitHub credentials#
You can use these credentials to authenticate the following nodes:
- GitHub
- GitHub Trigger
- GitHub Document Loader: this node doesn't support OAuth.
Prerequisites#
Create a GitHub account.
Supported authentication methods#
- API access token: Use this method with any GitHub nodes.
- OAuth2: Use this method with GitHub and GitHub Trigger nodes only; don't use with GitHub Document Loader.
Related resources#
Refer to GitHub's API documentation for more information about the service.
Using API access token#
To configure this credential, you'll need a GitHub account.
There are two steps to setting up this credential:
Refer to the sections below for detailed instructions.
Generate personal access token#
Recommended access token type
Localmind Automate recommends using a personal access token (classic). GitHub's fine-grained personal access tokens are still in beta and can't access all endpoints.
To generate your personal access token:
- If you haven't done so already, verify your email address with GitHub. Refer to Verifying your email address for more information.
- Open your GitHub profile Settings.
- In the left navigation, select Developer settings.
- In the left navigation, under Personal access tokens, select Tokens (classic).
- Select Generate new token > Generate new token (classic).
- Enter a descriptive name for your token in the Note field, like
Localmind Automate integration
. - Select the Expiration you'd like for the token, or select No expiration.
- Select Scopes for your token. For most of the Localmind Automate GitHub nodes, add the
repo
scope.- A token without assigned scopes can only access public information.
- Refer to
- Select Generate token.
- Copy the token.
Refer to Creating a personal access token (classic) for more information. Refer to Scopes for OAuth apps for more information on GitHub scopes.
Set up the credential#
Then, in your Localmind Automate credential:
- If you aren't using GitHub Enterprise Server, don't change the GitHub server URL.
- If you're using GitHub Enterprise Server, update GitHub server to match the URL for your server.
- Enter your User name as it appears in your GitHub profile.
- Enter the Access Token you generated above.