Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleInstallation tip

Sakai is highly customizable for your local institution's needs.

...

Sakai 11 Install from Source


Sakai 11 ReadMe

Table of Contents
maxLevel2
minLevel

...

2

Recommend storing files on your file system instead of database

...

Lessons management of HTML pages

By default, Lessons uses Content Security Policy headers to restrict what an HTML page can do, when the page is loaded from Sakai.

This is a security tradeoff. There are security risks from opening a web page written by someone else. That page can contain Javascript, which will execute with your own permissions. For this reason, by default Sakai will not open web pages in Resources. If you click on an HTML file there, it will download. We considered this inaccessible for Lessons, since the whole point of Lessons is to present content online. But we still had to deal with the security problem. So the page is served with an HTTP header that causes browsers to open the page in a “sandbox.” This restricts what the page can do.

This is new in 11. In Sakai 10, Lessons would simply open any HTML page specified.

You can restore the Sakai 10 behavior by adding the following to sakai.properties:

lessonbuilder.use-csp-headers=false

The recommended approach for dealing with this security risk is to use Sakai’s content domain support. This causes HTML pages stored in resources to be served from a different hostname than the main Sakai hostname. E.g. if your institution uses sakai.univ.edu, you might use content.sakai.univ.edu for content, resulting in URL such as https://content.sakai.univ.edu/access/content/group ….  Using a separate domain prevents web pages from executing with your Sakai privileges. Thus if you are using a separate content domain, Lessons does not add the Content Security Policy headers.

Note that it is up to the browser to enforce Content Security Policy. Safari, Chrome, and Edge do. Firefox does not. Thus Firefox users are still at risk when opening HTML pages in Lessons. I believe IE 10 and 11 also support it.


Dashboard not included

The Dashboard tool, new for Sakai 11, has not been included in the 11.0 release because too many technical issues existed and not enough person-power to address them in time for the release.

...

STEP (Samigo Test and Quizzes Enhancement Project) feature to allow different delivery settings for specific sections, groups, and individuals , did not make it into Sakai 11.0 due to issues with the Auto Submit feature and data storage and retrieval issues. We are hoping to have this go into a later 11.x maintenance release.  SAK-34955 - Allow different delivery settings for specific sections, groups, and individuals CLOSED

A number of other features were delivered as a result of STEP for 11.0 including:

SAK-37262 - Report that Shows All Samigo Submissions for a Specific User RESOLVED

SAK-34825 - New question type - image map RESOLVED

SAK-35294 - Update site ids in published question pool questions CLOSED

Features on by default in Sakai 10, turned off by default in Sakai 11


Release
Tool/Service
Ticket
Notes
11.0Samigo Test and QuizzesSAK-36933 - Disable Extended Matching Question type VERIFIEDThe Extended Matching Question type has been turned off by default. A number of issues have surfaced that need attention. See https://jira.sakaiproject.org/issues/?filter=15806
11.0Samigo Test and Quizzes  SAK-36643 - Hide assessment templates by default VERIFIEDAssessment Templates are confusing. Once a Template is used, certain settings may be unavailable to the instructor. For this reason Assessment templates have been turned off by default. You can turn it on by setting samigo.showAssessmentTypes= true in sakai.properties.


...


Release
Tool/Service
Ticket
Notes
11.0SiteINFRSTR-333 - Authenticate to see issue details

# Allow a specific icon for sites. Should we allow sites to supply a specific icon for their site.
# DEFAULT: true
# portal.siteicon.allow=false

11.0CalendarSAK-31414 - Change the default configuration in sakai 11.0 so that the option for maintainers to subscribe to external calendars is enabled by default VERIFIED# calendar.external.subscriptions.enable=false
11.0CalendarSAK-31413 - Change the default configuration in sakai 11.0 so that the option for users to generate a private URL for a calendar is enabled by default, create an additional property: ical.public.secureurl.subscribe VERIFIEDical.opaqueurl.subscribe
11.0ContentSAK-31415 - Change the default configuration in sakai 11.0 so that when a site is deleted it is actually placed into a "recycle bin" - so called "soft deletion" of sites VERIFIED



