GitHub Connector

Installation and Configuration

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2018.

All rights reserved. All hardware and software names are brand names and/or trademarks of their respective manufacturers.

These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes or other protected rights. The dissemination, publication or reproduction hereof is prohibited.

For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.


InstallationPermanent link for this heading

Before you install the GitHub connector, you must ensure that the Mindbreeze server is installed and that the GitHub connector is included in the license. Use the Mindbreeze Management Center to install or update the connector.

Plugin installation via Mindbreeze Management CenterPermanent link for this heading

To install the plug-in, open the Mindbreeze Management Center. Select "Configuration" from the menu pane on the left-hand side. Then navigate to the "Plugins" tab. In the "Plugin Management" section, select the appropriate zip file and upload it by clicking the "Upload" button. This automatically installs or updates the connector, as the case may be. In this process, the Mindbreeze services are restarted.

Configuring MindbreezePermanent link for this heading

For configuration, select the installation method "Advanced".

Configuring the index and crawlerPermanent link for this heading

Navigate to the "Indices" tab and click on the "Add new index" icon in the upper right corner to create a new index.

Enter the path to the index and change the display name as necessary.

Add a new data source by clicking the "Add new custom source" icon at the top right. Select the category "GitHub" and configure the data source according to your needs. In the “Storage” section, specify a valid path for the “Storage path” option. This path is used to store the GIT repositories.

In the "Public GitHub Repositories" section, you can specify public GitHub repositories for the GitHub connector to index. To do this, click the "Add Composite Property" icon at the top right and enter the relevant information about the repository:

Owner: owner of the repository

Repository: name of the repository

File branch: the branch that is used to index the files. The master branch is usually used for this purpose.

To index multiple repositories, repeat the procedure.

In the GitHub Enterprise section, you can specify the repositories of your GitHub Enterprise installation to be indexed. To do this, click the "Add Composite Property" icon at the top right and enter the relevant information of the desired GitHub Enterprise repository. In the "Organization URL" field, enter the web address of your GitHub Enterprise installation. In the "Include Pattern" and "Exclude Pattern" fields, you can specify which repositories of your GitHub Enterprise instance are to be indexed by the connector and which are not. To do this, specify the relevant regular expressions. In the "File Branch" field, specify which branch should be used to index the files.

To index multiple GitHub Enterprise installations, repeat the procedure.

Select "Advanced Settings" to change the following settings.

Enable the “Enforce ACL Evaluation” and “Use ACL References” options to enable the use of ACLs.

In order to index repositories of your GitHub Enterprise instance, the access data must be specified. Navigate to the "Network" tab. In the "Credentials" area, click on the "Add Credential" icon to add a new credential. Enter a name for it and choose the type "Username/Password". Enter the access data for your GitHub Enterprise installation in the respective fields.

Then add a new endpoint for the created credential. Click the "Add Endpoint" icon and enter the URL for your GitHub Enterprise instance in "Location". In "Credential", select your previously created credential.

If you want to crawl public GitHub repositories, it is advisable to specify your own credentials, as this increases the request limit. To do this, create appropriate credentials and endpoints for the public repositories. You can specify your own credentials per repository, or you can crawl each repository with the same credential.

For a repository-specific credential, create an endpoint with the GitHub URL of the repository as the location. For a general credential, select "" as the location of the endpoint.