Alfresco Enkive Installation Instructions

From Enkive Wiki

Jump to: navigation, search

Contents

Prerequisites

The recommended configuration of Enkive uses MySQL and Postfix.

MySQL is a requirement of Alfresco, on which Enkive is based. Note that Alfresco also supports several other database backends, but these configurations have not been tested with Enkive.

The Postfix mailserver is used to reliably queue mail for delivery to Enkive. Other mail servers could be used to deliver mail to Enkive, but as of the writing of this HOWTO, only Postfix is supported.

Enkive runs on the Tomcat servlet engine, which must be installed as well.

Installing MySQL

A standard MySQL installation using your preferred method is fine for Enkive. This means that installation through package management on Linux will work, otherwise follow the instructions found on the MySQL website - http://www.mysql.com/. However, MySQL 5.1.* is highly recommended (this is the only version of MySQL that Enkive has been tested on).

Installing Tomcat 6.0

Install Java

If a JRE is not installed on your machine, one will need to be. Either OpenJDK or the Oracle JRE version 1.6 will work.

Download Tomcat

  1. Point browser to http://tomcat.apache.org/download-60.cgi
  2. Download an appropriate binary distribution
  3. Install it on your server at a known location
    1. Note: this location will be known as $tomcat

Configuration

Although the instructions below try to be complete, you may also want to consult the Tomcat 6 installation instructions on the Alfresco wiki.

Make sure Tomcat has enough memory for Enkive + eDiscovery

Add the following line to the top of $tomcat/bin/catalina.sh

JAVA_OPTS="$JAVA_OPTS -Xms128m -Xmx768m -XX:MaxPermSize=256m -server"

As of testing on Aug. 10, 2010, it seems that 768MB for the heap and 256MB for the permanent items (e.g., loaded .class files) is sufficient. When MaxPermSize was 128MB would run out of memory pretty quickly.

For larger installations, it is recommended to increase the max heap size.

Add a Tomcat administration user

Note: see $tomcat/conf/tomcat-users.xml

Add lines such as to the file:

<role rolename="manager"/>
<user username="admin" password="secret" roles="manager"/>

Tell Tomcat to load data from a shared directory

Edit $tomcat/conf/catalina.properties Change the line that says:

shared.loader=

to:

shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/lib/*.jar

Create some directories in $tomcat (note: not in webapps):

  • shared/classes
  • shared/lib


Installing the MySQL connector

Enkive needs the mysql jar file to connect to the mysql database you setup earlier. We'll install it in a shared place in your tomcat installation.

  1. Go to http://www.mysql.com/downloads/connector/j/
  2. Download the driver in the appropriate form.
  3. Expand it.
  4. Find JAR file named something along the lines of mysql-connector-java-5.1.12-bin.jar
  5. Copy (or move) the file into $tomcat/lib

Installing Enkive

Now that your prerequisites for Enkive are setup, it's time to install Enkive.

Place Enkive files into Tomcat

For Enkive to run, the WAR files (alfresco.war and ediscovery.war) downloaded from www.enkive.com need to be placed in the webapps directory of Tomcat.

Database setup

The MySQL database you setup earlier needs to be configured so that Enkive can utilize it. This means setting up a couple of databases and users. There are a couple of setup scripts that need to be run.

1. Change into the setup/scripts/database directory.
2. Run the enkive_db_create.sh script - This script requires your mysql root password. Additionally it will ask you to pick a password for the enkive user, you must remember what you choose here.
3. Run the enkive_db_setup.sh script - this script will ask you for the enkive user password you picked in the script before.

Install Alfresco Content Transformers

Alfresco provides 3 interfaces out of the box for transforming content so that it can be indexed for retrieval. On Linux these are openoffice, imagemagick, and SWFTools.

Install OpenOffice.Org

To convert office files, Alfresco requires the openoffice.org-headless plugin. This can usually be found in Linux package management, but can be installed manually as well. Take note of where the binary is installed, as you'll need this later.

Install imagemagick

The necessary files for this can also typically be found in Linux package management, but could be installed manually. Take note of where the 'convert' binary is installed, you'll need the path to this later.

Install SWFTools

Some Linux distributions may have a package for this in package management, but it is not likely. To install this, follow the directions found on Alfresco's wiki, here: http://wiki.alfresco.com/wiki/Installing_Alfresco_components#Linux_and_Unix_Installation

Initial configuration

Before we start Enkive for the first time, a few configuration files should be modified to work with your specific configuration. These modified files should be placed in the Tomcat shared/classes directory setup previously.

Configure Alfresco

In the setup/config directory there are several sample configuration files that need to be modified and placed in the $tomcat/shared/classes folder created previously. First we will edit the alfresco-global.properties file.

alfresco-global.properties

1. Rename the alfresco-global.properties.sample file to alfresco-global.properties and place it in $tomcat/shared/classes. Make sure the db.password matches the password you picked when running the enkive_db_create.sh script.

2. The paths to the content transformers should be updated to reflect the paths of the binaries installed in the alfresco content transformers step.

enkive.properties

1.Rename the enkive.properties.sample file to enkive.properties and place it in $tomcat/shared/classes. Make sure the enkive.db.password matches the password you picked when running the enkive_db_create.sh script.

2. On first run, enkive will create the enkive user with the password defined by enkive.repository.password. If you would like a different password, it is best to change it now. Note at this time the username cannot be changed.

3. Change the emergency save root - If enkive comes across a message that for some reason it has trouble saving due to any reason, it will dump the message to a file saved in this directory. Note that this directory must already exist on the filesystem.

Configure the Enkive Archiver

Create a file named $tomcat/shared/classes/enkive.properties

Disable Permission Checking - For 0.6.x releases only

Alfresco has permissions settings that need to be disabled for full search results to be returned. If this file is not placed in the tomcat/shared/classes directory, message results will be limited to 1000.

Rename and place the file alfresco/extension/unsecured-public-services-security-context.xml.sample

into

$tomcat/shared/classes/alfresco/extension/unsecured-public-services-security-context.xml

in your installation.


Start Enkive

To launch enkive, just start tomcat. Enkive has a variety of things to configure on the first boot, so it may take a while to start up.
You should be able to access the enkive ediscovery interface at ${serverIP}:8080/ediscovery/
You should be able to login as User:Enkive with the password you defined as the repository password in the enkive.properties file.

Personal tools