Using a private VCS

As introduced in Authenticating GitHub Access with a Private VCS Repository, you may be using a locally deployed version of your VCS. Continuing to use GitHub as the example, here is how you set up to review repositories managed by GitHub Enterprise. If you are using GitLab Enterprise as your local VCS, refer to Authenticating GitLab Access with a Private VCS Repository for details on how to configure it for use with the Navigator.

This will bring up the popup showing all of the private repositories that you may have configured and offer you the choice of configuring access either via OAuth or using your private PAT. If this is the first time that you have selected GitHub Enterprise as the VCS, there will be no servers displayed. In this first example, we will create a new server which we will authenticate using OAuth.

Clicking on Add New OAuth Info brings up the OAuth configuration window where you set up the entries needed to locate the server and authenticate it with your OAuth credentials.

Set the name to anything you like. In this example we’ll call it “Private GitHub”.

Then, insert the URL to your private GitHub Enterprise Server. For our example, we have created a URL named github.openrefactory.com. Note that you must add the https:// prefix to the URL to reach your server properly.

Finally, from the OAuth setup described in Authenticating GitHub Access using OAuth, you created a new Client ID and Secret key. Copy those from that window and paste them here.

If you have chosen to authenticate using your private PAT, the above process is a little different. In this case, selecting GitHub Enterprise will again bring up the popup showing all of the private repositories. However, this time, we will choose Add New PAT info. This brings up the popup asking for the PAT information.

Clicking on Add New PAT Info brings up the PAT configuration window where you set up the entries needed to locate the server and authenticate it with your PAT token.

As in the OAuth example, we’ll set the name to “Private GitHub”. Insert the URL to your private GitHub Enterprise Server. We'll use the same URL we used for the OAuth example: github.openrefactory.com.

Finally, as described in Authenticating GitHub Access using PAT, enter the PAT you created from that step.

Once the credentials are set, you may use that private repository by re-selecting GitHub Enterprise from the Select Repository pull-down menu. You will now see the one we just added: Private GitHub.

You will also notice that there are 3 new icons offered to allow you to:

• Get Repositories Fetch the list of repositories for the selected Enterprise server
• Edit Info Change the GitHub OAuth or PAT credentials
• Remove Remove this private VCS from iCR

Click on Get Repositories to see all of your GitHub Enterprise repositories.

From here, everything works the same as outlined in Selecting your branch for the cloud-based VCS.