Installing Sakai 1.5.0 on Windows -- short version

Common Instructions

  1. Download the Sakai Source
  2. Download and install Java J2SE SDK version 1.4.2 or later
  3. Download and install Tomcat version 5.0.28 or greater (Stay within the 5.0 series, as 5.5 requires a different version of the Java SDK)
  4. Download and install Maven
    • http://maven.apache.org/
    • Create a file named build.properties in the Windows Home directory (c:\Documents and Settings\userid) and include the following: (NOTE that the slashes in the tomcat directory are forward slashes and that the entry requires a trailing slash)
      maven.repo.remote = http://www.ibiblio.org/maven/,http://cvs.sakaiproject.org/maven/
      maven.tomcat.home = c:/Tomcat/
    • Add the maven /bin directory to the system variables path
      • Right Click My Computer, Properties, Advanced, Environment Variables
      • Select the System variable Path and add C:\Program Files\Apache Software Foundation\Maven 1.0.1\bin to the end. Separate entries with a semi-colon.
      • Log off of the computer and log back on to reset system and environment variables.
  5. If updating from an older version, clean out the environment
    • From the command line, navigate to the Sakai source directory
      maven clean_env
  6. Build Sakai
    maven
    maven reg
    maven conf_db
    maven tomcat_context_windows
  7. Copy all files and folders from c:\sakai-dev\reference\src\usr_local_sakai\ to c:\usr\local\sakai

Don't delete all the files before copying – some files are placed here by maven in the previous step which are not included in the copy set.

HSQLDB Datasource

  1. Modify sakai.properties in usr/local/sakai as necessary
  2. Start Tomcat

MySQL Datasource

  1. Download and install MySQL ver 4.1 or better
  2. If a firewall is installed, allow port 3306 access (MySQL uses port 3306 to connect).
  3. Create sakai database (from within mysql) Replace 'sakaiuser' and 'sakaipassword' with your desired username/password
    mysql> create database sakai default character set utf8;
    mysql> grant all on sakai.* to sakaiuser@'localhost' identified by 'sakaipassword';
    mysql> grant all on sakai.* to sakaiuser@'127.0.0.1' identified by 'sakaipassword';
    • Add the MySQL /bin directory to the system variables path
      • Right Click My Computer, Properties, Advanced, Environment Variables
      • Select the System variable Path and add C:\Program Files\MySQL\MySQL Server 4.1\bin to the end. Separate entries with a semi-colon.
      • Log off of the computer and log back on to reset system and environment variables.
  4. Import the default table information into the Sakai database (from the command line)
    • Navigate to the sakai-dev\reference\src\sql\legacy\mysql directory
      mysql -u sakaiuser -p sakai < all.sql
  5. Download and install the JDBC connector
  6. Comment out the HSQLDB lines in sakai.properties file in usr\local\sakai
  7. Uncomment the MySQL lines in sakai.properties in usr\local\sakai
  8. Start (or Restart) Tomcat

Adding the Help Tool

  1. Download the help tool from CVS
  2. From the root of the help tool, run
    maven 
    maven reg

Adding the Syllabus Tool

  1. Download the syllabus tool from CVS
  2. From the root of the syllabus tool, uncomment the appropriate line of ./tool/src/webapp/WEB-INF/components.xml which correlates to the target database:
    <prop key="hibernate.dialect">net.sf.hibernate.dialect.MySQLDialect</prop>
  3. From the root of the help tool, run
    maven 
    maven reg

Using the file system for content hosting

Glen Golden has documented the changes necessary over in sakai-user