1.13 Installing Other Retain Components on Windows

1.13.1 Installing Additional Retain Workers on Windows

Typically, one Worker Agent is installed on the Retain Server, but it may make sense for your system to use multiple workers.

One design option is to place a Worker Agent on each post office server, that would save network bandwidth as only new messages would be transmitted. Another option is to place multiple worker agents on a dedicated worker server.

Installing a worker agent is much simpler than installing the entire Retain server system. It only requires installing the web server and the worker agent software. It uses the same installer as above.

Prerequisite

Install the web server (IIS with ISAPI filter, as above).Installing a Web Server

Overview

In larger email systems, it can take a long time to dredge all the users especially if the users are on multiple mail servers. You can install multiple workers that can run in parallel to speed up the archiving process. We generally recommend one worker per mail server. The Retain installer can install up to 10 workers on a single server. We recommend an additional 1GB for RAM per worker. Workers are accessed by browsing to http://[IPAddress or HostName]/RetainWorkerN

The Retain installer allows you to install up to nine workers at once.

Procedure

  1. Download and prepare the software on the Windows server as outlined in Downloading and Preparing the Retain Windows Installation Source Files.

  2. Run the RetainInstall.exe and install at least one Worker or upgrade the existing installation, if you haven't already done so.

  3. From the command line (run as Administrator), type RetainInstall.exe /AddWorker to start the installer in Add Worker Mode.

  4. Acknowledge the requirements.

  5. Accept the license agreement.

  6. Confirm the install location of Retain.

  7. Enter the number (1-9) of Worker agents to install. They are installed in numerical order (e.g. RetainWorker, RetainWorker1, RetainWorker2..., RetainWorker9).

  8. Confirm which webserver is installed.

  9. Install the Worker agent software. After installing and acknowledging the location of the documentation the installer shows you how to access the Workers that were just installed.

  10. Log into the Retain web console as admin

  11. Create a new Worker and download the Bootstrap for each new Worker you installed. You may save it with a different name to organize it.

  12. Browse to the new Worker at http://[ServerAddress]/RetainWorkerN where N is the number of the worker you just installed.

  13. Upload the bootstrap.

  14. Click Continue and login to the worker.

  15. Check the friendly name that it is the one you expect.

There is a separate log file for each worker, found in C:\Program Files\Beginfinite\Retain\Tomcat 8.0\logs\RetainWorkerN.yyyy-mm-dd.log unless otherwise specified in Configure Tomcat.

1.13.2 Installing a Retain Message Router on Windows

The Retain Message Router allows devices outside your network to archive to the Retain Server without exposing the server directly to the Internet. The Router sits in your network's DMZ and routes items to the Retain Server.

The Router should be installed on a server other than the Retain server itself.

This is much simpler than installing the entire Retain server system. It only requires installing the webserver and the Router agent software. It uses the same installer as above.

Prerequisites:

  • Install the web server (IIS with ISAPI filter, as above).

  • Make sure that the Router server can connect to the Retain Server.

Install:

  1. Download and prepare the software on the Windows server as outlined in Downloading and Preparing the Retain Windows Installation Source Files.

  2. Extract the archive.

  3. Run the installer, RetainInstall.exe, as above.

  4. When selecting the components to install. Select "Message Router" only.

  5. Finish the install as normal.

  6. Create a 10 GB data directory for the Router to use to temporarily store messages until they can be transferred to the Retain Server.

    NOTE:The Storage Path must not be the same as the Mobile Module Data path.

  7. Configure the Router in the Retain Server console under Configuration | Router Configuration. See Retain Message Router Configuration Page in Retain 4.9.2: Configuration and Administration.

  8. The Router can be accessed by browsing to http://[IPAddress or HostName]/RetainRouter.