Zum Hauptinhalt gehen
 

Wie können wir helfen?

Suche

Beiträge in diesem Abschnitt
Weitere anzeigen

[en] Install, Uninstall, or Update Acrolinx for GitHub

  • Aktualisiert

Bevor Sie diese Version von Acrolinx für GitHub installieren, stellen Sie sicher, dass Sie bereits über Folgendes verfügen:

Kompatibilitätsmatrix
Unterstützte GitHub- und ADO-Git-Versionen Unterstützt Gewartet Veraltet Unterstützung für Acrolinx KI-Assistent und Vorschläge Hinweise
Neueste Versionen von GitHub und ADO Git 5.0.0 4.2.7 4.2.6 und früher -- JRE 11 oder höher ist für Acrolinx für GitHub und ADO Git Version 4.2.3 und später erforderlich.

Lesen Sie unseren Kompatibilitätsleitfaden, wenn Sie wissen möchten, ob diese Version von Acrolinx für GitHub mit Ihren lokalen Plattformen funktioniert.

Installieren

Um Acrolinx für GitHub zu installieren, gehen Sie wie folgt vor:

  1. Bereiten Sie einen Computer vor, auf dem Acrolinx für GitHub gehostet werden kann und der von Ihrer GitHub-Instanz (Cloud oder On-Premise) erreichbar ist. Wir gehen von einem POSIX-ähnlichen Betriebssystem aus.

  2. Wählen Sie ein GitHub-Konto für diese Integration aus und besuchen Sie die Einstellungsseite.

    1. Wählen Sie Entwicklereinstellungen.

    2. Gehen Sie zu Persönliche Zugriffstoken.

    3. Erstellen Sie ein neues Token. Geben Sie ihm eine klare Beschreibung und aktivieren Sie alle Berechtigungen im repo-Bereich.

    4. Laden Sie das Token herunter.

  3. Wenn es sich um Ihr Konto handelt, müssen Sie Schreibzugriff auf jedes Repository haben, in dem Sie diese Integration verwenden.

  4. Erstellen Sie auf dem neuen Computer einen dedizierten Betriebssystembenutzer für Acrolinx für GitHub, zum Beispiel „acrolinx“.

  5. Erstellen Sie die Datei /home/acrolinx/.config/Acrolinx/githubhook/acrolinx-githubhook.edn oder /home/acrolinx/.config/Acrolinx/githubhook/acrolinx-githubhook.json und alle Verzeichnisse in ihrem Pfad.

  6. Fügen Sie Ihr Token als :gh-token hinzu. Erfahren Sie, wie Acrolinx mit feingranularen persönlichen Zugriffstoken funktioniert.

  7. Erstellen Sie ein (kompliziertes) gemeinsames Geheimnis und fügen Sie es als :gh-secret hinzu.

  8. Konfigurieren Sie den Zugriff auf Ihre Acrolinx-Instanz, indem Sie :acrolinx-url und :acrolinx-auth-token (ein API-Token aus dem Acrolinx-Dashboard) hinzufügen.

  9. Konfigurieren Sie Ihr Guidance Profile mit :guidance-profile. Weitere Informationen finden Sie unter Mit Acrolinx verbinden.

    Bevor Sie Ihr Guidance Profile konfigurieren, können Sie die Verbindung zu Acrolinx testen und Informationen daraus abrufen, indem Sie den Befehl --acrolinx-capabilities verwenden. Dies bestätigt, dass das persönliche Zugriffstoken korrekt konfiguriert ist. Es überprüft auch, ob der Inhaber des Tokens die erforderlichen Rechte (die Rolle „Autor“) auf der Acrolinx-Plattform hat.

  10. Erstellen Sie eine Protokollkonfigurationsdatei mit Debug-Einstellungen. Siehe den Abschnitt „Protokollierung“. Sie können eine Beispieldatei für die Protokollkonfiguration erstellen, indem Sie Acrolinx für GitHub mit der Befehlszeilenoption --sample-log ausführen.

  11. Starten Sie Acrolinx für GitHub.

Webhook-Installation

Als GitHub-Administrator müssen Sie für jedes Repository, das Sie mit Acrolinx für GitHub verwenden, einen Webhook konfigurieren. Sie können dies entweder automatisieren oder manuell durchführen.

Acrolinx-Systemanforderungen

