Zum Hauptinhalt gehen
 

Wie können wir helfen?

Suche

Beiträge in diesem Abschnitt
Weitere anzeigen

[en] Install Acrolinx for Azure DevOps (ADO) Git

  • Aktualisiert

Bevor Sie diese Version von Acrolinx 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.

Wenn Sie wissen möchten, ob diese Version von Acrolinx für ADO Git mit Ihren lokalen Plattformen kompatibel ist, lesen Sie unseren Kompatibilitätsleitfaden.

Acrolinx-Systemanforderungen

Stellen Sie für die Installation des Webhook-Servers sicher, dass Ihr Hostsystem über Folgendes verfügt:

  • 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.

    Anmerkung

    Sehr große Dokumente oder eine sehr große interne Ereigniswarteschlange erfordern möglicherweise mehr Arbeitsspeicher.

Installieren

Wählen Sie zunächst einen Computer zum Hosten von Acrolinx, der über die Azure DevOps Cloud erreichbar ist. Wir gehen von einem POSIX-ähnlichen Betriebssystem aus.

Generieren Sie ein Zugriffstoken in Azure DevOps

  1. Wählen Sie ein Azure DevOps-Dienstkonto für diese Integration aus und wählen Sie oben rechts Benutzereinstellungen Benutzereinstellungen-Symbol oben rechts im Azure DevOps-Fenster.

  2. Gehen Sie im Dropdown-Menü zu Persönliche Zugriffstoken und klicken Sie auf Neues Token.

  3. Benennen Sie Ihr Token, wählen Sie die Organisation aus, in der Sie das Token verwenden möchten, und legen Sie dann fest, dass Ihr Token nach einer festgelegten Anzahl von Tagen automatisch abläuft.

    Der aktuell benötigte Geltungsbereich für Ihr Token umfasst:

    • Code: Lesen und Status.

    • Pull-Request-Threads: Lesen und Schreiben.

    Aus Sicherheitsgründen ist es am besten, diesen Geltungsbereich nicht zu erweitern.

    Klicken Sie auf Erstellen und kopieren Sie das Token.

Generieren Sie ein Zugriffstoken in GitHub

  1. Wählen Sie in GitHub ein Dienstkonto für diese Integration aus (Sie benötigen es für die globale Remote-Konfiguration) und gehen Sie zu Einstellungen > Entwicklereinstellungen.

  2. Klicken Sie auf Persönliche Zugriffstoken > Neues Token generieren. Geben Sie eine klare Beschreibung ein und wählen Sie alle Berechtigungen im repo-Bereich aus. Beschränken Sie das Token auf das Repository, das die globale Remote-Konfiguration hostet.

  3. Klicken Sie auf Token generieren und kopieren Sie Ihr neues Token.

Starten Sie den Dienst

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

  2. 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.

    • Für Azure DevOps:

      • Fügen Sie Ihr Token als :ado-token hinzu.

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

    • Für GitHub:

      • Fügen Sie Ihr Token als :gh-token hinzu.

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

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

      Tipp

      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 Ihr persönliches Zugriffstoken die richtige Konfiguration hat. Es überprüft auch, ob der Token-Inhaber die richtigen Berechtigungen hat (die Rolle „Autor“).

  3. Erstellen Sie eine Protokollkonfigurationsdatei mit Debug-Einstellungen. Sie können eine Beispieldatei für die Protokollkonfiguration erstellen, indem Sie Acrolinx mit der Befehlszeilenoption --sample-log ausführen. Weitere Informationen finden Sie in unserem Artikel zur Protokollierung und Überwachung.

  4. Starten Sie Acrolinx für GitHub.

Installieren Sie einen Webhook

Sie müssen für jedes Repository, das Sie mit Acrolinx verwenden, einen Webhook konfigurieren. Sie können auch einen Webhook mit Zugriff auf alle Repositories konfigurieren, auf die das Dienstkonto zugreifen kann.

Konfigurieren Sie die Diensthaken-Benachrichtigungen

Um Ihre Diensthaken-Benachrichtigungen zu erstellen, gehen Sie wie folgt vor:

  1. Gehen Sie zu Projekteinstellungen > Diensthaken > Abonnement erstellen. Wählen Sie den Web Hooks-Dienst aus und klicken Sie auf Weiter.

  2. Wählen Sie unter Bei diesem Ereignistyp auslösen auf der Seite Auslöser Pull-Request erstellt aus.

    • Optional: Beschränken Sie das Diensthaken-Abonnement auf ein einzelnes Repository.

    • Optional: Beschränken Sie den Zielbranch. Wenn Sie jeden Pull-Request zum Zusammenführen in einem einzelnen Zielbranch ausstellen, geben Sie hier den Namen des Branches ein.

    Klicken Sie auf Weiter.

  3. Auf der Seite Aktion:

    • Setzen Sie die URL auf die URL des Azure DevOps-Integrations-Webhooks. Diese URL muss mit /listen enden. Die Verwendung von TLS (https-Protokoll) zur Verbindung mit dem Webhook ist zum Schutz des Azure DevOps-Geheimnisses zwingend erforderlich.

    • Setzen Sie den Benutzernamen für die Basisauthentifizierung auf das Wort secret.

    • Geben Sie das Azure DevOps-Geheimnis als Passwort für diesen Benutzer in das Feld Passwort für die Basisauthentifizierung ein.

    • Setzen Sie Zu sendende Ressourcendetails auf Alle.

    • Setzen Sie Zu sendende Nachrichten und Zu sendende detaillierte Nachrichten auf Keine.

  4. Klicken Sie auf Fertig stellen.

  5. Gehen Sie zu Projekteinstellungen > Diensthaken > Abonnement erstellen. Wählen Sie den Web Hooks-Dienst aus und klicken Sie auf Weiter.

  6. Wählen Sie Pull-Request aktualisiert und wiederholen Sie die Schritte 3 und 4.

Um die Webhook-Konfiguration zu testen, müssen Sie einen Pull-Request erstellen oder aktualisieren.

Integrieren in Systemd

Wenn Sie möchten, dass Acrolinx beim Booten startet und nach einem Absturz neu startet, können Sie eine Dienstbeschreibung für systemd verwenden. Dazu extrahieren Sie acrolinx-githubhook.service aus der JAR-Datei. Zum Beispiel: jar xf githubhook-1.7.0.jar acrolinx-githubhook.service.

  1. 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 zu verweisen.

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

  3. 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 verfügbaren Befehlszeilenoptionen zeigen Sie die Hilfe auf der Befehlszeile an:

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