Sakai 12 Installation Guide (source) - Documentation (2023)

To get started, the following items need to be installed (you can skip items already installed).

1. Java 1.8
2. git
3. Maven 3.0 or higher
4. Gato 8

Sakai 12.0 was also tested by Quality ControlJava 1.8.0_111,maven-3-2.5 (although maven-3.3.9 should also work),Apache Tomcat 8.5.28

sun oracleJava SE 8, also known as Java 1.8, is the required version for use with Sakai. Certain files like *.jsp and *.jws need to be compiled, so just downloading and using the runtime environment (JRE 8.0) is not enough.

Run to confirm Java is installed on your system and is the correct version for SakaiJava-Versionfrom the command line:

Java-Version

If Java is installed, the base version and build information is displayed. Example output:

Java-Version „1.8.0_111“ Java(TM) SE Runtime Environment (Build 1.8.0_31-b13) Java HotSpot(TM) 64-Bit Server VM (Build 25.31-b07, gemischter Modus)

Java requires setting various environment variables and associated properties. On UNIX operating systems, you typically change an initialization file such as~/.bash_loginfor defining and exporting shell variables, while Mac users usually define and export environment variables in.bash_profile🇧🇷 Go to in WindowsStart -> Control Panel -> System -> Advanced -> Environment Variablesand establishJAVA_HOMEvia the graphical user interface.

Set the JAVA_HOME environment variable to point to the home directory of your Java installation and add the file/Compartmentdirectory into the PATH environment variable.

If the JRE_HOME variable is already set or you want to use a specific JRE and you have more than one JRE installed on your computer, also set the JRE_HOME variable. JRE_HOME is what Apache Tomcat uses on startup, but by default it uses JAVA_HOME if JRE_HOME is not set. In most cases setting JAVA_HOME should cover both cases sufficiently.

Windows: Append a string to the end ofCaminoSystemvariable

Define JAVA_OPTS

The default Java Virtual Machine (JVM) configuration is not sufficient for an application the size of Sakai. As a result, several JVM parameters need to be increased for Sakai to run, while others may need to be tuned for optimal performance.

We recommend configuring these settings in Tomcat/Compartmentdirectory in a file namedsetenv.sh(Unix/Mac) osetenv.bat(Window). See the Installing Tomcat 8 section below for more details.

Specify a language and regional settings (optional)

You can set the default language/locale when starting Sakai by setting the system properties-duser.languagemi-duser.region🇧🇷 For supported languages, see the release notes or visit thei18NWorking group room.

-Duser.language=pt -Duser.region=PT

If your locale does not fully support Java (e.g. the Basque or Mongolian languages), you should read this information:
I18n project approved

Specify an HTTP proxy (optional)

In environments where local network policies or firewalls require the use of an upstream HTTP proxy/cache, Sakai should be configured accordingly. Otherwise, components or services that use HTTP requests, such asBasic news servicefor RSS feeds in the news tool it is not possible to retrieve data from target URLs. This can be fixed with the followingJAVA_OPTSArguments:

-Dhttp.proxyHost=cache.some.domain -Dhttp.proxyPort=8080

The Sakai Community uses Githuba's Source Control Management (SCM) system. Use a reasonably recent version of Git to get the source. Alternatively, you can get binary packages for Mac/Linux and Windows (Linux is more popular and gets the majority in QA testing by far). Extract the distribution file to your installation directory.

https://github.com/sakaiproject/sakai

The Apache Maven project management framework provides Sakai with "a set of build patterns, an artifact repository model, and a software engine that manages and describes projects" (Better Builds, p. 22). As part of the installation process, you use Maven as a build tool to build, test, and deploy Sakai in a servlet container such as Apache Tomcat.

It is recommended to use Maven 3.2.5 to 3.3.9.

You can download Maven from

http://maven.apache.org/download.html

Extract the distribution file to the installation directory of your choice, e.g./usr/local/apache-maven-3.2.2🇧🇷 Confirm that you have the right version of Maven installed and can start it by typing it outmvn --versionfrom the terminal At this point, your environment is ready to compile and deploy the Sakai source code.

mvn --version

Apache Maven 3.2.5 (45f7c06d68e745d05611f7fd14efb6594181933e; 2014-06-17T09:51:42-04:00) Maven-Startup: /usr/local/apache-maven-3.2.5 Java-Version: 1.8.0_111, Hersteller: Oracle Corporation Java: /usr/lib/jvm/java-8-openjdk-amd64/jre Standardgebietsschema: en_US, Plattformkodierung: UTF-8OS Name: „linux“, Version: „3.13.0-30-generic“, arch: „amd64“ , Familie: "unix"