Die Mindestanforderung für die Installation des Webhook-Servers ist ein Computer mit den folgenden Merkmalen:

  • JRE 8 (Oracle oder OpenJDK)

    Anmerkung

    Für Acrolinx für Git-Hosting-Versionen 4.2.3 und höher ist JRE 11 oder höher erforderlich.

  • Wir empfehlen 1 GB RAM. Sehr große Dokumente oder eine sehr große interne Ereigniswarteschlange erfordern möglicherweise mehr Arbeitsspeicher.

Automatisiert

  1. Erstellen Sie eine Installationsdatei. Die Installationsdatei muss im EDN-Format vorliegen und eine Hash-Map mit den folgenden Schlüsseln enthalten:

    :gh-admin-token: Ein GitHub-API-Token mit Administratorberechtigungen für jedes Repository, dem der Webhook hinzugefügt wird.

    :api-base-url: Die Basis-URL der GitHub-API. Für http://github.com ist dies "https://api.github.com/", aber sie unterscheidet sich für eine On-Premise-Installation von GitHub.

    :hook-url: Die URL, die Acrolinx für GitHub adressiert.

    :gh-secret: Das gemeinsame Geheimnis. Dies sind sensible Daten. Stellen Sie sicher, dass Sie sie gut schützen.

    :repos: Eine verschachtelte Hash-Map, die die Repository-Koordinaten als Schlüssel und die gewünschten Ereignisse als Werte enthält.

    Rufen Sie dieses Programm auf der Befehlszeile mit der Option --sample-install auf, um eine Beispiel-Installationsdatei zu erstellen.

  2. Führen Sie dieses Programm von der Befehlszeile mit der Option --install-hook aus und geben Sie die Installationsdatei als Argument an.

    java -jar githubhook.jar --install-hook install-admin.edn

Manuell

Wenn Sie die Webhooks lieber manuell konfigurieren möchten, gehen Sie wie folgt vor:

  1. Besuchen Sie die Einstellungsseite Ihres Repositorys und fügen Sie einen Webhook hinzu.

  2. Richten Sie die Payload-URL auf Ihren Computer (falls zutreffend) unter Verwendung des richtigen Ports, zum Beispiel: http://yourmachine.example:9779/listen/

  3. Aktivieren Sie Lassen Sie mich einzelne Ereignisse auswählen und wählen Sie Pull-Request und/oder Push, je nach Anwendungsfall. Beachten Sie, dass Sie Acrolinx für GitHub so konfigurieren können, dass nur bestimmte Ereignisse akzeptiert werden, indem Sie :allowed-event-types in der Konfiguration angeben.

  4. Fügen Sie Ihr gemeinsames Geheimnis hinzu.

Wenn Sie die Webhook-Konfiguration speichern, wird ein PING-Ereignis an Acrolinx für GitHub gesendet. Sie können Probleme in GitHub im Abschnitt Neueste Lieferungen der Webhook-Konfigurationsseite debuggen. Auf der Empfängerseite sehen Sie sich die (Debug-)Protokollierung dieses Programms an.

Integrieren in Systemd

Um Acrolinx für GitHub zu ermöglichen, beim Booten zu starten und nach einem Absturz neu zu starten, ist eine Dienstbeschreibung für systemd verfügbar: Extrahieren Sie acrolinx-githubhook.service aus der JAR-Datei (zum Beispiel jar xf githubhook-1.7.0.jar acrolinx-githubhook.service).

  • Auf einem Produktionssystem kopieren Sie die Dienstdatei nach /etc/systemd/system und bearbeiten Sie den Pfad, um auf die richtige JAR-Datei und den richtigen Benutzer usw. zu verweisen.

  • Rufen Sie systemctl enable acrolinx-githubhook auf, um den Start beim Booten zu aktivieren.

  • Rufen Sie systemctl start/stop acrolinx-githubhook auf, um den Dienst zu starten/stoppen.

Dies gilt nur für Linux-Systeme, die systemd verwenden (im Gegensatz zu Upstart oder SysVinit).

Befehlszeilenoptionen

Für eine Beschreibung der Befehlszeilenoptionen, die Sie verwenden können, zeigen Sie die Hilfe auf der Befehlszeile an:

java -jar githubhook-[versionsnummer].jar --help

Deinstallieren

Um Acrolinx für GitHub zu deinstallieren, müssen Sie den mit Acrolinx verbundenen Webhook aktualisieren. Befolgen Sie die Anweisungen unter Globale Webhooks verwalten in den GitHub-Dokumenten.