3.11 Post-Install Tasks

After running through the initial install guide for your OS, you are ready to configure Retain. From this point on, Retain works the same regardless which platform it is running on. To get Retain ready for regular use, some final one-time procedures need to be run.

  • Retain Server needs to be configured

  • Configure the relevant module(s)

  • At least one Retain Worker needs to be configured

3.11.1 If using MySQL

3.11.2 Initial Setup Overview

  • Choose your storage path

  • Retain prompts you for access information to your SQL Database Server

    • You must create this database beforehand. (See system requirements for documentation for the supported SQL servers.)

    • Retain creates the tables, indexes, and prepares the database for use

You will be prompted to provide SQL connection information for both the configuration and message store databases. For convenience and simplicity most installations store this information in the same database. The database(s) will be used to store Retain configuration, cached address books, and all saved message data.

  • Create at least one administrator account. The first account will be the default admin account. It is created during the initial setup

    • The ‘admin’ account is special:

      -It has ALL admin rights

      -It never expires

      -It always uses “offline authentication” (authenticates using a password stored in the SQL configuration database instead of authenticating against a message system)

    • Additional accounts can be created as desired with as many rights as you wish in the management interface. User accounts may possess a mixture of administrator level and user level rights. As a result, users may have some admin level rights, but would not be considered an administrator

  • Retain prompts you for the following SMTP information for notification and forwarding. (If no SMTP is present, this step may be skipped by typing the word ‘skip’ in the SMTP Mail Server field.)

    • SMTP Server: Server to use for sending messages. (DNS or IP) (use DNS whenever possible)

    • From address: Enter the address that you want to appear in the “From” field on the messages Retain sends

    • To address: Enter the address to which Retain will send notification

    • Username: Enter the username to use for authentication with the SMTP server for relaying mail.

    • Password: Enter the password for this username.

  • Select the indexing engine. There are two choices, but both are High Performance Indexing engines: The Standard Index engine and the High Availability Index (HAI).

    The Standard Index is the High Performance Indexer (HPI) embedded with the Retain Server and is more than sufficient for most systems.

    The High Availability Index is the HPI engine scaled and designed for high availability and rapid searches on very large systems. The HAI requires at least three (3) separate, dedicated, index servers in addition to the Retain Server, as well as a separate license.

    • After initial setup, configuration of a module and creation of a profile, schedule, worker, and job are required before messages can be archived.