Link a GitHub account to Domino

Linking your GitHub account to Domino allows you to store and manage project code in a GitHub repository. This guide explains how to create a GitHub Personal access token (PAT), add it to Domino, and confirm that the integration works.

Prerequisites

Before you begin, make sure you have:

  • Access to a Domino environment.

  • A Domino user account (or the ability to create one using Sign up).

  • A GitHub account that you can use for the setup.

  • Permissions in GitHub to create personal access tokens.

Step 1: Log into Domino

To start, you need to sign into your Domino environment. This is where you’ll connect your account to GitHub.

  1. Go to your Domino environment URL in a browser.

  2. Enter your assigned username and password.

  3. If you do not have credentials, click Sign up to create an account.

Step 2: Create a GitHub Personal Access Token (PAT)

Next, you’ll generate a personal access token in GitHub. This token acts as a secure key that Domino will use to talk to your GitHub account.

  1. In a separate browser tab, log into GitHub.

  2. Click your profile icon in the top-right corner and click Settings.

  3. In the left-hand menu, select Developer settings.

  4. Select Personal access tokens > Tokens (classic).

  5. Click Generate new token > Generate new token (classic).

Step 3: Configure the PAT

When you create the token, you’ll decide which permissions it should have. For a quick setup, granting all scopes is easiest. If you prefer, you can limit scopes to just repo and workflow, which are enough for Domino to work properly.

  1. Add a brief description in the Note field.

  2. Choose an expiry for the token.

  3. Select the scopes you want the token to have.

  4. Click Generate token.

  5. Copy the token and save it in a secure text file on your local machine.

Step 4: Add GitHub credentials to Domino

With your token ready, the next step is to tell Domino about it. You’ll add the token as part of your account credentials.

Alt text
  1. Return to Domino.

  2. Click Account in the top-right corner and select Account Settings.

  3. From the Account Settings panel, select Git Credentials.

  4. Click Add Git credentials.

  5. Enter the required fields, including the PAT you generated.

  6. Click Add credentials.

Your GitHub PAT is now linked to your Domino account.

Step 5: Test the integration

It’s time to make sure everything works. You’ll do this by creating a test project in Domino and linking it to a newly created GitHub repository.

  1. In Domino, go to the Home screen.

  2. Click Create Project.

  3. Enter a project name, such as test.

  4. In the Code section, select Git Service Provider as the code hosting service.

  5. From the Service Provider dropdown, select GitHub.

    • Your GitHub credentials will be automatically selected in the Git Credentials dropdown if you added them earlier.

  6. Select the Owner/Organization where the new GitHub repository will be created

  7. Enter a Repository Name.

  8. Choose the Repository Visibility setting (Public or Private).

  9. Click Create.

Step 6: Verify the setup

Once the project is created, Domino will have created a repository in GitHub that is now linked to the project. This confirms that your credentials and token are working correctly.

If the PAT is configured properly, Domino will:

  • Create a new Domino project.

  • Create a new GitHub repository.

  • Link the two together.

Troubleshooting

Sometimes the setup doesn’t go smoothly. If you run into issues, here are a few common things to check:

  • Invalid or expired token

    • Make sure you copied the entire PAT when you generated it.

    • If the token has expired, generate a new one and update your Domino Git Credentials.

  • Missing scopes

    • If repository creation fails, verify that your PAT includes at least the repo and workflow scopes.

    • For evaluation setups, selecting all scopes avoids scope-related errors.

  • Incorrect credentials in Domino

    • Open Account Settings > Git Credentials.

    • Confirm that the saved username matches your GitHub account and the token is correct.

  • Network or access restrictions

    • Verify that your Domino environment can reach github.com.

    • If using an enterprise firewall or VPN, confirm that GitHub is not being blocked.

You’ve now linked your GitHub account to Domino and verified the connection by creating a test project and repository. With this setup, Domino can automatically create and manage GitHub repositories for your projects, keeping your code versioned and accessible.

Next steps