Page Comparison

1.0 Install Prerequisites

...

Sakai 20.0 was QA tested with Java 1.8.0_252, maven 3.5. (though maven-3.3.9 should also work), Apache Tomcat 9.0.19

1.1 Verify/Install Java 1.8 

...

1. Download Tomcat 9 - https://tomcat.apache.org/download-90.cgi
   
   

   • Windows users should get the zip file instead of installing a service
     It makes viewing the tomcat logs easier and it is easier to configure

     
     

2. Extract to /opt (symlink the apache-tomcat-9.0.x directory to tomcat after extracting)

   • Example (assuming you have saved the file as /opt/apache-tomcat-9.0.x.tar.gz)

     cd /opt tar xzvf apache-tomcat-9.0.x.tar.gz ln -nsf apache-tomcat-9.0.x tomcat

   • Windows users should either rename the directory or, if comfortable, create a directory junction using an elevated cmd prompt:

     mklink /J C:\apache-tomcat-9.0.x C:\tomcat

3. Modify conf/server.xml for international character support
   
   1. Add URIEncoding="UTF-8" to the Connector element
      
      • <Connector port="8080" URIEncoding="UTF-8" ...
4. Set environment variable: CATALINA_HOME=/opt/tomcat
5. Add $CATALINA_HOME/bin to PATH

6. Setup the SETENV file in the tomcat/bin directory with JAVA_OPTS.

7. You can populate the database with Demo data or use the quartz job Create Test Sites (Not recommended for production environments)

   1. Using the quartz job will create some sample sites with some sample data in tools ideal for testing

   2. Another alternative instead of starting with an empty database you can add the flag -Dsakai.demo=true in addition to the others shown here. During your first Tomcat launch it will populate your database with test data (students, courses, etc). Once the data has been created remove this flag for subsequent Tomcat launches. Be advised that this flag will not trigger on a database with data already in it so you must make this choice during the initial setup. It should also be noted that without this flag one will not be able to create any course sites in Sakai unless Academic Term, Subject, Course, and Section data is manually added to the "cm_" tables in the database.

      
      

      1. Mac/Linux: Create a file called setenv.sh with the following (alternately, you can put this into your .bashrc file so they're automatically executed):
         Tomcat 9 Mac/Linux

         export JAVA_OPTS="-server -d64 -Xms1g -Xmx2g -Djava.awt.headless=true -XX:+UseCompressedOops -XX:+UseConcMarkSweepGC -XX:+DisableExplicitGC" JAVA_OPTS="$JAVA_OPTS -Dhttp.agent=Sakai" JAVA_OPTS="$JAVA_OPTS -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false" JAVA_OPTS="$JAVA_OPTS -Djava.util.Arrays.useLegacyMergeSort=true" JAVA_OPTS="$JAVA_OPTS -Dsakai.security=$CATALINA_HOME/sakai/" JAVA_OPTS="$JAVA_OPTS -Duser.timezone=US/Eastern" JAVA_OPTS="$JAVA_OPTS -Dsakai.cookieName=SAKAI2SESSIONID" JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=8089 -Dcom.sun.management.jmxremote.local.only=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false"

      2. Windows(PC): Create a file called setenv.bat with the following:
         Tomcat 9 Windows

         set JAVA_OPTS=-server -Xmx1028m -XX:MaxMetaspaceSize=512m -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false -Djava.awt.headless=true -Dcom.sun.management.jmxremote -Dhttp.agent=Sakai -Djava.util.Arrays.useLegacyMergeSort=true -Dfile.encoding=UTF8

8. [OPTIONAL] Delete the default webapps from the webapps dir

   rm -rf webapps/*
   

...

For Sakai 12 and earlier: Edit the file conf/context.xml and add this JarScanFilter block to the <Context>

For Sakai 19 and later: After the JSF 2.3 migration, users may update the tomcat configuration to this one:

...

Tool collections for the home page can be configured for each site type. However, if the wsetup.home.toolids.* property is not set, the Worksite setup tool will default to the following set of tools for the home page: sakai.iframe.site, sakai.summary.calendar, sakai.synoptic.announcement, sakai.synoptic.chat, sakai.synoptic.messagecenter. Synoptic tools will be added or dropped from home page depending on whether their linked tool exists in the site or not. See SAK-15504 - Upgraded site: editing My workspace leads to duplicate Home CLOSED and SAK-16747 - tools are not auto-added into Home tool page CLOSED for more details.

wsetup.home.toolids.count=5
wsetup.home.toolids.1=sakai.privacy
wsetup.home.toolids.2=sakai.iframe
wsetup.home.toolids.3=sakai.synoptic.announcement
wsetup.home.toolids.4=sakai.synoptic.chat
wsetup.home.toolids.5=sakai.synoptic.messagecenter

...

A new group helper is enabled by default (see SAK-13413 - Group creation enhancement CLOSED for more details). Site maintainers can now create groups based on sections and roles. To switch back to the old 2.5 style of group helper (ad-hoc only), one needs to add following setting in sakai.properties:

...

Sakai includes a property called inactiveInterval@org.sakaiproject.tool.api.SessionManager, which dictates the length of inactive time before a users session times out and allows for the enabling of a session timeout warning. Session status is now checked by the Sakai portal. If the remaining session time is less than the warning time (say 10 minutes). When a session expires, the any page requests are redirected to the URL indicated by the loggedOutUrl sakai property. See SAK-13987 - Session Timeout Popup Utilizing Polling data from entity broker CLOSED SAK-8152 - Sakai should warn a user before the user's session times out and data is inadvertently lost CLOSED for more details.

To enable the session timeout warning, set the following properties in your local sakai.properties with a time interval of your choosing:

...