Unify installation


Jump to: navigation, search


Unify installation


This article will cover how to install VYRE Unify and also how to configure the installation.


Setting up the server

Before VYRE Unify can be installed a database needs to be set up, for this example we will use MySQL (5 or later) [[1]] (although a number of SQL servers can be used, including Oracle [[2]] and MSSQL [[3]])

Database Settings

The database should use InnoDB as the storage engine rather then MyISAM.

Required Database addititions

  1. Create a user for Unify to use, a different user is recommended for each Unify install
  2. Create a new schema for the Unify Installation to use, this should be left empty.
  3. Add the Host IPs to the user for each of the servers that can connect to the database with this user
  4. Set up the user permissions for the user that has been created, the user needs full permissions for the collection schema created above.

To test the user try connecting to the database and creating a table, if this works then we are ready to run the installer

Run the installer

Getting the installer

The latest Unify Installer can be found on the ClientZone Files section [[4]]

Running the installer

  1. After the installer has been downloaded, run it.
  2. Specify a path to install Unify (c:\vyre is often used).
  3. Select which installation is required, backend should only be selected for the admin server (the first install).
  4. Set the Instance name, which is the name that will be used for the name of the service.
  5. Set the mail server that Unify will use as the gateway for outgoing emails.
  6. Add the database name, username and password that you created above.
  7. When setting the maximum number of active connections the value should not be greater then the connections allowed by the database. Note that the connections should be shared between the different servers. For example if you have one admin server and three delivery servers and the database allows 400 connections then each server should only have 100 as the maximum number of connections.
  8. The idle number of connections is the number of connections that should be kept open even when not in use, the default of 20 should be fine for a standard installation.
  9. The default port is used for connecting to the instance while the server port is used internally by tomcat to shutdown the service.
  10. The Java memory heap size should be set based on the server's hardware, the min size is the amount of memory the Java Virtual Machine will start with and the max size is the maximum amount of memory that the Java Virtual Machine will be allowed to use.
  11. Set the debug level to INFO for the install, can be changed later if required.
  12. Click next and the installer will create the required database tables needed before Unify can be started.
  13. The next screen will have a list of manual changes that you will need to perform.
    • An example would be the changes that need to be made in the ${install_dir}tomcat/commons/classes/log4j.properties (change paths from back slashes to forward slashes)

Configure the installation

First time Unify starts it will create the database tables required and it will require some configuration.

  1. Firstly start the service
  2. Check the logs for any errors, it will display messages about creating tables and doing relevant tasks for Unify to work.
  3. Once the service is started go to localhost:80/vyre4 (make sure to use the default port set earlier if not 80).
  4. You should be presented with a login screen, the default username and password are admin/admin.
  5. Set a secure password for the admin user
  6. You will now be presented with the profile page for the admin user, fill in the details then click save.
  7. Now go back to localhost:80/vyre4 and you should be presented with the Unify work area.
  8. Go to the Configuration module then expand the System configuration Tab
  9. First go to clusters then add a cluster.
  10. Enter the paths for required folders
  11. Now add a server
  12. The first server should always be of type Admin Server, fill in the relevant details
  13. Now add the delivery servers
  14. Once the cluster has been set up go to the Localization tab under System Configuration and click "Refresh Standard Keys"
  15. Now go to the Publishing Module and create a new site, set the default locale to English as it has all the locales set up within the system.
  16. In this site add a domain for each of the servers within the cluster as well as the current server. This is required so that the servers can communicate with each other.


Here are a few things that should be configured to make sure Unify is working at its optimum.

Java Virtual Machine

Go to System Information, Virtual Machine and check the value for java.vm.name. It should use the server version of the Java Virtual Machine(JVM) rather then the Client version.

If the Client is being used you will need to download the java SDK which comes with the server version of the JVM, you will then need to update the JVM being used by the service.

  1. Stop the tomcat service.
  2. Then open a command prompt and type: tomcat5w.exe //ES//vyreService (where vyreService is the service name set up in the install)
  3. This will open a configuration window for tomcat, set the java version to use ${java_install_directory}/jre/bin/server/jvm.dll
  4. Now start up the tomcat service and check that the Server JVM is now being used.

Database Cache

The database cache settings can be viewed from Database Cache option under System Information in the Configuration module.

The capacity needs to optimized for each instance, note that the Cache is done based on number of items so consideration needs to be taken incase the items are large, for example they are a large data item rather then a simply folder.

Page Cache

The page cache settings can be viewed from Page Cache option under System Information in the Configuration module.

The capacity needs to optimized for each instance, depending on the number of pages that are in the site.

Personal tools