Several environment variables should be set for optimal Maven performance. For UNIX operating systems, a startup file like ~/.bash_login is usually modified to set and export shell variables, while Mac users usually set and export environment variables.bash_profile🇧🇷 Go to in WindowsStart -> Control Panel -> System -> Advanced -> Environment Variablesand set your maven environment variables via GUI.

put thatMAVEN_HOMEEnvironment variable to point to the base directory of your Maven installation and add Maven/CompartmentDirectory for yourCAMINOVariable:

Windows: Add a string to the end ofCaminoSystemvariable

MAVEN_OPTS

Maven no LeeJAVA_OPTSat startup, which occasionally causes "out of memory" errors when compiling Sakai. To ensure sufficient memory allocation during build, you should add oneMAVEN_OPTSEnvironment variable as defined below. For UNIX operating systems, a startup file like ~/.bash_login is usually modified to set and export shell variables, while Mac users usually set and export environment variables.bash_profile🇧🇷 Go to in WindowsStart -> Control Panel -> System -> Advanced -> Environment Variablesand establishMAVEN_OPTSvia the graphical user interface.

exportar MAVEN_OPTS='-Xms512m -Xmx1024m'

• Apache tomcat -http://tomcat.apache.org/
• Monitoring:Always do a clean install of Tomcat
• monitoring: For Sakai versions earlier than 11.4, use Tomcat 8.0.34 or earlier. Later versions of Tomcat can cause problems. Example:SAK-31608-Sakai has boot warnings on Tomcat 8.0.39+Cerrado
• Monitoring:Windows users should ensure that the full tomcat path does not contain spaces as this will cause errors with the JSF tools on Sakai.
  BOA:C:\opt\tomcat\, C:\sakaistuff\installa\tomcat\
  FOREVER:C:\Programmarchiv\Tomcat\, C:\opt\Apache Tomcat 8.0.43\

1. Download Tomcat fromhttp://tomcat.apache.org/

   • Windows users should get the zip file instead of installing a service
     Makes viewing Tomcat logs easier and easier to configure

2. Extract to /opt (symlink apache tomcat xyz directory to tomcat after extraction)

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

     CD / opt

     tar xzvf apache-tomcat-8,0.x.tar.gz

     ln -nsf apache-tomcat-8,0.x Cat

     (Video) Sakai LTI Briefing 2021-01-14

   • Windows users should rename the directory or, if convenient, create a directory branch with an elevated cmd prompt:

     mklink /J C:\apache-tomcat-8,0.x C:\kater

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

