Install Guide (2.5)

TABLE OF CONTENTS

Overview

Welcome to the Install Guide for Sakai 2.5! The Install Guide is chiefly designed for those installing Sakai from scratch, perhaps for the first time. For deeper configuration and tuning details, be sure to visit the Sys Admin Guide. If you're migrating from a previous release, be sure to check out the Release Notes.

Icons are used throughout the Install Guide to highlight important points in the installation, configuration, build and deployment process. Below is a list of the icons you will encounter:

Hints
Useful Information
Caution
Warning
Good practice
Bad practice

Documentation is presented here for ongoing comment, correction, and clarification, so please use the "Add Comment" link at the bottom of any of these pages if you note errors, require further details or have tips to share.

Choose an Install Type

Sakai downloads are available at

http://sakaiproject.org/release

Three different distribution packages are available:

Demo	This archive includes the Tomcat container and pre-built webapps, so that the only prerequisite for getting started is Java (v. 1.5). While not intended for large-scale implementations, it is suitable for evaluating the software and small-scale pilot implementations on single servers.
Binary	This is essentially a Demo without the Tomcat - an overlay of .jar and .war files that collectively comprise the application bundle. If you have a working Tomcat appropriately configured the binary installation provides a quick way to drop the Sakai application bundle into place without requiring a maven build. This may be a good choice if you know you don't need to make any code-level changes to the release.
Source	This archive includes only the source code to build Sakai, and therefore calls for preparatory installations of Tomcat and the Maven build tool. The installation and configuration of these various components comprise the bulk of this installation guide.

Migrating from a Previous Release

Migration from an earlier version of Sakai typically involves a database conversion (for which scripts are supplied with the release), an update to any custom skins, and possibly changes to any custom code.

For links to the conversion scripts, see the Database Migration section of this guide.

Changes in sakai.properties

In addition to new sakai.properties values introduced for Sakai 2.5, there are also some changes to address when upgrading from a previous version of Sakai:

SAK-10762: In Worksite Setup/Site Info the names of properties associated with the ability to add participants via email address have changed:

Old Name (Sakai 2.4 and earlier)	New Name (Sakai 2.5.0 and later)
`invalidEmailInIdAccountString`	`invalidNonOfficialAccountString`
`noEmailInIdAccountName`	`officialAccountName`
`noEmailInIdAccountLabel`	`officialAccountLabel`
`emailInIdAccountName`	`nonOfficialAccountName`
`emailInIdAccountLabel`	`nonOfficialAccountLabel`
`emailInIdAccount.url`	`nonOfficialAccount.url`
`emailInIdAccountInstru`	`nonOfficialAccountInstru`
`noEmailInIdAccountValue`	`officialAccountValue`
`emailInIdAccountValue`	`nonOfficialAccountValue`

SAK-13205: Upgrade OSP Permissions. If you are upgrading from a pre-2.5.0 version of Sakai, then you need to force conversion of the OSP permissions by setting osp.upgrade25=true in your sakai.properties file. (See also discussion.)

SAK-13403: The properties associated with the WebDAV authentication cache have changed. In Sakai 2.5.0 and earlier the following properties were used:

maximumSize@org.sakaiproject.user.impl.AuthenticationCache
timeoutMs@org.sakaiproject.user.impl.AuthenticationCache
failureThrottleTimeoutMs@org.sakaiproject.user.impl.AuthenticationCache

These settings have been replaced as of Sakai 2.5.2 with:

maxElementsInMemory@org.sakaiproject.user.api.AuthenticationManager.cache
timeToLive@org.sakaiproject.user.api.AuthenticationManager.cache

SAK-10451: Those upgrading from a pre-2.5.0 version need to change osp.reports.useWarehouse to sakai.reports.useWarehouse.

Install Guide (2.5)

Overview

Choose an Install Type

Migrating from a Previous Release

Changes in sakai.properties

Labels

Children (53)

Comments (1)

Mark Breuker says: