Sakai 1.5.0

QuickStart

Sakai Installation

Sakai Download

Sakai Documentation

Developing with Sakai

DEPRECATED CODE

WARNING. The release artifacts included on this page are no longer current and have been superseded by newer versions of Sakai which include functionality enhancements as well as bug fixes and security patches. You can download the latest Sakai release by visiting http://source.sakaiproject.org/release.

Sakai QuickStart

Users wanting to quickly setup and demonstrate a Sakai site may download the QuickStart distribution of Sakai.  This distribution provides a "drop it in and go" configuration of Sakai.  The intent is to make it easier for potential content developers to quickly get Sakai up and running. The builds include a working configuration of the Tomcat Servlet Engine.

Users intending to deploy Sakai in a small to medium production environment must further configure the QuickStart so as to connect to a database among other configuration changes.

Users intent on deploying Sakai 1.5 in a large production environment should expect some development involvement and should become familiar with the developer source.

Differences from Sakai 1.0

With 1.5 several new tools have been introduced into Sakai. There is a more configurable help system, a syllabus and a presentation tool, and integrated access to the Samigo "Quiz and Test" system.

With more tools comes a bit more complexity.

  • The default storage mechanism is now a hsqldb database. The xml storage format is no longer supported.
  • The Samigo tool requires a separate integration step. This is discussed later on this page.

Prerequisite: Java

Prior to running Sakai you will need to have a properly installed and configured Java Run-Time Environment (JRE) or Java Software Development Kit (SDK). We have provided instructions to check your Java installation and install Java if necessary.

UNIX: Sakai QuickStart
Download the Sakai QuickStart to a location on your hard drive. If you have the curl command you can download the file at the command line:
$ curl -O http://cvs.sakaiproject.org/release/1.5.0/src/sakai_quickstart_1-5-0.zip
Or you could use the wget command:
$ wget http://cvs.sakaiproject.org/release/1.5.0/src/sakai_quickstart_1-5-0.zip

After downloading the QuickStart zip file use 'jar xf filename' to extract the distribution. It will all be put in a single 'sakai' directory.

$ jar xf sakai_quickstart_1-5-0.zip 
Change to the sakai directory extracted from the distribution zip file. Executing the start.sh script will auto-configure Sakai and start up the associated Tomcat. You can change the permissions on the script or simply source it into a shell command line.
$ cd sakai
$ sh start.sh
You may want to watch the Tomcat log as the program starts:
$ tail -f jakarta-tomcat-5.0.28/logs/catalina.out
Startup ususally takes about a minute and the following message indicates that startup is complete:
Oct 1, 2004 9:21:14 AM org.apache.catalina.startup.Catalina start
INFO: Server startup in 44237 ms
If there are problems, there are additional logs in sakai/localfiles/logs.
Windows:Sakai QuickStart
Download the Sakai QuickStart to a location on your hard drive. Extract the files by right clicking on the ZIP file and choosing the extract all option.

The rest of the operations will be performed in a command window Start -> Run -> cmd -> OK. Change into the directory where the files were extracted

> cd \tmp\sakai_quickstart\sakai
> start.bat
The Tomcat console window should pop up, and after a while Tomcat should be up. Startup ususally takes about a minute and the following message indicates that startup is complete:
Oct 1, 2004 9:21:14 AM org.apache.catalina.startup.Catalina start
INFO: Server startup in 44237 ms
If there are problems, there are additional logs in sakai/localfiles/logs.
Test QuickStart
Sakai will be available on http://localhost:8080/portal if it has successfully started. If there are problems the logs are likely to be helpful. The Tomcat logs are in the Tomcat directory and the Sakai log is under sakai/localfiles/logs.
Shut Down Tomcat
For UNIX:
$ sh stop.sh
Windows:
> stop.bat
Sample Output
Running Sakai Samigo

Activating the Samigo tool within Sakai requires some additional steps. It also requires access to an Oracle database. The file installingSamigo.txt in the Quickstart distribution details these steps.

Running Sakai QuickStart with another Database
We do not suggest using the Hsqldb implementation for production with Sakai. If you would like to reconfigure your QuickStart to run a small production environment you can continue with the database configuration instructions to use either MySql or Oracle.
Joining the Sakai Developer Community

If you intend stay involved in the Sakai project you should join one of two Mailing Lists/Sakai Groups. Since Sakai is a collaborative environment, we use Sakai to communciate with those installing/maintaining Sakai and those who are developing for Sakai.

For more information, see the page describing the Sakai User and Developer Lists.