Demo Installation Guide

Demo Installation Introduction:

The Sakai "Demo" includes a fully built and configured Sakai in a ready-to-run package that also includes Tomcat and the compatibility patch.  The only prerequisite is Java 1.4.  The Demo installation is the quickest way to get started with Sakai for demonstration and evaluation.

Table of Contents

    Installation Steps
  1. Verify Java installation (and install if necessary)
  2. Set environment variables
  3. Download Sakai Demo
  4. Unpack Demo archive
  5. Start Tomcat
  6. Test Sakai
    Demo Notes
  1. Data Storage
  2. Things Not Included in the Demo
  3. Common Problems

Installation Steps

  1. Verify Java Installation

    Check to see if you have Java installed on your system by running the following commands:

    Sample Commands
    Windows:
    C:\> java -version
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_04-141.3)
    Java HotSpot(TM) Client VM (build 1.4.2-38, mixed mode)
    Macintosh/Linux/Solaris:
    $ java -version
    java version "1.4.2_04"
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_04-141.3)
    Java HotSpot(TM) Client VM (build 1.4.2-38, mixed mode)

    Note: Java is already installed on Mac OSX computers.

    If you do not have the correct version of Java installed, install the Java Run-Time Environment (JRE) or the Java Software Development Kit (SDK) from http://java.sun.com/j2se/1.4.2/download.html

  2. Set environment variables

    In UNIX operating systems you typically modify a startup file like ~/.bash_login to set and export environment variables. In Windows XP, you go to

    Start -> Control Panel -> System -> Advanced -> Environment Variables

    in order to create or modify the named variables.

    Set the JAVA_HOME environment variable to point to the base directory of your Java installation. This will enable Tomcat to find the right Java installation automatically. This may already be set up for you by your Java SDK installation, but you should check it.

    Sample Commands
    Windows: Set the environment variable JAVA_HOME to "C:\j2sdk1.4.2_04" (do not include the quotes)
    Mac:
    export JAVA_HOME=/Library/Java/Home
    Linux:
    export JAVA_HOME=/usr/local/java-current

    Extend the PATH variable so as to include the Java commands.

    Sample Commands
    Windows: Append the string ";C:\j2sdk1.4.2_04\bin" (include the semicolon but not the quotes) to the end of the System variable named Path.
    Mac: not necessary
    *nix:
    export PATH=$PATH:$JAVA_HOME/bin/

    You should test that these variables are set correctly.  In both Windows XP and *nix operating systems you can simply start a new shell and type the 'set' command to see your environment variables.  Once the variables are set properly, run the java -version command once more as a final check.

  3. Download the Sakai Demo

    Get the demo from

    http://cvs.sakaiproject.org/releases/2.0.1/sakai-demo_2-0-1.zip


    OR

    http://cvs.sakaiproject.org/releases/2.0.1/sakai-demo_2-0-1.tar.gz

  4. Unpack the Demo Archive

    When you unpack the demo archive appropriate for your operating system, you will have a folder called sakai-demo.  This folder will contain its own Tomcat directory.

  5. Start Tomcat

    From the top Tomcat directory you can run the following startup commands:

    Sample Commands
    Windows:
    bin\catalina.bat start
    Mac/*nix:
    bin/catalina.sh start
  6. Test Sakai

    Once your Tomcat is started, open a browser and enter the following URL (don't be too alarmed about delays - it can take Tomcat half a minute or more to load the entire Sakai application):

    http://localhost:8080/portal

    This will bring you to the Sakai gateway site.  One user account is included in the demo, the administrator's account.  Login using user id "admin" and password "admin".

    New user accounts can be created from the admin's User tool, or using the "new account" link on the Sakai gateway site.

    To stop the demo you can stop Tomcat with the following commands:

    Sample Commands
    Windows:
    bin\catalina.bat stop
    Mac/*nix:
    bin/catalina.sh stop

Demo Notes

  1. Data Storage

    The data for a Demo installation is stored in a HypersonicSql database which is stored in memory and then written out to files when Tomcat is shut down. These files are located at:

    sakai-demo/sakai/db/sakai.db.*

    Objects created and modified in runs of the Sakai demo will persist through server restarts.

    HSQL is not appropriate for running Sakai in any sort of production environment. For these, we recommend MySql or Oracle (see the Source Installation Guide).

  2. Things Not in the Demo

  3. Common Problems