Zum Hauptinhalt gehen
 

Wie können wir helfen?

Suche

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

  • Aktualisiert

[en] Before you install this version of Acrolinx, make sure that you already have the following:

[en] GitHub and ADO Git

[en] GitHub and ADO Git Versions

[en] Acrolinx for GitHub and ADO Git Versions

[en] Notes

[en] Supported

[en] Maintained

[en] Deprecated

[en] Support for Acrolinx AI Assistant and Suggestions

[en] Latest versions of GitHub and ADO Git

4.2.6

4.2.5

[en] 4.2.4 and earlier

--

[en] JRE 11 or later is required for Acrolinx for GitHub and ADO Git versions 4.2.3 and later.

[en] If you want to know whether this version of Acrolinx for ADO Git is compatible with your local platforms, check our Compatibility Guide.

[en] Acrolinx system requirements

[en] For the webhook server installation, make sure that your host system has the following:

  • [en] JRE 8 (Oracle or OpenJDK)

    Anmerkung

    [en] For Acrolinx for Git Hosting versions 4.2.3 and later, JRE 11 or later is required.

  • [en] We recommend 1 GB of RAM.

    Anmerkung

    [en] Very large documents or a very large internal event queue might require more memory.

[en] Install

[en] To get started, choose a computer to host Acrolinx that's accessible from the Azure DevOps Cloud. We assume a POSIX-like operating system.

[en] Generate an access token in Azure DevOps

  1. [en] Select a Azure DevOps service account to use for this integration and select User settings User settings icon from top-right of Azure DevOps window in the top right.

  2. [en] Go to Personal access tokens in the dropdown and click New Token.

  3. [en] Name your token, select the organization where you want to use the token, and then set your token to expire automatically after a set number of days.

    [en] The current needed scope for your token includes:

    • [en] Code: read and status.

    • [en] Pull request threads: Read and write.

    [en] For security reasons, it's best not to extend this scope.

    [en] Click Create and copy the token.

[en] Generate an access token in GitHub

  1. [en] In GitHub, select a service account to use for this integration (you’ll need it for the remote global configuration) and go to Settings > Developer settings.

  2. [en] Click Personal access tokens > Generate new token. Give it a clear description and select all permissions in the repo scope. Limit the token to the repository that hosts the remote global configuration.

  3. [en] Click Generate token, and copy your new token.

[en] Start the service

  1. [en] On the new computer, create a dedicated operating system user for Acrolinx, for example "acrolinx."

  2. [en] Create the file /home/acrolinx/.config/Acrolinx/githubhook/acrolinx-githubhook.edn or /home/acrolinx/.config/Acrolinx/githubhook/acrolinx-githubhook.json and all the directories in its path.

    • [en] For Azure DevOps:

      • [en] Add your token as :ado-token

      • [en] Create a (complicated) shared secret and add it as :ado-secret.

    • [en] For GitHub:

      • [en] Add your token as :gh-token

    • [en] Configure access to your instance of Acrolinx by adding :acrolinx-url and :acrolinx-auth-token (an API token from Acrolinx).

    • [en] Configure your Guidance Profile using :guidance-profile. For more information, see Connect to Acrolinx

      Tipp

      [en] Before you configure your Guidance Profile, you can test the connection to Acrolinx and pull information from it with the --acrolinx-capabilities command. This confirms that your personal access token has the right configuration. It also verifies that the token owner has the right permissions (the role “author”).

  3. [en] Create a log configuration file with debug settings. You can create a sample file for the log configuration by running Acrolinx with the --sample-log command-line option. For more details, see our article on logging and monitoring.

  4. [en] Start Acrolinx for GitHub.

[en] Install a webhook

[en] You need to configure a webhook for each repository that you’ll use with Acrolinx. You can also configure a webhook with access to all repositories the service account can access.

[en] Configure the service hook notifications

[en] To create your service hook notifications, do the following:

  1. [en] Go to Project settings > Service hooks > Create subscription. Select the Web Hooks service and click Next.

  2. [en] Select Pull request created under Trigger on this type of event on the Trigger page.

    • [en] Optional: restrict the Service Hook Subscription to a single repository.

    • [en] Optional: restrict the Target Branch. If you issue each pull request to be merged on a single target branch, enter the name of the branch here.

    [en] Click Next.

  3. [en] On the Action page:

    • [en] Set URL to the URL of the Azure DevOps integration webhook. This URL must end with /listen. The use of TLS (https protocol) to connect with the webhook is mandatory to protect the Azure DevOps secret.

    • [en] Set Basic authentication username to the word secret.

    • [en] Enter the Azure DevOps secret as the password for this user in the Basic authentication password field.

    • [en] Set Resource details to send to All.

    • [en] Set Messages to send and Detailed messages to send to None.

  4. [en] Click Finish.

  5. [en] Go to Project settings > Service hooks > Create subscription. Select the Web Hooks service and click Next.

  6. [en] Select Pull request updated and repeat steps 3 and 4.

[en] To test the webhook configuration, you'll need to create or update a pull request.

[en] Integrate in Systemd

[en] If you want Acrolinx to start at boot time and restart after a crash, you can use a service description for systemd. You'll do this by extracting acrolinx-githubhook.service from the JAR file. For example: jar xf githubhook-1.7.0.jar acrolinx-githubhook.service.

  1. [en] On a production system, copy the service file to /etc/systemd/system and edit the path to point to the correct JAR and user.

  2. [en] Call systemctl enable acrolinx-githubhook to enable starting at boot.

  3. [en] Call systemctl start/stop acrolinx-githubhook to start/stop the service.

[en] This only applies to Linux systems that use systemd (as opposed to Upstart or SysVinit).

[en] Command line options

[en] For a description of the available command-line options, display help on the command line:

[en] java -jar githubhook-[versionnumber].jar --help