3.5 Retain Worker Linux Installation

The Retain Worker also can be installed in a stand-alone manner.

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

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 webserver and the worker agent software. It uses the same installer as above.

Prerequisite:

  1. Install the web server (apache)

Pre-install tasks:

  1. Download the latest version of Retain.

    You may use the command line "wget http://download.gwava.com/download.php?product=Retain&version=current"

  2. Extract the archive. This will extract into a new folder.

    In the GUI right-click and select "Extract Here"

    On the command line use "unzip Retain<version>.zip"

  3. Open a terminal window in the Retain install folder and make the installer script executable by running the command: "chmod +x *.sh"

    3a. If a previous version of Java was installed via YaST, tomcat may fail to start. Uninstall the existing Java with YaST and unset the JRE_HOME path (unset JRE_HOME).

  4. Run the installer. Enter the following command:

    ./RetainInstall.sh

  5. Select yes to "Install Retain Worker" only

  6. Finish the install as normal

  7. Workers are accessed by browsing to http://[IPAddress or HostName]/RetainWorker

3.5.1 Installing Additional Workers on Linux

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 installer allows you to install one additional worker at a time.

Procedure

  1. From the terminal run "./retaininstall.sh" and install at least one Worker or upgrade the existing installation, if you haven't already done so.

  2. Run "./retaininstall.sh addworker" to start the installer in Add Worker Mode.

  3. Acknowledge requirements.

  4. Accept the license agreement.

  5. Enter the number (1-9) of the Worker agent you wish to install. You may install workers in any order.

  6. Confirm the install location.

  7. Choose to keep or move the log location.

  8. Choose to run retain-tomcat8 on start up or not.

  9. After installing and acknowledging the location of the documentation the installer will show 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 /var/log/retain-tomcat8/RetainWorkerN.yyyy-mm-dd.log unless otherwise specified in Configure Tomcat.