Intrallect Intralibrary Upgrade Guide: Version 3.3 to 3.8

Intralibrary Upgrade Guide: Version 3.3 to 3.8


Revision: 9

Created: 4th August 2005

Last Revised: 3rd August 2016

Contact: support@intrallect.com

Company: Intrallect Ltd

Product: intraLibrary, Digital Repository

Copyright: Intrallect Ltd 2003-2012. All rights reserved.

This document is made available to support Intrallect's customers and users of Intrallect's software. The text of these documents and the design of the intraLibrary software are both the intellectual property of Intrallect Ltd. Intrallect does not provide this document for any other purpose, and offer no warranty nor accept any liability for its use in any other context.


Table of Contents
1. Shutdown intraLibrary
2. Upgrade Java
3. Upgrade Tomcat
4. Replace Web Application
5. Remove Indexes
6. Update Config Directory
7. Update Licence
8. Start intraLibrary
9. Common upgrading problems

1. Backups
table of contents

Before making any changes to upgrade your environment you should take a backup of the Tomcat & IntraLibrary directories and the MySQL database.

The Tomcat and IntraLibrary directories can be backed up by copying them or creating a tar file. MySQL should be backed up using the mysqlhotcopy command.

For more information on mysqlhotcopy see http://dev.mysql.com/doc/refman/5.1/en/mysqlhotcopy.html


2. Upgrade Java
table of contents

IntraLibrary 3.7 requires Java 1.7 to run. You can download it from http://www.oracle.com/technetwork/java/javase/downloads/index.html


3. Upgrade Tomcat
table of contents

You will need to upgrade your Tomcat 5.5 to Tomcat 7 for IntraLibrary 3.7. The easiest way to do this is to download a fresh copy of Tomcat 7 from http://tomcat.apache.org/download-70.cgi and set it up like you would for a new installation.

Bellow is a summary of the steps you will need to take. For a more detailed guide see the installation documentation.

4. Replace Web Application
table of contents

The basis of the intraLibrary web application is the intralibrary.war file file. You can put this archive anywhere on the server, but we'd recommended it to be on the same physical volume as the application server (Tomcat).

To avoid confusion between the new and old versions of the web application, rename the previous war file to intralibrary_old.war. Once you are satisfied that the new version of intraLibrary runs correctly the old war file can be removed completely.

To remove the need to add extra settings to your $TOMCAT_HOME/conf/server.xml you can run Intralibrary from an expanded war using $JAVA_HOME/bin/jar -xvf intralibrary.war


5. Remove Indexes
table of contents

You will need to remove the index folder which is located in your IntraLibrary config directory.


6. Update Config Directory
table of contents

The following new files and directories which will need deployed to your InraLibrary config folder. You will be able to find them in the config folder of the IntraLibrary installation bundle.


7. Update Licence
table of contents

A new licence is required for this version of IntraLibrary. If you have not already received one you should contact support@intrallect.com.

To update the licence you need to replace the file called intralibrary-licence.txt in your IntraLibrary config folder with the new one.


8. Start intraLibrary
table of contents

It's now time to start the application. The first time that intraLibrary is started, any database changes will be applied on the server to ensure compatibility with the new version. The database changes are fairly minor so the amount of time taken to upgrade should be small.

If you wish to monitor the upgrade process, you can monitor the upgradeReport.log file which can be found in the directory specified as 'configDir' in your properties file. This file will tell you when the process is finished by outputting the line 'finished upgrading'.

If you check the output of the server startup, you should see some text resembling the text below.

****************************************
application url:http://localhost
application version:3.7(xxxxx)
catalina home:/opt/tomcat/3p7
database server version:5.1.61-0ubuntu0.10.04.1
database driver:MySQL-AB JDBC Driver
max database connections(0=unlimited):0
max upload file size:200 mb
servlet container:Apache Tomcat/7.0.29
JVM file encoding:UTF-8
java version:1.7.0_05
java vendor:Oracle Corporation
operating system:Linux,2.6.32-40-server
os architecture:amd64
indexStore:file
user name:root
user language:en
user country:GB
user timezone:Europe/London
java temp dir:/opt/tomcat/3p7/temp
servlet temp directory:/opt/tomcat/3p7/work/Catalina/localhost/_
----------------------------------------
configDir location:/opt/intralibrary/3p7/config
http proxy:no proxy used
mail host:
admin email:admin@company.com
error email:errors@company.com
return email:intralibrary1@company.com
id prefix:com.intrallect.poptart
repository name:poptart
object cache size:250
entry page:browse
logLevel:INFO
reindexOnStartup:true
headless:true
static http server running:false
 Integration with kaltura enabledregistered intraLibrary event handlers:com.intrallect.intralibrary.events.handlers.SimpleIntraLibraryEventHandler,com.intrallect.intralibrary.events.handler
s.DefaultIntraLibraryEventHandler
LoginPage class:com.intrallect.intralibrary.authentication.DefaultLoginPage
----------------------------------------
total memory assigned:512Mb
maximum memory assigned:1024Mb
----------------------------------------
licence assigned to:company
max contributors:1000000
version:3.7
expires:01-01-3000
----------------------------------------
IntraLibrary started dd-MMM-yyyy hh:nn:ss
****************************************

Assuming that you have no errors in this output then congratulations, you have successfully upgraded your installation of intraLibrary.


9. Common upgrading problems
table of contents

If you decided to rename the database you use for your installation, make sure you recreate the SQL views for the new database using the script "dbscripts/views/intralibrary-view.sql".

If you have upgraded your MySQL database from 5.0 to 5.1 you should also run mysqlcheck to make sure your database is healthy. See http://dev.mysql.com/doc/refman/5.1/en/mysqlcheck.html for more information.