Using GitHub Enterprise Cloud or GitHub.com? Go take a look at the GitHub.com documentation instead. If you are running your own GitHub Enterprise server, this is how you can get started.

To connect GitHub Enterprise with Unblocked, you need to be on the Enterprise Plan. You can view all the features of Unblocked’s plans on our pricing page.

Unblocked exists to answer questions about your application, so it leverages your codebase as a primary source for explaining how your application works. When you connect Unblocked with your GitHub Enterprise organization, you enable a critical data source for answers. You’ll get a few extra, first-class features too:

  1. Unblocked refreshes your team’s data index as you make changes to your codebase. This means that answers to questions will reflect the latest updates to your codebase, while also taking into account your code’s history.
  2. Any relevant Pull Requests or Issues will also be referenced throughout Unblocked to refer to alongside the discussions you or your teammates have with Unblocked. As your team works on parts of your codebase, Unblocked provides notifications for and quick access to Pull Request discussions that people are participating in. This is specifically something you’ll notice in the Mac app or in the IDE extensions.

​
Connect your organization and repositories

You need to be an owner of a GitHub organization in your Enterprise to install the Unblocked GitHub App. You do not need to be an administrator of the Enterprise.

​
Sign in to Unblocked

Whether you sign in with GitHub credentials, another code repository, or your SSO provider, you first need to authenticate to Unblocked. To authenticate with your Github Enterprise server, click to View Enterprise Options to get started.

​
Authorize the Unblocked app

Before proceeding to your GitHub Enterprise server, you need to first provide Unblocked with the hostname where you are hosting it.

If you have restricted network access to your host, you may need to allow Unblocked to access it.

Once you provide the hostname of your GitHub server, you also need to tell Unblocked the name of the organization you will be using with Unblocked.

Clicking Create GitHub App will redirect you to your GitHub Enterprise server, where you can create the GitHub App that Unblocked will use.

After saving the name of the application, you’ll be asked to grant some basic permissions to Unblocked. This does not install Unblocked on your GitHub account, but rather sets up a user account on Unblocked.

​
Connect your repositories

Once you’ve given access to your GitHub account, Unblocked still needs to know which repositories you want it to answer questions about.

After clicking Grant Access in GitHub, you’ll be redirected back to GitHub, where you’ll be prompted to select the organization or account you want to install Unblocked into.

If your GitHub Enterprise organization has multiple repositories, you have the option to select the repositories shared with Unblocked. For ease of configuration in the future, we recommend sharing all repositories with Unblocked, but you can provide a narrower scope if necessary. Once you save your settings here, Unblocked will start ingesting your code to build your team’s data index for answering questions.

​
Generating a model for answering questions

Once Unblocked has fully processed the information associated with your GitHub Enterprise repositories, you can start asking questions. Unblocked’s responses include information from your code as well as discussions you’ve had with your teammates about it.

If your repositories have a lot of code, documentation, and discussions, then data ingestion may take longer to process. However, Unblocked will keep you updated as it builds an understanding of your codebase and documentation.

​
Managing connected repositories

If you decide at a later time that you want to adjust the repositories that Unblocked can access, you can always add or remove connected sources. First, select Data Sources in the sidebar, then select GitHub.

In this view, you’ll be able to select or unselect any repository that Unblocked has access to. If there is a repository you expect to see in the list but isn’t showing, click the GitHub Repositories link. This will take you to the settings for the Unblocked GitHub application on your Enterprise server.

From this page you can adjust the repository access settings to include all repositories on your GitHub Enterprise organization, or select specific repositories.

Once you save these settings, you can return to the Unblocked web interface and select the repositories you wish to include in your Unblocked instance.

​
Continuing Set Up

While it is certainly possible to use Unblocked without incorporating any further data sources, we strongly encourage you to include as many other systems in which you have documented or even discussed your applications. If you’re using Unblocked’s Enterprise plan, you can also connect other source code management systems to your Unblocked workspace.

GitHubGitLab