Installing the Add-ons Service on a Windows machine

You can install the Add-ons Service as a Windows service or as a standalone process on a Windows machine that does not contain Content Manager server.

Before you begin

If you want to run the service on a port other than 83, or if you want to enable HTTPS for the service, modify appsettings.json.

Procedure

  1. Open a PowerShell console on your Windows machine and navigate to the Add-on Service\ folder you copied.
  2. Install the Add-ons Service as either a Windows service or process, as follows:
    • To install as a Windows service, run the following command:
      & .\installService.ps1 -InstallationDir DIRNAME

      where DIRNAME is the target directory in which you want to install the service.

      For example:
      & .\installService.ps1 -InstallationDir C:\MyAddon

      If you omit the InstallationDir switch, the target directory defaults to %Program Files%\RWS\Tridion\Add-on Service\.

    • To install as a standalone Windows process, run the following command:
      & .\start.ps1

      You can stop the process at any time by running the & .\stop.ps1 command.

  3. After installation has finished, configure permissions on the Key\ folder.

    As part of the installation process, the installation script encrypted appsettings.json and stored encrypted information in a newly created folder.

    1. Go to the directory in which Add-ons Service was installed and find this subfolder: bin\Key\
    2. Configure the folder with the following permissions:
      • For a Windows service, grant full access to the Local System account.
      • For a Windows process, grant full access to the user account that ran this script.
      • Regardless of whether installed as a service or a process, restrict folder access for all other users.

Results

The service is installed and the settings in appsettings.json are encrypted. Any further changes you wish to make to this file require you to decrypt the file before you modify it, and re-encrypt the file after you have modified it.