Highly recommended settings to override default values


Release
Tool/Service
Ticket
Notes
11.0HikariCPSAK-39486 - Add support for HikariCP connection pool RESOLVED

In Oracle 11c, the default maximum number of database connections in the connection pool may be too low for a production server.

This setting and others for HikariCP can be configured in kernel/kernel-component/src/main/webapp/WEB-INF/db-components.xml, or overridden in sakai.properties in the form:

maximumPoolSize@javax.sql.BaseDataSource=50


11.0Feedback toolSAK-31184 - Improvements to the Feedback Tool CLOSED
# ######################################
# SAK-29271 Feedback Tool Properties
# ######################################
# Recipient address that will receive the contact emails
# feedback.technicalAddress = someaddress@institution.org

# Enable/Disable the content panel
# DEFAULT: true
# feedback.show.content.panel = false

# Enable/Disable the help panel
# DEFAULT: true
# feedback.show.help.panel = false

# Enable/Disable the technical panel
# DEFAULT: true
# feedback.show.technical.panel = false

# Enable/Disable the suggestions panel
# DEFAULT: true
# feedback.show.suggestions.panel = false

# Configure the help link destination (Sakai help by default)
# feedback.helpPagesUrl = /portal/help/main

# Configure the help link target
# feedback.helpPagesTarget = _blank

# Configure the helpdesk destination
# feedback.helpdeskUrl = https://helpdesk.institution.org

# Configure the suggestion link destination
# feedback.featureSuggestionUrl = https://suggestions.institution.org

# Add supplementary information at the right side of the tool
# feedback.supplementaryInfo = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

# Maximum size for the feedback attachments. This value should be lower than content.upload.max value, if it's higher the tool will use content.upload.max value
# feedback.attach.max = 10


...


Release
Tool/Service
Ticket
Notes
11.0AssignmentsSAK-29406 - Allow Assignment tool to grade with two decimal points CLOSEDThe default number of decimal places for grading in Assignments is 2, expanded from 1.
11.0DropboxSAK-11647 - Make Dropbox section-aware CLOSEDNew for 11.



Sakai 11 skins using Morpheus

...


Release

Tool/Service

Property

Ticket

Change

Release

Tool/Service

Property

Ticket

Change

11.0Dropboxdropbox.maintain.own.groupsSAK-11647Courses with multiple TAs (teaching assistants) managing multiple discussion sections have a need for the TAs to be able to access student dropboxes by their sections.
11.0Samigo Test and Quizzessamigo.pdf.convertformattedtextSAM-2502
  1. In the PDF print output, setting this to true will remove all HTML formatting from the questions and answers (This was a legacy setting just added incase someone was using it or it was causing problems)
    +# Default: false
    +# samigo.pdf.convertformattedtext=true
11.0Samigo Test and Quizzessamigo.SelectAssessmentBean.warnUserOfModificationSAM-1331

# SAM-1331: Warn user of modification to edited quiz
# DEFAULT: true
# samigo.SelectAssessmentBean.warnUserOfModification=false

11.0Samigo Test and Quizzessamigo.fromAddressSAM-1947

+# SAM-1947 Email notifications on Samigo Submission
+# The from address for individual submission notifications
+# DEFAULT: no-reply@serverName
+# samigo.fromAddress=<SAMIGO_SMTP_FROM>

10.0Samigo Test and Quizzesvaries by question typeSAM-2296Allow question types to be selectively disabled via Sakai properties. Added in Sakai 10
11.0Samigo Test and Quizzessamigo.allowMinScoreSAM-948

## TEST & QUIZZES (SAMIGO)
# SAM-948 - Minimum value option for questions
# DEFAULT: FALSE
# samigo.allowMinScore=true

11.0CK Editor (Rich Text Editor)auto saveSAK-22495

not a Sakai property!

ckeditor.launch.properties in the source code, so there are properties but not Sakai properties like we think of them. We're really just including a CKEditor community plugin so the configuration and code maintenance of the plugin is up to them (http://ckeditor.com/addon/autosave).

