Difference between revisions of "Retain Windows Install"

Latest revision as of 17:12, 23 October 2018

Retain Install on a Windows Server

[edit] Windows Server 2012 R2

[edit] Create Data Volumes

It is recommended to create data volumes so it is easier to recover. In a test system this isn't necessary but on a customer system it is recommended. Create 4 data disks:

• Create the disks in the VM manager
• Mount and initialize the volumes in Disk Manager
  • ARCHIVE: for the storage directory. Required to have at least 20GB free for normal operation, warnings will appear when <20GB free, Retain will go into maintenance mode if free space drops below 10GB. (64GB is good for a test system)
  • INDEX: for the indexes. Required to have at least 20GB free for normal operation, warnings will appear when <20GB free, Retain will go into maintenance mode if free space drops below 10GB.(32GB is good for a test system)
  • DATABASE: for the database. (24GB is good for a test system)
  • LOGS: for the logs of the system (Logs can be up to 30GB/day/worker during large migrations) Required to have at least 20GB free for normal operation, warnings will appear when <20GB free, Retain will go into maintenance mode if free space drops below 10GB. (32GB is good for a test system). This is also a good place to store the index backups, as index optimization can require up to 3x the index directory size. Having the backups separate opens up space.

[edit] Disk Management

Use Disk Management to mount and format disk partitions and volumes

1. Right-click on the Disk# and bring the disk Online
2. Right-click to Initialize Disk, MBR style
3. Right-click on the space of the disk and select New Simple Volume
   1. Choose size
   2. Assign a drive letter
   3. Select file system (NTFS), name and quick format
   4. Finish

The volume will appear in File Explorer.

[edit] Prerequisites for Retain

Retain needs a web server and a database server preinstalled before it will run successfully. The database may be installed on a separate server but for a test system installing the database locally is recommended. You also want the Retain server to point at the same DNS the Exchange server is using.

[edit] DNS

Set the Retain Server to point at the same DNS is pointing to as the Exchange server

• Server Manager/ Local Server
• Ethernet0, opens a new windows
• Ethernet0, right-click and choose Properties
• IP4/Properties
• Set "Use the following IP address" and "Use the following DNS server addresses" to what is assigned to the system.

[edit] Retain 3.x Prerequisite Install Java

Older versions of Retain needed to install Java manually.

• Install Java 1.6 aka Java 6. [1] (Retain 3.5.1 asks to download/install)
  • System/Change settings/Advanced/Environmental Variables (new system variable JAVA_HOME point to the installed directory c:\Program Files\Java\jdk1.6.0_38)

[edit] Setup the Web Server

While you could install apache, IIS just needs to be activated on a Windows server. Install IIS by adding the role in Server Manager:

• Add WebServer
• Under Role Services, open Application Development and enable:
  • ISAPI Extensions
  • ISAPI Filters
• Restart

[edit] Database Install

While Retain 4.x on SLES will download, install and configure MySQL for you, Windows and older versions of Retain require this to be done manually. Retain uses a translation library called hibernate in the logs to support MySQL, MS SQL Server, Oracle and Postgres. [2]

[edit] Install MySQL

MySQL is free and our default database

[edit] MySQL 5.5

1. Install MySQL 5.5 [3] from the .msi with the following setting:
2. Install as Typical, take defaults and allow to start MySQL Instance Configuration Wizard
   1. Detailed Configuration
   2. Server Machine
   3. Transactional Database only
   4. Give it a storage path
   5. Manual Setting (100)
   6. Enable TCP/IP networking (port 3306) add firewall exception, Enable Strict mode
   7. Best Support for Multilingualism
   8. Install MySQL as a Service and select Include the Bin directory in the Windows PATH.
   9. Enter root password

[edit] MySQL 5.6

MySQL 5.6 has an install bug on Windows that only allows it to use the boot drive for data, unless you change certain user or security properties [4]

1. Download the MySQL Installer [5]
2. Run the Installer to configure
   1. Accept the license
   2. Server Only
   3. Choose the product (e.g. MySQL Server 5.6.28)
   4. Configure
      1. Server Machine
      2. Root password
      3. Configure as a Windows Service that starts at system startup
