#
#
#    Scalix Public License
#
#
#    The contents of this file are subject to the Scalix Public License
#    Version 1.1 ("License"); you may not use this file except in
#    compliance with the License. You may obtain a copy of the License at
#
# 
#    http://www.scalix.com/community/licensing 
#
# 
#    Software distributed under the License is distributed on an "AS IS"
#    basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
#    the License for the specific language governing rights and limitations
#    under the License.
#
# 
#    The Original Code is Scalix Server. 
#    The Initial Developer of the Original Code is Scalix Corporation. 
#    Copyright (C) 2006 Scalix Corporation. 
#    All Rights Reserved.
#    Additional Copyrights may apply - see the notice in each file
#
#
#
#
#
Scalix Installer Build Instructions

Basic steps:
  0) Install Python 2.2, 2.3 or 2.4, Ant 1.6.5 (or greater)
  1) Download Scalix source from the web site and unpack it
  2) Change into the top-level of your Scalix installation
  3) Run ant

Step 0) Set up your development environment (Python 2.2, 2.3 or 2.4,
Ant 1.6.5 or greater)

Like many Open Source java projects, Scalix uses Apache Ant for build
control.  Specifically, you MUST use Ant version 1.6.5 or greater.

Ant is "kind of like make without make's wrinkles".  Ant is
implemented in java and uses XML-based configuration files.  You can
get it at:

  http://ant.apache.org

You'll need to download the Ant binary distribution.  Install it
according to the instructions at:

  http://ant.apache.org/manual

Step 1) Download Scalix Installer from the Web site

We'll assume you already did this, or you wouldn't be reading this
file.  However, you might have received this file by some alternate
route, or you might have an incomplete copy of the Scalix-installer,
so: source releases are available for download at:

  http://www.scalix.com/products/opensource.html

Download the tarred/gzipped version of the archive, and uncompress 
it into a directory of your choice.

Step 2) Change to the top-level of your Scalix Installer source installation

Scalix Installer's top-level directory contains the build.xml file. By default,
you do not need to change any of the settings in this file, but you do
need to run ant from this location so it knows where to find build.xml.

If you would like to change settings you can do so by creating one 
or more of the following files and placing your own property settings
in there:

    build.properties
    
Step 3) Run ant

You can build the installer for one or more Python versions by setting
the envionment variable(s) to point to the correct Python executable.
For example, export PYTHON24=/usr/bin/python will enable Python 2.4
builds.  You can also set PYTHON22 and PYTHON23 (pointing to the appropriate
Python version executable) to build for 2.2 and 2.3 respectively.  The 
default is Python 2.4.

Assuming you have ant in your PATH and have set ANT_HOME to the
location of your ant installation, typing "ant" at the shell prompt
and command prompt should run ant and build the installer.  Ant will by 
default look for the "build.xml" file in your current directory.

Step 4) Run the installer 

The result of a successful build will create an executable file.  This
file is a compressed archive of the installer program which can be
copied to other machine and executed as required to install Scalix
components.

For further information on Scalix , go to:
  http://www.scalix.com

To join the discussions on the forums, go to:
  http://www.scalix.com/community

Please post suggestions, questions, corrections or additions to this
document on the forums.

Copyright (C) 2007 Scalix Corporation.  All rights reserved.
