Retain Post Install Configuration

Once Retain is installed it needs to be configured. This is where you make the connections to the various parts of Retain. Mainly the archive storage area, the database, the indexer and the Reporting & Monitoring server.

Retain General Server Configuration

There is some basic configuration that needs to be setup before Retain can function that is done by the first user to connect to the Retain Server web address after the installation. Mainly, configuring where items will be stored and where the database is.

1. Browse to [retain server IP/Hostname address]/RetainServer
2. Begin the Configuration process
3. Set data location(s)
   1. If using a single disk, take the defaults
   2. Otherwise, use advanced options to specify multiple disks.
4. Configure database connection and users:
   1. Set DB User to retain
   2. Set DB ROOT User to root
   3. Set Search engine to Standard (In Retain 3.5.1 and earlier it will be Lucene)

Retain Functions Configuration

Once the base server is setup there are still some functions that need to be configured and setup:

These things include:

• Reporting and Monitoring Server, which can be setup on a separate server which is why it needs a bootstrap.
• If upgrading, the Indexer needs to be set to use the High Performance Indexer or the High Availablity Indexer (which is a separate license and requires a cluster of indexer servers)
• Module: The module is how you configure the connection to the email system.

Reporting and Monitoring Configuration

1. Click on Reporting and Monitoring Configuration
   1. Core Settings:
      1. Enable: Disable the disk usage statistics
      2. Enable: Disable the number of messages statistics
   2. Connection:
      1. Set server host names to IP or domain name, not localhost
   3. Save bootstrap
   4. Click on Reporting which will open a new window or tab.
   5. Install the bootstrap and log into the Reporting and Monitoring server.

High Performance Indexer

If you are upgrading a system from Retain 3.x you will have to configure the High Performance Indexer.

1. Click on Server Configuration
2. Go to Index Tab
3. Click "Begin Migration"
4. Chose "Standard Indexer" High-Availability Indexer refers to the external indexer which requires a cluster of servers to implement.
5. Press Save changes

If the Index page continues to show the "Begin Migration" button, restart tomcat.

You can access the indexer console with the link: https://[RetainServerURL]:8081/hpi/#/

There you will see a Dashboard that displays memory status. The Logging tab will show errors and warnings. The Core Admin tab will show status information and has the optimize button. The index should optimize itself during maintenance but not always. Use the Core Selector to select a core to view, in an on-board system there will be only one called: retaincore. This will tell you how many documents have been indexed.

License

Retain is fully functional for 30 days. You should receive an email with the validation keys for Retain. There will be at least two sets of keys:

• base server
• module

Go to license portal [1] and choose and enter the key and contact information to download the .pem files you will need. Browse to the Retain server, select Licensing, browse to the .pem file and upload all of them.

Module

From here you will need to go to Retain Module Configuration to connect to an email system.

---

Return to Retain Training