11.0MathJaxon by default. several properties.SAK-22384

+# SAK-22384 - MathJax support is enabled by default
# See https://jira.sakaiproject.org/browse/SAK-22384 for more details and a demo.


+# URL to MathJax.js, you can use the one on the mathjax CDN or put one locally. Currently this is not included with Sakai.
+# The current default is the MathJax CDN latest (https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe)
+#portal.mathjax.src.path=

+# Whether to allow useres to enable or disable MathJAX, this still has to be enabled on a per site basis (default is true)
+#portal.mathjax.enabled=false




SAK-23256



SAK-30270



SAK-26283



SAK-29182
11.0Site Infosite.setup.import.addmissingtoolsSAK-28069
  1. SAK-28069: Enable the automatic addition of any missing tools into a site when content from another site is selected for import
  2. DEFAULT: false
  3. site.setup.import.addmissingtools=true



SAK-28059



SAK-28990



SAK-29000



SAK-28997
11.0Gateway pagesite.types.publicChangeable
site.types.publicOnly
SAK-28119

It enables an institution to define what site types are by default publicly available via the "Site Browser" tool on the Gateway.

It also enables an institution to define what site types are or are not changeable by the maintainer, with regards to the "public" vs. "private" setting (site browser).




SAK-29019



SAK-22537



SAK-29478



SAK-29935



SAK-24398



SAK-24393



SAK-27743



SAK-29408



SAK-29701



SAK-29458



SAK-29001



SAK-23556



SAK-27774



SAK-29138
11.0Portal

moresites.externalConfig.siteTypes
moresites.externalConfig.prefix

SAK-30712

Currently, More Sites tab classifies the sites by their site type and course term if there is one, but this has several issues.

-New site types can't be classified apart without hardcoding them.
-New course-like site types or project-like site types can't be isolated from courses/projects.

Our proposal is two optional properties in sakai.properties. One (moresites.externalConfig.siteTypes) with the list of site types and other (moresites.externalConfig.prefix) with the prefix to use in the properties files, so every site type in the list can be classified in More Sites tab by its internationalized property key.

For example, for setting two new site types (courseAsig is a new course type and course 2 is a new site type), sakai.properties would have this:

moresites.externalConfig.siteTypes=course_asig,course_2
moresites.externalConfig.prefix=moresites_

And the properties "moresites_course_asig" and "moresites_course_2" would be used for the i18n texts in sitenav.properties.

If moresites.externalConfig.siteTypes is not set or is empty, the usual logic is applied.




SAK-29702



SAK-25494



SAK-29180



SAK-29113



SAK-29560



SAK-29156



SAK-27809



SAK-25768



SAK-29736



SAK-25877



SAK-27973



SAK-31414



SAK-24618



SAK-27902



SAK-31417
11.0CK Editorwysiwyg.editor.ckeditor.browserSAK-29884

# The file browser to use for picking files in ckeditor
# The only other option is fckeditor.
# DEFAULT: elfinder
# wysiwyg.editor.ckeditor.browser=fckeditor




SAK-27769



SAK-27757



SAK-26318



SAK-26601



SAK-31415



SAK-30267



SAK-29389



SAK-29402



SAK-29135



SAK-31325



SAK-31413



SAK-25381



SAK-30424


basiclti.provider

contentitem.provider

SAK-30418



SAK-30372
11.0Assignmentsassignment.grading.decimalsSAK-29406

+# ######################################
+# SAK-29406 Allow Assignment tool to grade with two decimal points
+# ######################################
+# decimal points used to grade in new assignments (created after this code was applied),
+# old assignments (created before this code) will continue using 1 decimal point to grade
+# DEFAULT: 2 (new assignments will use 2 decimal places for grading by default)
+#assignment.grading.decimals=1




SAK-28055



SAK-25556



SAK-28184



LSNBLDR-316



LSNBLDR-444



KNL-101



KNL-1063



KNL-1306



KNL-1221



KNL-1361



KNL-1163



KNL-1123






...