GitHub
GitHub is a software company that offers code hosting services that allow developers to build software for open-source and private projects.
Creating a GitHub connection
Create the connection by using one of the following methods:
Using OAuth
Creating your connection
- In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
- Select the GitHub icon. A dialog box with name of the connection and connection methods appear.
- (Optional) Edit the name of the connection. At a later stage you cannot edit the name.
- Click GitHub to authenticate using OAuth.
- Sign in using your credentials.
Using Access Token
To create the connection you need:
- An API Address
- A Token
Obtaining the credentials
Follow the instructions in the following link: Creating a personal access token
Creating your connection
- In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
- Select the GitHub icon. A dialog box with name of the connection and connection methods appear.
- (Optional) Edit the name of the connection. At a later stage you cannot edit the name.
- Select Access Token as the method to create the connection.
- Fill in the parameters:
- The API Address
- The Token
- (Optional) Click Test Connection to test it.
- Click Create connection. The new connection appears on the Connections page.
Using GitHub App Installation
To create the connection you need:
- An API Address
- An Application ID
- An Installation ID
- A GitHub App Private Key (PEM)
Obtaining the credentials
-
In the upper-right corner of any page on GitHub, click your profile photo.
-
Navigate to your account settings.
- For an app owned by a personal account, click Settings.
- For an app owned by an organization:
- Click Your organizations.
- To the right of the organization, click Settings.
-
In the left sidebar, click Applications.
-
Select your application by clicking Configure.
-
You can find your Installation ID at the end of the URL path (github.com/settings/installations/Your Installation ID).
-
Click App settings.
-
Next to Client ID, you will see the client ID for your app.
-
Scroll down to Private keys to generate your App Private Key (PEM). Make sure to paste your key with the RSA labels.
Creating your connection
- In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
- Select the GitHub icon. A dialog box with name of the connection and connection methods appear.
- (Optional) Edit the name of the connection. At a later stage you cannot edit the name.
- Select GitHub App Installation as the method to create the connection.
- Fill in the parameters:
- The API Address
- The Application ID
- The Installation ID
- The GitHub App Private Key (PEM)
- (Optional) Click Test Connection to test it.
- Click Create connection. The new connection appears on the Connections page.
Using SSH
An SSH connection is supported for the use of core.git
To create the connection you need:
- An existing SSH private and public key pair or generate a new one. To generate a new SSH key pair can use the SSH-keygen command.
Obtaining the credentials
You need to upload the public key to GitHub. Do this by following the instructions: Adding a new SSH key to your GitLab account We do not support SSH key with passphrase for the CLI, therefore generate one without a passphrase.
Creating your connection
-
In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
-
Select the SSH icon. A dialog box with name of the connection and connection methods appear.
-
(Optional) Edit the name of the connection. At a later stage you cannot edit the name.
-
Select SSH as the method to make the connection.
-
Fill in the parameters:
- The key
- The passphrase
- The username
-
(Optional) Click Test Connection to test it.
-
Click Create connection. The new connection appears on the Connections page.
Interactive Tutorial Guides
You can also refer to the following tutorial guides for a more in-depth understanding of how to create a GitHub connection.
Was this page helpful?