There are two ways to acquire Sakai source code . You can choose to download a packaged *.zip or *tar.gz file from Sakai's release page or check out the code directly from our code repository using Subversion's (SVN) source control management system.
Sakai packaged releases
Packaged releases are available at
http://source.sakaiproject.org/release/
Once, you have downloaded the code, choose a location to unpack the archive. When unpacked you will see a directory named sakai-src
.
Sakai Subversion repository
Sakai source code can can also be checked out anonymously from our SVN repository. The latest development work is located in /trunk
; stable releases can be found in /tags
while maintenance and other work is performed in /branches
.
...
Sakai
...
...
Trunk
...
.
...
...
https://source.sakaiproject.org/svn/sakai/tags/
...
Branches
...
https://source.sakaiproject.org/svn/sakai/branches/
Starting with Sakai 2.6, Sakai common services (e.g., authz, content, event, site, tool, user, etc.) have been repackaged and refactored as the Sakai Kernel (K1). In most cases, you will never have to check out the kernel manually as Sakai 2.6 kernel dependencies are managed by Maven.
2.
...
Kernel (K1)
...
...
Trunk
...
6 release archive
You can download an archive of Sakai source code:
Archive | URL | checksum | ||
---|---|---|---|---|
.tgz | http://source.sakaiproject.org/svn/kernel/trunk | Tags | ||
.zip | http://source.sakaiproject.org/svn/kernel/tags | Branches | https://source.sakaiproject.org/svn/kernel/branchesrelease/2.6.2/artifacts/sakai-src-2.6.2.zip |
2.6 release tags
To checkout a stable release tag issue the following svn command from the terminal:
No Format |
---|
svn co https://source.sakaiproject.org/svn/sakai/tags/sakai-2.6.0/ sakai-2.6.0 |
2-6-x maintenance branch
The latest bug fixes for a particular release can be found in our maintenance branches. Please note that certain maintenance branch fixes require database schema changes; see the Sakai Confluence Wiki 2-6-x branch summary for more information. You can check out the maintenance branch by issuing the following command from the terminal:
No Format |
---|
svn co https://source.sakaiproject.org/svn/sakai/branches/sakai_2-6-x/ sakai_2-6-x
|
2.6 contributed (Contrib) projects
Additional capabilities provided by Sakai Community members are available as "contrib" projects. These projects range from prototype efforts to mature tool and service releases such as the Universidade Fernando Pessoa's SiteStats tool or Etudes' Melete Lesson Builder tool.
The contrib repo is located at
https://source.sakaiproject.org/contrib/
Before installing a "contrib" tool check its release notes to confirm that it's Sakai common services dependencies have been updated to bind to the new kernel. Contrib tool information can also be found in Sakai's Confluence wiki.
Adding a 2.6-compatible contrib tool to your build is usually a straightforward process. For example, to add SiteStats to you Sakai build checkout the latest release tag into your sakai-2.6.0 base folder:
No Format |
---|
cd sakai-2.6.0
svn co https://source.sakaiproject.org/contrib/ufp/sitestats/tags/sitestats_2-0-rc1/ sitestats
|
Edit SiteStats' base pom file sitestats/pom.xml
updating the <parent> pom's <version> value to the appropriate Sakai version:
...
<!-- Parent: Sakai master pom -->
<parent>
<artifactId>master</artifactId>
<groupId>org.sakaiproject</groupId>
<!-- EDIT ME: Sakai Version -->
<version>2.6.0</version>--> <!-- For 2.6.0 release -->
<!-- <version>2.6.1-SNAPSHOT</version> --> <!-- For 2.6.x branch -->
<!-- <version>2.7.0-SNAPSHOT</version> --> <!-- For TRUNK -->
</parent>
Then install SiteStats artifacts in your local Maven repository followed by deployment to your servlet container (e.g. Tomcat):
No Format |
---|
cd sitestats
mvn clean install sakai:deploy
|