GitHub Connector

Installation und Konfiguration

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2018.

Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.

Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.

Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.

InstallationPermanenter Link zu dieser Überschrift

Vor der Installation des GitHub Konnektors muss sichergestellt werden, dass der Mindbreeze Server installiert und der GitHub Konnektor in der Lizenz inkludiert ist. Zur Installation oder Aktualisierung des Konnektors verwenden Sie bitte das Mindbreeze Management Center.

Installation des Plugins via Mindbreeze Management CenterPermanenter Link zu dieser Überschrift

Zur Installation des Plugins, öffnen Sie das Mindbreeze Management Center. Wählen Sie aus dem linken Menü den Punkt „Configuration“ aus. Anschließend navigieren Sie auf den Reiter „Plugins“. Im Abschnitt „Plugin Management“ wählen Sie die entsprechende Zip-Datei aus laden sie durch Auswahl der Schaltfläche „Upload“ hoch. Damit wird der Konnektor automatisch installiert oder gegebenenfalls aktualisiert. In diesem Zuge werden die Mindbreeze Dienste neugestartet.

Konfiguration von MindbreezePermanenter Link zu dieser Überschrift

Wählen Sie zur Konfiguration die Installationsmethode „Advanced“.

Konfiguration von Index und CrawlerPermanenter Link zu dieser Überschrift

Navigieren Sie auf den Reiter „Indices“ und klicken Sie auf das Symbol „Add new index“ rechts oben, um einen neuen Index zu erzeugen.


Geben Sie den Pfad zum Index ein und ändern Sie gegebenenfalls des Display Name.

Fügen Sie eine neue Datenquelle durch Klick auf das Symbol „Add new custom source“ rechts oben hinzu. Wählen Sie die Category „GitHub“ und konfigurieren Sie die Datenquelle nach Ihren Bedürfnissen. Im Abschnitt „Storage“ geben Sie bei der Option „Storage path“ einen gültigen Pfad an. Dieser Pfad wird zur Ablage der GIT-Repositories verwendet.


Im Bereich „Public GitHub Repositories“ können Sie Öffentliche GitHub Repositories angeben, die der GitHub Konnektor indizieren soll. Dazu klicken Sie auf das Symbol „Add Composite Property“ rechts oben und tragen die relevanten Informationen zu dem Repository ein:

Owner: Besitzer des Repositories

Repository: Name des Repositories

File Branch: Branch, der für die Indizierung der Dateien verwendet wird. Üblicherweise wird hierfür der master Branch verwendet.

Um mehrere Repositories zu indizieren, wiederholen Sie den Vorgang.

Im Bereich „GitHub Enterprise“ können Sie Repositories Ihrer GitHub Enterprise Installation angeben, die indiziert werden sollen. Klicken Sie hierzu auf das Symbol „Add Composite Property“ rechts oben und tragen Sie die relevanten Informationen des gewünschten GitHub Enterprise Repositories ein. Im Feld „Organisation URL“ tragen Sie die Webadresse Ihrer GitHub Enterprise Installation ein. In den Feldern „Include Pattern“ sowie „Exclude Pattern“ geben Sie an, welche Repositories Ihrer GitHub Enterprise Instanz vom Konnektor indiziert werden sollen und welche nicht. Dazu geben Sie entsprechende Reguläre Ausdrücke an. Im Feld „File Branch“ geben Sie an, welcher Branch für die Indizierung der Dateien verwendet werden soll.

Um mehrere GitHub Enterprise Installationen zu indizieren, wiederholen Sie den Vorgang.


Wählen Sie „Advanced Settings“ um die folgenden Einstellungen vorzunehmen.

Aktivieren Sie die Optionen „Enforce ACL Evaluation“ sowie „Use ACL References“, um die Verwendung von ACLs zu ermöglichen.

Um Repositories Ihrer GitHub Enterprise Instanz indizieren zu können, müssen die Zugangsdaten angegeben werden. Navigieren Sie dazu auf den Reiter „Network“. Im Bereich „Credentials“ fügen Sie durch Klick auf das Symbol „Add Credential“ ein neues Credential hinzu. Vergeben Sie einen Namen dafür und wählen Sie als Type „Username/Password“. Tragen Sie die Zugangsdaten für Ihre GitHub Enterprise Installation in den entsprechenden Feldern ein.

Anschließend fügen Sie einen neuen Endpoint für das erstellte Credential hinzu. Klicken Sie auf das Symbol „Add Endpoint“ und tragen bei „Location“ die URL zu Ihrer GitHub Enterprise Instanz ein. Wählen Sie bei „Credential“ Ihr vorhin erstelltes Credential aus.

Wenn Sie öffentliche GitHub Repositories crawlen möchten, ist es ratsam, dafür eigene Credentials anzugeben, da damit das Requestlimit erhöht wird. Erstellen Sie dazu für die öffentlichen Repositories entsprechende Credentials und Endpoints. Sie können pro Repository ein eigenes Credentials angeben, oder jedes Repository mit dem gleichen Credential crawlen.

Bei einem repositoryspezifischem Credential, erstellen Sie einen Endpoint mit der GitHub-URL des Repositories als Location. Für ein allgemeines Credential wählen Sie „https://github.com“ als Location des Endpoints aus.