GitHub Account

Last updated 3 months ago

Clusterone supports integration with GitHub. This way, you can use code from your GitHub repositories directly in Clusterone projects without having to check them out on your local machine first. Keep in mind - even if you don't hook your GitHub account up to Clusterone, you can still use code from public GitHub repositories.

This page provides a step-by-step guide how to connect your GitHub account to Clusterone. Connecting your accounts is fast and easy, it shouldn't take you longer than a few minutes!

On GitHub

On GitHub, you have to create a personal access token. Clusterone needs this token to authenticate with the GitHub servers and interact with it.

If you're using GitHub Enterprise, make sure that Clusterone is linked to your team's GitHub Enterprise server before continuing!

1. Open your GitHub settings

Go to your GitHub homepage, click on your profile picture in the top right and open Settings.

2. Open Developer Settings

At the bottom of the settings menu on the left, click Developer Settings.

3. Choose personal access token

Select the Personal access tokens link on the left. On that page, click the Generate new token button on the right.

4. Generate a new token

Choose a name for the token (e.g. "Clusterone"), then grant the token "repo" and "admin:repo_hook" permissions. This will enable Clusterone to read your repositories and detect new commits. Click the Generate Token button at the bottom to create the token.

5. Copy the token

Select the token and copy it. Alternatively, you can click the blue icon next to the token to automatically copy it to the clipboard.

On Clusterone

Now, all you need to do is to enter the token you just created into Clusterone.

6. Access your account settings

Open the Clusterone Matrix and click on your username in the top right. From the drop-down menu, select Access Keys.

7. Paste the GitHub token

Find the GitHub section and add your username and your token.

Congratulations, you have successfully connected your GitHub account to Clusterone! Now you can create projects from your GitHub repositories. When adding a new project, simply click Link GitHub repository and select the repository you want to link.

See our documentation page about GitHub projects for more information.