6. Configure the SETENV file in the tomcat/bin directory with JAVA_OPTS (fromInstall Java 1.8).

   Fill the database with demo data

   Instead of starting with an empty database, you can add the -Dsakai.demo=true flag in addition to the others shown here. When you first start Tomcat, you populate your database with test data (students, courses, etc.). Remove this flag after building the data for subsequent versions of Tomcat. Note that this flag will not be raised in a database that already contains data, so you must select this option during initial setup. It should also be noted that without this flag it will not be possible to create any course pages in Sakai unless the Academic Term, Subject, Course and Section data is manually added to the "cm_" tables in the database added.

   Note: Because test users are "provisioned" they do not appear in the user tool. First, log in as "Teacher" with the password "sakai". You can then add multiple lists, including megasections.

   Alternatively, the test data can be completed by running Create Test Sites, Users, and Content. in the task scheduler. This generates many sites, but class sizes are smaller, which is less than ideal for performance testing.

   We recommend using -Djava.util.Arrays.useLegacyMergeSort=true until this issue is resolved -SAK-31707-Broken equality comparisons in the grade bookDISSOLVED

   1. Sakai 21 e Interior:

      1. Mac/Linux: Create a file namedsetenv.shwith the following (alternatively you can put this in your.bashrcfile to run automatically):

         Tomcat 8Mac/Linux

         export JAVA_OPTS="-server -d64 -Xms1g -Xmx2g -Djava.awt.headless=true -XX:+UsarCompressedOops -XX:+UsarConcMarkSweepGC -XX:+DisableExplicitGC"

         JAVA_OPTS="$JAVA_OPTS-Dhttp.agent=Sakai"

         JAVA_OPTS="$JAVA_OPTS -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=falso"

         JAVA_OPTS="$JAVA_OPTS-Dsakai.security=$CATALINA_HOME/sakai/"

         JAVA_OPTS="$JAVA_OPTS -Duser.timezone=USA/East"

         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 namedsetenv.batwith the following:

         Windows Kater 8

         definir JAVA_OPTS=-servidor -Xmx1028m -XX:MaxMetaspaceSize=512m -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=NOT CORRECT-Djava.awt.headless=real-Dcom.sun.management.jmxremote -Dhttp.agent=Sakai -Djava.util.Arrays.useLegacyMergeSort=real-Dfile.encoding=UTF8

         (Video) Sakai - Free React Admin Template

   2. Sakai 22+ (d.h. hat Java 11)

      1. Mac/Linux: Create setenv.sh with the following:

         # Append -Dsakai.demo=realas necessary

         # Specify -Dsakai.security to specify a locationthroughSecurity.Properties

         # Another Sakai configuration21and the example above might also be relevant

         exportar JAVA_OPTS="-servidor -Xmx1028m -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=NOT CORRECT-Djava.awt.headless=real-Dcom.sun.management.jmxremote -Dhttp.agent=Sakai -Dsakai.component.shutdownonerror=real\

         --add-exports=java.base/jdk.internal.misc=ALLE OHNE NAME \

         --add-exports=java.base/sol.nio.ch=ALL WITHOUT NAME\

         --add-exports=java.management/com.sun.jmx.mbeanserver=TODO-SIN-NAME \

         --add-exports=jdk.internal.jvmstat/sun.jvmstat.monitor=TODO SIN NOMBRE \

         --add-exports=java.base/sun.reflect.generics.reflexiveObjects=TODOS SIN NOMBRE \

         --add-opens jdk.management/com.sun.management.internal=ALLE OHNE NAME \

         --illegal access=allow"

      2. Windows: If you are using Windows, update this document with an appropriate setenv.bat

   3. [OPTIONAL] Remove the default webapps from the webapps directory (note: this may be undesirable: webapps/ROOT contains the favicon, etc.)

      rm -rf webapps/*

Improve startup speed

You can greatly improve Tomcat's startup speed by making changesconf/context.xml paraSearch for TLD only in interesting files.

For Sakai 21 and earlier:Add this JarScanFilter block to the <Context>

For Sakai 22 and above: In Java 11, Java EE has been changed to Jakarta EE which includes JSF.Add this JarScanFilter block to the <Context>

You can find the Sakai source code in our Github repository. The latest development work has arrivedthe master branch🇧🇷 Stable versions can be found atlabelwhile maintenance and other work is being carried outan 11.x branch.

11 Launch-Tag

To check for a stable release tag, clone the git repository and then check the tag (11.0 in this case):

Clone of git https://github.com/sakaiproject/sakai.gitcd sakai && git checkout 11.0

Maintenance branch 11.x

Check our maintenance branches for the latest bug fixes for a specific version. Note that certain maintenance branch fixes require changes to the database schema. You can check the maintenance branch by running the following command in the terminal:

git-Klon https://github.com/sakaiproject/sakai.gitcd sakai && git checkout 11.x

If you have already cloned the repository, skip the previous cloning step.

1.0 Create onesakai.propertiesoffice hours

sakai-src/config/configuration/bundles/src/bundle/org/sakaiproject/config/bundle/default.sakai.properties

-Dsakai.home=/path/to/desired/sakai/home/

For a list of sakai.properties settings, see the Sakai Properties Reference; for detailed documentation of the entire range of possibilitiessakai.propertiesConfiguration seesakai_properties.docInside/referencia/docs/arquitectura/sakai_properties.doc.

2.0 Configuring the Homepage toolset per site

wsetup.home.toolids.count=5wsetup.home.toolids.1=sakai.privacywsetup.home.toolids.2=sakai.iframewsetup.home.toolids.3=sakai.synoptic.announcementwsetup.home.toolids.4=sakai. synoptic.chatwsetup.home.toolids.5=sakai.synoptic.messagecenter

Workplace 3.0 Configuration Group Wizard

wsetup.group.helper.name = sakai-site-manage-group-helper

4.0 Session Timeout Warning

timeoutDialogEnabled=truetimeoutDialogWarningSeconds=600

5.0 Set up email

smtp@org.sakaiproject.email.api.EmailService=some.smtp.org

# Flag to enable or disable SMTP service for incoming mail (true | false)#Default=false.smtp.enabled=true# DNS addresses used by SMTP service for incoming mail. (only compatible with versions <= Sakai 10) smtp.dns.1=255.255.255.1smtp.dns.2=255.255.255.2# SMTP port on which the incoming SMTP service is listening. # It is recommended to run at 8025 and use a default mail of 25 to forward mail to Sakai. # Default=25.smtp.port=8025

# Support email address used in incoming email bounce messages.mail.support=address@somedomain# A variation of this used in some places instead of the above! It is better to set bothsupport.email#To change postmaster address to generalsmtpFrom@org.sakaiproject.email.api.EmailService# Email address to send detected portal errors and user error reports to response.portal.error.email = address@somedomain# . Email address used as the "From" address for all emails sent from the Worksite Setup Tool or Site Information Tool.setup.request=address@somedomain# Sends an email to the user when the user is added. from.address# Send or not the real address as msgcntr Notificationsmsgcntr.notification.user.real.from=true (false)

6.0 Configure registration

log.config.count=3log.config.1 = ALLE.org.sakaiproject.log.impllog.config.2 = AUS.org.sakaiprojectlog.config.3 = DEBUG.org.sakaiproject.db.impl

log4j.logger.org.sakaiproject=INFO

log4j.logger.org.sakaiproject=INFOlog4j.logger.org.sakaiproject.component.framework.sql.BasicSqlService=DEBUG

enabled@org.sakaiproject.log.api.LogConfigurationManager = false

bin/home.sh; tail -f logs/catalina.out

7.0 Manage temporary files

Depending on usage, Sakai can create many large temporary files in the system's temporary file location (e.g. /tmp). It's a good idea to routinely delete temporary files older than a day, especially if you have many users or frequently send emails with attachments. Note that you should not delete all temporary files on a schedule, as some of them may be actively used (be careful when deleting temporary files used by other processes).

Sakai 12 database support details

Be sure to include a MySql plugin wrapper in your CATALINA_HOME/lib.

Create a Sakai database with a default UTF-8 character set. Create a user account to which you assign all permissions.

Use whatever database name and username you want, then update your sakai.properties file (or better yet, create a local.properties file that takes precedence).

In the following example, the database is named "sakaidatabase" and the user account is named "sakaiuser".

Excerpt from sakai.properties

usuario@javax.sql.BaseDataFuente=Sakauer
senha@javax.sql.BaseDataFuente=senha sakai

mysql -u root -pEnter password: Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL login ID is 272Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved. This software comes with NO WARRANTIES. This is free software and you can modify and redistribute it under the GPL v2 license. Type "help"; or '\h' for help. Type '\c' to clear the current input statement. mysql> create sakai database default character set utf8; Query OK, 1 row affected (0.00 sec) mysql> all on sakai.* grant to sakaiuser@'localhost' identified by 'sakaipassword';Query OK, 0 rows affected (0.00 sec. mysql> all on sakai.* grant to sakaiuser @'127.0.0.1' identified by 'sakaisenha' Query OK, 0 rows affected (0.00 sec) mysql> flush privileges Query OK, 0 rows affected (0.00 sec) mysql> exit

Install the Sakai master project

Sakai uses the Maven project object model to provide an XML representation of basic project information, covering dependency management, build targets, external repositories, issue tracking, mailing lists, plugin reports, developer biographies, and more. A top-level master pom.xml file located in the/ProfessorThe project acts as a parent for other Sakai pom.xml files. If you are building Sakai for the first time, you must first install the master blueprint by installing thecleanedmiinstall on pcgoals off/Professorproject folder.

cd mastermvn clean installcd ..

Install and deploy Sakai

After creating the master pom, output the following Maven targets from the top-level Sakai source directory:

-Dmaven.tomcat.casaSpecifies the location of Tomcat. -Dsakai.home specifies the location of the Sakai property files in Tomcat. 🇧🇷Djava.net.preferIPv4Stack can help solve problems where Maven crashes when trying to pull from certain repositories. They can be omitted if specified in MavenKonfiguration.xml(Version 2.x) oder in MAVEN_OPTS (Version 3.x).

mvn clean install sakai: deploy -Dmaven.tomcat.home=/pathto/tomcathome -Dsakai.home=/pathto/tomcathome/sakai -Djava.net.preferIPv4Stack=true

Your first build of Sakai will take some time while Maven downloads and saves your location..m2/Repositorywith missing dependencies running build and deployment.guerrami.BottleFiles for Tomcat$CATALINA_HOME/webapps,$CATALINA_HOME/componentsmi$CATALINA_HOME/shared/libIf during this process Maven reports that the build failed, please read the attached error message carefully to resolve the issue (seeTroubleshootingSection).

You can also exhibitmvn sakai clean install: deployfrom a top-level Sakai project modules folder to build and deploy pieces of Sakai as individual tools.

Maven meta options

There are several other ways to build and deploy Sakai with Maven:

Print debug output

mvn -X clean install sakai: deploy

Build and deploy in offline mode

If your local repository contains all Sakai project dependencies, you can run Maven "offline" by using the-ÖPossibility:

mvn -o sakai clean install: deploy

Ignore unit tests

There may be times when you want to build and deploy Sakai without running the suite of unit tests that come with many of Sakai's modules. if yes, add-Dmaven.test.skip=truefor the purposes it issues:

mvn clean install -Dmaven.test.skip=true sakai:deploy

Run a "Framework" build

The Frame Build Profile activates a Sakai build without its tool kit.

mvn -Pframework sakai clean install: deploy

Run a "coffee" build

The Developer Coffee Builder profile is preferred by many developers new to Sakai, as well as those developing or testing new features.

mvn -Pcafe clean install sakai: deploy

Start/stop Tomcat from the terminal by running the appropriate start/shutdown script found in$CATALINA_HOME/box:

Unix/Mac

sh start.shsh deleted.sh

window

startup.batshutdown.bat