Skip to content

Installation

DJBenson edited this page Dec 23, 2020 · 10 revisions

Installing the Transport Agent

Online Install

  1. Download the latest GUI package: https://github.com/Pro/dkim-exchange/releases/latest (Configuration.DkimSigner.zip)
  2. Extract it somewhere on your Server (e.g. Desktop)
  3. Start Configuration.DkimSigner.exe
  4. Select Install
  5. In the new opened window, select the version you like to install. If you want to install a prerelease version, check the corresponding box
  6. Press install and wait until the installation successfully finished, then close the window.
  7. Now configure the DKIM Signer with the installed GUI (located under "C:\Program Files\Exchange DkimSigner\Configuration.DkimSigner.exe"
  8. Once you save the config, the Signer Agent will automatically reload these changes

Offline Install

  1. Download the latest GUI package: https://github.com/Pro/dkim-exchange/releases/latest (Configuration.DkimSigner.zip)
  2. Download the whole project package: https://github.com/Pro/dkim-exchange/releases/latest (Source Code (zip))
  3. Move those two packages to your server and extract the Configuration.DkimSigner.zip package to your Desktop
  4. Start Configuration.DkimSigner.exe
  5. Select Install
  6. In the new opened window, browse for the downloaded DkimSigner.zip and press Install
  7. wait until the installation successfully finished, then close the window.
  8. Now configure the DKIM Signer with the installed GUI (located under "C:\Program Files\Exchange DkimSigner\Configuration.DkimSigner.exe"
  9. Once you save the config, the Signer Agent will automatically reload these changes

Manual Install

If you have problems installing the agent using the options above, you can use the powershell script. Just follow these instructions:

  1. Download the .zip and extract it e.g. on the Desktop: Latest Release
  2. Open "Exchange Management Shell" from the Startmenu
  3. Check your current execution policy and remember it for the last step Get-ExecutionPolicy –List
  4. Execute the following command to allow execution of local scripts (will be reset at last step): Set-ExecutionPolicy Unrestricted
  5. Cd into the folder where the zip has been extracted.
  6. Execute the install script .\install.ps1
  7. Follow the instructions. For the configuration see next section.
  8. Reset the execution policy to the value from step 3. E.g., Set-ExecutionPolicy RemoteSigned or Set-ExecutionPolicy Restricted
  9. Check EventLog for errors or warnings. Hint: you can create a user defined view in EventLog and then select "Per Source" and as the value "Exchange DkimSigner"

Make sure that the DkimSigner Agent has a "low priority" (high priority number) so that it runs after other agents which might modify the headers. Best to set it to lowest priority (highest number). To get a list of all the Export Agents use the Command Get-TransportAgent To change the priority use Set-TransportAgent -Identity "Exchange DkimSigner" -Priority 3

Command Line Arguments

The Configuration.DkimSigner.exe file allows a number of command line options which are analogous to the above options.

Configuration.DkimSigner.exe --install

This will launch the GUI mode installer which allows the selection between online and offline installation as mentioned above

Configuration.DkimSigner.exe --uninstall

This will launch the GUI mode uninstaller (see also: Uninstalling)

Configuration.DkimSigner.exe --debug

This will launch the GUI in debug mode

NOTE: In all cases the application will now check both for the presence of Exchange Server and also of the transport agent. How the application responds depends upon the scenario;

Exchange is not installed/detected

This will almost certainly result in the application crashing. This is trapped and handled as gracefully as possible such that the GUI still shows up but it will be almost entirely unusable (but better than a .NET error...)

Exchange is installed but the application is not installed and/or the transport agent is not detected

The application will perform a check to see if the application is installed and the transport agent enabled - if this is successful the application will launch as normal. If both checks fail, the application will launch in 'Install' mode allowing the selection between online and offline installation as mentioned above.

Problems?

If you have any problems installing, please check out the troubleshooting section.

Exchange 2013 SP1: If you have any problems installing the agent on Exchange 2013 SP1 please first try to apply the fix mentioned in issue #24.