Sakai Collaboration and Learning Environment (Sakai CLE)

This is the source code for the Sakai CLE.

The master branch is the most current development release, Sakai 20.
The other branches are currently or previously supported releases. See below for more information on the release plan and support schedule.

Building

This is the "Mini Quick Start" for more complete steps to get Sakai configured please look at this guide on the wiki.

To build Sakai you need Java 1.8. Once you have clone a copy of this repository you can
build it by running (or ./mvnw install if you don't have Maven installed):

mvn install

Running

Sakai runs on Apache Tomcat 9. Download the latest version from http://tomcat.apache.org and extract the archive.
Note: Sakai does not work with Tomcat installed via a package from apt-get, yum or other package managers.

You must configure Tomcat according to the instructions on this page:
https://confluence.sakaiproject.org/display/BOOT/Install+Tomcat+9

When you are done, deploy Sakai to Tomcat:

mvn clean install sakai:deploy -Dmaven.tomcat.home=/path/to/your/tomcat

Now start Tomcat:

cd /path/to/your/tomcat/bin
./startup.sh && tail -f ../logs.catalina.out

Once Sakai has started up (it usually takes around 30 seconds), open your browser and navigate to http://localhost:8080/portal

Licensing

Sakai is licensed under the Educational Community License version 2.0

Sakai is an Apereo Foundation project and follows the Foundation's guidelines and requirements for Contributor License Agreements.

Contributing

See our dedicated page for more information on contributing to Sakai.

Bugs

For filing bugs against Sakai please use our Jira instance: https://jira.sakaiproject.org/

Nightly servers

For testing out the latest builds go to the nightly server page

Get in touch

If you have any questions, please join the Sakai developer mailing list: To subscribe send an email to sakai-dev+subscribe@apereo.org

To see a full list of Sakai email lists and other communication channels, please check out this Sakai wiki page:
https://confluence.sakaiproject.org/display/PMC/Sakai+email+lists

If you want more immediate response during M-F typical business hours you could try our Slack channels.

https://apereo.slack.com/signup

If you can't find your "at institution.edu" on the Apereo signup page then send an email requesting access for yourself and your institution either to sakai-qa-planners@apereo.org or sakaicoordinator@apereo.org .

Community supported versions

Sakai 19.3 (release, notes)
Is the community supported release of Sakai 19.

Sakai 12.7 (release, notes)
Is the community supported release of Sakai 12.

Sakai 11.4 (release)
And earlier are no longer supported by the community.

For full history of supported releases please see our release information on confluence.

Under Development

Sakai 19.4 is the current developement release of Sakai 19. It is expected to release Q4 2019.

Sakai 12.8 is the current development branch of Sakai 12.

Accessibility

The Sakai Accessibility Working Group is responsible for ensuring that the Sakai framework and its tools are accessible to persons with disabilities. The Sakai Ra11y plan is working towards a VPAT and/or a WCAG2 certification.

CKSource has created a GPL licensed open source version of their Accessibility Checker that lets you inspect the accessibility level of content created in CKEditor and immediately solve any accessibility issues that are found. CKEditor is the open source rich text editor used throughout Sakai. Whlie the Accessibility Checker, due to the GPL license, can not be bundled with Sakai, it can be used with Sakai and the A11y group has created instructions to help you.

Skinning Sakai

Documentation on how to alter the Sakai skin (look and feel) is here https://github.com/sakaiproject/sakai/tree/master/library

Translating Sakai

Translation, internationalization and localization of the Sakai project are coordinated by the Sakai Internationalization/localization community. This community maintains a publicly-accessible report that tracks what percentage of Sakai has been translated into various global languages and dialects. If the software is not yet available in your language, you can translate it with support from the broader Sakai Community to assist you.

From its inception, the Sakai project has been envisioned and designed for global use. Complete or majority-complete translations of Sakai are available in the languages listed below.

Supported languages, Locale, Language, ------, ------, en_US, English (Default), ca_ES, Catalán, es_ES, Español, eu, Euskera, fa_IR, Farsi, fr_FR, Français, hi_IN, Hindi, ja_JP, Japanese, mn, Mongolian, pt_BR, Portuguese (Brazil), sv_SE, Swedish, tr_TR, Turkish, zh_CN, Chinese, ### Other languages

Other languages have been declared legacy in Sakai 19 and have been moved to Sakai Contrib as language packs.

Community (contrib) tools

A number of institutions have written additional tools for Sakai that they use in their local installations, but are not yet in an official release of Sakai. These are being collected at https://github.com/sakaicontrib where you will find information about each one. You might find just the thing you are after!