3. Execute and Finish

[edit] MySQL 5.7

The MySQL 5.7 installer doesn't install the correct Visual C++ Redistributable, use the x86 version, so it must be installed manually.

1. Download and install Visual C++ Redistributable x86 [6]
2. Download the MySQL Installer [7]
3. Run the Installer to configure
   1. Accept the license
   2. Server Only
   3. Choose the product (e.g. MySQL Server 5.7.18)
   4. Configure
      1. Server Machine
      2. Root password
      3. Configure as a Windows Service that starts at system startup
4. Execute and Finish

[edit] Configure MySQL Database

Create database and user on the C:\ drive with the Command line client:

1. Start the Command Line Client and login as root
2. Create a database (for example: retain)
   • CREATE DATABASE retain DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin';
3. Add the retain user to the database and give it remote access (for example: retain with password: password1). Replace the % with an IP address if you want logins restricted to a particular IP address
   • GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'%' IDENTIFIED BY 'password1';
4. Add the retain user to the database and give it local access
   • GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'localhost' IDENTIFIED BY 'password1';
5. Type 'exit' to end the session

To setup a database on a different volume [8]

[edit] Install MS SQL

SQL Server is another favorite for customers.

1. Install as default instance, with Unicode, UTF-8 or Latin 1_General_C1_AS as standard encoding.
2. Enable SQL Server Authentication in addition to Windows Authentication
3. Once installed, Verify server is listening on port 1433 (telnet [ip address]:1433)
4. Ensure TCP/IP is enabled - Run SQL Server Configuration Manager
5. Expand SQL Server Network Configuration
6. Protocols for MSSQLSERVER
7. Enable TCP/IP
8. Run SQL Server Management Studio, connect to Server
9. Under Security/Logins, right click and select "create Login, (for example retaindbuser) that uses SQL Server authentication.
10. Assign a password.
11. Right click on Databases, and create a new database named retain and assign retaindbuser as the owner.(There are other ways to grant the permissions but this is easiest)

[edit] Download Retain

• Download and extract the latest version of Retain.[9]
• Install [10]

[edit] Post Install Tasks

Stop Tomcat

[edit] Install JDBC

If using MySQL, download the MySQL Connector/J (JDBC driver for MySQL) driver

1. Download Connector/J file from the MySQL site [11] version 5.1.24 or greater
2. Extract mysql-connector-java-5.1.39-bin.jar
3. Copy the mysql-connector-java-5.1.39-bin.jar file to
   • ...RetainServer/WEB-INF/lib (for Retain Server)
   • ...RetainStatsServer/WEB-INF/lib (for the Reporting and Monitoring Server)
   • ...RetainStubbingServer/WEB-INF/lib (for the Stubbing Server)
4. Start Tomcat

[edit] Changing the Logging Path

If using multiple volumes for data storage you can change the logging path.

1. Ensure no archive jobs are running and stop Tomcat
2. Configure Tomcat's default log location
   1. Click on Start
   2. In the "Search programs and files" box, type: configure tomcat
   3. Click on Configure Tomcat
   4. Click on the Logging tab.
   5. Type in the new log path using the standard Windows path utilizing backslashes "\" (i.e., d:\retain\logs) or browse to it by clicking on the button with "..." on it.
   6. Click OK.
3. Make a backup copy of the existing log4j.properties file.
4. Edit the log4j.properties located at [drive]:\Program Files\Beginfinite\Retain\[RetainServer or RetainWorker, etc]\WEB-INF\classes.
5. Do a search on ${catalina.base}/logs/ and replace it with [desired path using forward slashes "/"]/logs/ (i.e., D:/retain/logs/)
   • An easy way to do this is to use the text editor's (i.e., Notepad") "Replace" function.
6. Repeat steps 2 - 4 for every log4j.properties file (server, worker, stub server, stats server).

The only log that will be created at the default log location will be the localhost.[date].log, but it is a very small log.

[edit] Next Steps

• Post install configuration [Retain_Post_Install_Configuration]
• Retain Server Setup [Retain_Module_Configuration]
• Install the license, the trial license is unlimited for 30 days.

Return to Retain Training