Difference between revisions of "Retain Windows Install"
(→Database Install) |
(→MySQL 5.7) |
||
(21 intermediate revisions by one user not shown) | |||
Line 8: | Line 8: | ||
*Mount and initialize the volumes in Disk 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) | ** 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 | + | ** 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) | ** 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) | + | ** 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. |
− | + | ||
− | + | ||
=====Disk Management ===== | =====Disk Management ===== | ||
Line 27: | Line 25: | ||
===Prerequisites for Retain=== | ===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. | + | 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. |
+ | |||
+ | ===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. | ||
=====Retain 3.x Prerequisite Install Java===== | =====Retain 3.x Prerequisite Install Java===== | ||
Line 49: | Line 55: | ||
MySQL is free and our default database | MySQL is free and our default database | ||
=====MySQL 5.5===== | =====MySQL 5.5===== | ||
− | # Install MySQL 5.5 [http://dev.mysql.com/downloads/mysql/] with the following setting: | + | # Install MySQL 5.5 [http://dev.mysql.com/downloads/mysql/] from the .msi with the following setting: |
# Install as Typical, take defaults and allow to start MySQL Instance Configuration Wizard | # Install as Typical, take defaults and allow to start MySQL Instance Configuration Wizard | ||
## Detailed Configuration | ## Detailed Configuration | ||
Line 62: | Line 68: | ||
=====MySQL 5.6===== | =====MySQL 5.6===== | ||
− | MySQL 5.6 has an install bug on Windows that only allows it to use the boot drive for data. | + | 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 [https://bugs.mysql.com/bug.php?id=68584] |
#Download the MySQL Installer [http://dev.mysql.com/downloads/installer/] | #Download the MySQL Installer [http://dev.mysql.com/downloads/installer/] | ||
#Run the Installer to configure | #Run the Installer to configure | ||
Line 74: | Line 80: | ||
#Execute and Finish | #Execute and Finish | ||
− | ====Configure Database==== | + | =====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. | ||
+ | #Download and install Visual C++ Redistributable x86 [https://www.microsoft.com/en-us/download/details.aspx?id=40784] | ||
+ | #Download the MySQL Installer [http://dev.mysql.com/downloads/installer/] | ||
+ | #Run the Installer to configure | ||
+ | ##Accept the license | ||
+ | ##Server Only | ||
+ | ##Choose the product (e.g. MySQL Server 5.7.18) | ||
+ | ##Configure | ||
+ | ###Server Machine | ||
+ | ###Root password | ||
+ | ###Configure as a Windows Service that starts at system startup | ||
+ | #Execute and Finish | ||
+ | |||
+ | ====Configure MySQL Database==== | ||
Create database and user on the C:\ drive with the Command line client: | Create database and user on the C:\ drive with the Command line client: | ||
− | # Start the Command Line Client and login as root | + | # Start the Command Line Client and login as root |
# Create a database (for example: ''retain'') | # Create a database (for example: ''retain'') | ||
− | # | + | #* <code>CREATE DATABASE retain DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin';</code> |
− | # | + | # 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 |
− | # | + | #* <code>GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'%' IDENTIFIED BY 'password1';</code> |
− | ## <code>GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'localhost' IDENTIFIED BY ' | + | # Add the retain user to the database and give it local access |
− | # exit to end session | + | #* <code>GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'localhost' IDENTIFIED BY 'password1';</code> |
+ | # Type 'exit' to end the session | ||
To setup a database on a different volume [http://dba.stackexchange.com/questions/24403/change-existing-datadir-path/24437#24437?newreg=8ac58d6446484ed98c0c7fb695be3ef5] | To setup a database on a different volume [http://dba.stackexchange.com/questions/24403/change-existing-datadir-path/24437#24437?newreg=8ac58d6446484ed98c0c7fb695be3ef5] | ||
Line 104: | Line 125: | ||
*Download and extract the latest version of Retain.[http://download.gwava.com/download.php?product=Retain&version=versions] | *Download and extract the latest version of Retain.[http://download.gwava.com/download.php?product=Retain&version=versions] | ||
*Install [http://support.gwava.com/documentation/Retain/401/#t=RetainDocs%2FInstall%2FWindows_Installation%2FWindows_Installation.htm] | *Install [http://support.gwava.com/documentation/Retain/401/#t=RetainDocs%2FInstall%2FWindows_Installation%2FWindows_Installation.htm] | ||
− | + | ||
− | *Retain Server | + | ==Post Install Tasks== |
+ | Stop Tomcat | ||
+ | |||
+ | ===Install JDBC=== | ||
+ | If using MySQL, download the MySQL Connector/J (JDBC driver for MySQL) driver | ||
+ | # Download Connector/J file from the MySQL site [https://dev.mysql.com/downloads/connector/j/] version 5.1.24 or greater | ||
+ | #Extract mysql-connector-java-5.1.39-bin.jar | ||
+ | #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) | ||
+ | #Start Tomcat | ||
+ | |||
+ | ===Changing the Logging Path=== | ||
+ | |||
+ | If using multiple volumes for data storage you can change the logging path. | ||
+ | |||
+ | # Ensure no archive jobs are running and stop Tomcat | ||
+ | # Configure Tomcat's default log location | ||
+ | ## Click on Start | ||
+ | ## In the "Search programs and files" box, type: configure tomcat | ||
+ | ## Click on Configure Tomcat | ||
+ | ## Click on the Logging tab. | ||
+ | ## 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. | ||
+ | ## Click OK. | ||
+ | # Make a backup copy of the existing log4j.properties file. | ||
+ | # Edit the log4j.properties located at [drive]:\Program Files\Beginfinite\Retain\[RetainServer or RetainWorker, etc]\WEB-INF\classes. | ||
+ | # 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. | ||
+ | # 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. | ||
+ | |||
+ | ==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. | *Install the license, the trial license is unlimited for 30 days. | ||
− | + | ||
---- | ---- | ||
Return to [[Retain Training]] | Return to [[Retain Training]] |
Latest revision as of 17:12, 23 October 2018
Retain Install on a Windows Server
Contents |
[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
- Right-click on the Disk# and bring the disk Online
- Right-click to Initialize Disk, MBR style
- Right-click on the space of the disk and select New Simple Volume
- Choose size
- Assign a drive letter
- Select file system (NTFS), name and quick format
- 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
- Install MySQL 5.5 [3] from the .msi with the following setting:
- Install as Typical, take defaults and allow to start MySQL Instance Configuration Wizard
- Detailed Configuration
- Server Machine
- Transactional Database only
- Give it a storage path
- Manual Setting (100)
- Enable TCP/IP networking (port 3306) add firewall exception, Enable Strict mode
- Best Support for Multilingualism
- Install MySQL as a Service and select Include the Bin directory in the Windows PATH.
- 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]
- Download the MySQL Installer [5]
- Run the Installer to configure
- Accept the license
- Server Only
- Choose the product (e.g. MySQL Server 5.6.28)
- Configure
- Server Machine
- Root password
- Configure as a Windows Service that starts at system startup
- 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.
- Download and install Visual C++ Redistributable x86 [6]
- Download the MySQL Installer [7]
- Run the Installer to configure
- Accept the license
- Server Only
- Choose the product (e.g. MySQL Server 5.7.18)
- Configure
- Server Machine
- Root password
- Configure as a Windows Service that starts at system startup
- Execute and Finish
[edit] Configure MySQL Database
Create database and user on the C:\ drive with the Command line client:
- Start the Command Line Client and login as root
- Create a database (for example: retain)
-
CREATE DATABASE retain DEFAULT CHARACTER SET 'utf8' DEFAULT COLLATE 'utf8_bin';
-
- 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';
-
- Add the retain user to the database and give it local access
-
GRANT ALL PRIVILEGES ON retain.* TO 'retain'@'localhost' IDENTIFIED BY 'password1';
-
- 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.
- Install as default instance, with Unicode, UTF-8 or Latin 1_General_C1_AS as standard encoding.
- Enable SQL Server Authentication in addition to Windows Authentication
- Once installed, Verify server is listening on port 1433 (telnet [ip address]:1433)
- Ensure TCP/IP is enabled - Run SQL Server Configuration Manager
- Expand SQL Server Network Configuration
- Protocols for MSSQLSERVER
- Enable TCP/IP
- Run SQL Server Management Studio, connect to Server
- Under Security/Logins, right click and select "create Login, (for example retaindbuser) that uses SQL Server authentication.
- Assign a password.
- 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
[edit] Post Install Tasks
Stop Tomcat
[edit] Install JDBC
If using MySQL, download the MySQL Connector/J (JDBC driver for MySQL) driver
- Download Connector/J file from the MySQL site [11] version 5.1.24 or greater
- Extract mysql-connector-java-5.1.39-bin.jar
- 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)
- Start Tomcat
[edit] Changing the Logging Path
If using multiple volumes for data storage you can change the logging path.
- Ensure no archive jobs are running and stop Tomcat
- Configure Tomcat's default log location
- Click on Start
- In the "Search programs and files" box, type: configure tomcat
- Click on Configure Tomcat
- Click on the Logging tab.
- 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.
- Click OK.
- Make a backup copy of the existing log4j.properties file.
- Edit the log4j.properties located at [drive]:\Program Files\Beginfinite\Retain\[RetainServer or RetainWorker, etc]\WEB-INF\classes.
- 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.
- 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