Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
5365 lines (4288 sloc) 230 KB
## sakai.properties - the default edition
# This file is the default for providing all configuration and placeholder values for Sakai.
## Properties files load order: component-manager/kernel -> config/default -> sakai/sakai -> sakai/local -> sakai/security
# This file is read by the Sakai Kernel and overrides kernel.properties
# All other sakai.properties files defined locally override these settings
## NOTE: Recommend that you use this as a reference copy of sakai.properties
## but put your actual config settings into a local.properties or security.properties file
## (sort of like apache webserver does it)
## NOTE: All properties in this files should be commented out AND should include a comment indicating the default value and a sample value
## Major cleanup of this file was done as part of https://jira.sakaiproject.org/browse/SAK-21124
## Questions or comments to Aaron Zeckoski (azeckoski @ unicon.net) (azeckoski @ vt.edu)
# ########################################################################
# INSTITUTIONAL "PERSONALIZATION"
# ########################################################################
## Control the server Url and logout Url in the URLS section
# Identify your application server with a short name, unique among the servers in your cluster.
# choose a server id even if you are running a single app server
# DEFAULT: localhost
# serverId=localhost
# the DNS name of the server.
# DEFAULT: localhost
# serverName=localhost
# aliases the server may have. If the server sees a URL with this it can assume that the same content would be
# accessed if the serverName was put in it's place.
# DEFAULT: (EMPTY)
# serverNameAliases=www.sakai.inst.edu,other.sakai.inst.edu
## Fill-ins for the css/vm ui (Worksite Setup, Digest Service, Email notification, Worksite Setup, Contact Support, Portal)
# Name of the institution running the app
# DEFAULT: "" (empty string)
# ui.institution = Your Institution
# Name of the service (application)
# DEFAULT: Sakai (or sometimes "" (empty string))
# ui.service = LocalSakaiName
# PATHS
# File path to the Sakai portal
# DEFAULT: /portal
# portalPath=/portal
# File path to the Sakai access servlet (file download)
# DEFAULT: /access
# accessPath=/access
# File path to the Sakai help webapp
# DEFAULT: /help
# helpPath=/help
# File path to the Sakai tool handler. Use /tool for the new dispatcher
# DEFAULT: /portal/tool
# toolPath=/portal/tool
# Enable/disable the Sakai tutorial
# DEFAULT: true
# portal.use.tutorial=false
# SAK-29457
# Enable/disable the cookie policy warning
# DEFAULT: false
# portal.cookie.policy.warning.enabled = true
#
# Allow a specific icon for sites. Should we allow sites to supply a specific icon for their site.
# DEFAULT: true
# portal.siteicon.allow=false
# Cookie policy URL
# portal.cookie.policy.warning.url = /library/content/cookie_policy.html
# SAK-25634
# Add support for Google Analytics to the Portal
# Google analytics is NOT enabled by default, setting these will enable it
#
# portal.google.analytics_id=UA-XXXXXX-XX
# portal.google.analytics_domain=yoursakaihost.edu
# portal.google.analytics_detail=true
# SAK-28052
# Add support for Universal Google Analytics
# Google analytics is NOT enabled by default, setting these will enable it
#
# portal.google.universal_analytics_id=UA-XXXXXX-XX
# SAK-41039
# Support to anonymize IP in Google Analytics, only supported by Universal Google Analytics.
# Default: false
# portal.google.anonymize.ip = true
# SAK-29668
# Add support for Google Tag Manager
# Google Tag Manager is NOT enabled by default, setting these will enable it
# portal.google.tag.manager.container_id = GTM-XXXXX
# SAK-29138 - If set to true, portal will use student's enrolled section title (of preferred type, see below)
# rather than the site's title for the course site tab, page (browser tab) title, and tool header title
# DEFAULT: false
# portal.use.sectionTitle=true
# SAK-29138 - Determines the preferred section type to use when a student is enrolled in multiple sections in the same site
# DEFAULT: LEC
# portal.use.sectionTitle.preferredCategory=TUT
# SAK-30485 - Enable logout confirmation
# DEFAULT: false
# portal.logout.confirmation=true
# SAK-32224 - Ability to disable the animated tool menu by property
# DEFAULT: true
# portal.scrolling.toolbar.enabled=false
# ########################################################################
# GATEWAY SITE
# ########################################################################
# Gateway site id (this is the anonymous access site that is shown to the user when they are not logged in yet)
# DEFAULT: !gateway
# gatewaySiteId=!gateway
# Gateway site list
# Comma-separated list of siteIds. These sites must include the .anon role and at a minimum give
# the .anon role site.visit - and any other permissions you want (usually *.read) permissions to the .anon role.
# If the .anon role does not have site.visit - these sites will not appear in the gateway - even if they are in this list.
# In the example below, mercury does *not* have site.visit for .anon so it does not appear.
# DEFAULT: displays a single gateway site specified by gatewaySiteId
# gatewaySiteList=!gateway,mercury
# Optional URL for the gateway site
# DEFAULT: none (null)
# gatewaySiteUrl=
# ########################################################################
# FOOTER
# ########################################################################
# Links placed on the bottom nav - set the .count to the number of items, then add each item
# DEFAULTS as shown below (from component-manager/kernel.properties)
# bottomnav.count = 3
# bottomnav.1 = <a href="/portal/site/!gateway">Gateway</a>
# bottomnav.2 = <a href="/portal/help/TOCDisplay/content.hlp?docId=accessibilityinformation" target="_blank">Accessibility Information</a>
# bottomnav.3 = <a href="http://www.sakaiproject.org/" target="_blank">The Sakai Project</a>
# ALTERNATELY, define bottomnav as a comma separated list of values to use
# bottomnav=<a href="/portal/site/!gateway">Gateway</a>,<a href="/portal/help/TOCDisplay/content.hlp?docId=accessibilityinformation" target="_blank">Accessibility Information</a>,<a href="http://www.sakaiproject.org/" target="_blank">The Sakai Project</a>
# Powered by assertions placed at the bottom of the portal.
# DEFAULTS as shown below (from component-manager/kernel.properties)
# powered.url.count=1
# powered.url.1=https://www.sakaiproject.org/
# powered.img.count=1
# powered.img.1=/library/image/poweredBySakai.png
# powered.alt.count=1
# powered.alt.1=Powered by Sakai
# Copyright statement
# DEFAULT as shown below (from component-manager/kernel.properties)
# The keyword "currentYearFromServer" will be automatically substituted by Sakai to be set to by the server's end date.
# Using this keyword in the copyright statement can allow the copyright end date to automatically be updated to the current year.
# If you do not wish to have the copyright end date to be automatically updated, do not include the keyword in bottom.copyrighttext.
# bottom.copyrighttext=Copyright 2003-currentYearFromServer The Sakai Foundation. All rights reserved.
## VERSION - The are set in auto.sakai.properties at build time.
# Format: ${ui.service} - \${version.service} - Sakai \${version.sakai}) - Server ${serverId}
# version.service=your local name for Sakai (e.g., bspace, ctools, oncourse, vula)
# version.sakai=the version of Sakai you are running (e.g., 2.5.6, 2.6.2, 2.7.0)
# version.service=TRUNK
# version.sakai=2.9-SNAPSHOT
# Message bundle management
# DEFAULT: false
# load.bundles.from.db=true
# Property added to control the number of milliseconds before rechecking database for updates, the default is 30 secs.
# DEFAULT: 30000
# load.bundles.from.db.timeout=
# Name value pairs of the format "name::value" (no quotes) for insertion into all response headers.
# DEFAULT: none
# response.headers.count=2
# response.headers.1=name::value
# response.headers.2=foo::bar
# ########################################################################
# LOGIN/LOGOUT
# ########################################################################
# **NOTE: typically top.login and container.login should not be both set true or false
# Include the user id and password for login on the gateway site
# DEFAULT: true
#top.login=true
# Let the container handle login or not.
# Set to true for single-sign on type setups, false for just internal login
# DEFAULT: false
#container.login=false
# Enabled extra login (use when enabling container login e.g. CAS) for direct guest login into Sakai
# DEFAULT: false (disabled)
#xlogin.enabled=true
# Use xlogin page to re-login (use when enabling container login e.g. CAS)
# DEFAULT: true
#login.use.xlogin.to.relogin=false
# Set the icon or text you want for each option. Generally you wouldn't use both.
# DEFAULTS: none
#container.login.choice.icon=http://url/to/cas.jpg
#container.login.choice.text=Container login Users
#login.text.title=Login for container users
# Text to display for the extra login (no effect if xlogin is not enabled)
# If a message is required to indicate the type of login populate xlogin.choice
# and login.text.title
#xlogin.choice.icon=http://url/to/sakai.jpg
#xlogin.choice=This page is for external user accounts. If you have an institution Single Sign On Account please use the
#xlogin.choice.text = Guest Users
#xlogin.text.title=Login for guest users
#xlogin.text=Guest Login
# Support for linking off the external login page to the container login page
# only for when container.login=true and xlogin.enabled=true
#login.container.url=/portal/login
# Should logins be allowed through HTTP basic authentication?
# DEFAULT: false
#allow.basic.auth.login=true
# If allow.basic.auth.login = true, then this feature is
# enabled in BasicAuth, the determination of non browser clients is
# driven by matching user agent headers against a sequence of regex patterns.
# These are defined in BasicAuth with the form if the pattern matches a
# browser 1pattern or if it does not match 0pattern
#
# The list is matched in order, the first match found being definitive. If no
# match is found, then the client is assumed to be a browser.
#
# e.g. if itunes was not listed as a client, either:
# DEFAULT: none (null)
#login.browser.user.agent.count=1
#login.browser.user.agent.1=0itunes.*
# Log failed login attempts?
# DEFAULT: true
#login.log-failed=false
# URL to image to use for logout image.
# DEFAULT: none (null)
#logout.icon=
# The message/text display for "logout" - note, if logout.icon is used, the message text is not displayed.
# DEFAULT: sit_log property from the portal-impl/sitenav.properties
#logout.text=
# Set the URL for container logout.
# If you want a different URL when container authenticated users are logged out use this.
# DEFAULT: none (null)
#login.container.logout.url=https://sso.instition.edu/logout
# SAK-21498 prompt use to select an auth source when requesting authentication
# Enable the auth choice page. Only set this if container.login=true
# DEFAULT: false
#login.auth.choice=true
# SAK-21927 Create a link from the login tool to the password reset.
# The URL where users should be directed to reset their password. This is presented to
# users on the login tool when entering their username and password. If you leave
# this unset and you have the password reset tool on your gateway site users
# will be automatically directed to that tool.
# DEFAULT: none (null)
#login.password.reset.url=http://url/to/reset/password
# SAK-16499
# Url to redirect the user to when they have been disabled
# If you do not specify a disabledSiteUrl then the system
# will use /portal/disabled by default.
# You can go and create a public /portal/disabled site/page
# for this purpose.
#disabledSiteUrl=https://this.user.is.disabled/disabled
# ########################################################################
# URLS (portal, shortened, etc.)
# ########################################################################
# The URL to the server, including transport, DNS name, and port, if any.
# DEFAULT: http://localhost:8080
# serverUrl=http://localhost:8080
# the URL to send folks to after they logout
# DEFAULT: /portal
# loggedOutUrl=/portal
# The user home URL to show in the portal ("#UID#" will be replaced with the current logged in user id - not eid)
# NOTE: this is relative to the server root
# Default: "/portal/site/~#UID#"
# userHomeUrl=/portal/site/~#UID#
# Locations of resources to display for accessibility, server, myworkspace and unconfigured web content
# DEFAULT: as shown below (from component-manager/kernel.properties)
# server.info.url=/library/content/server_info.html
# myworkspace.info.url=/library/content/myworkspace_info.html
# webcontent.instructions.url=/library/content/webcontent_instructions.html
# webdav.instructions.url=/library/content/webdav_instructions.html
# Enforce all file uploads to be hidden by default
# content.dav.upload.hidden=false
# The location (url) of the accessibility info
# DEFAULT: ""
# accessibility.url=
## SHORTENED URLs - https://confluence.sakaiproject.org/display/SHRTURL
## Select the Shortened URL processing engine
# DEFAULT: RANDOMISED as of Sakai 10.0
## IMPL: RANDOMISED (Default)
# Disable the shortened URL processing entirely (by setting this to '')
# shortenedurl.implementation=org.sakaiproject.shortenedurl.api.RandomisedUrlService
## IMPL: BIT.LY
# Uncomment this to use the bit.ly URL shortner
# WARNING: If you use this option, shortened URLs created with the "direct URL" button for tools
# will not be fixed up when sites are duplicated. With the default implementation they will be.
# You must also have a bitly account. So signup, navigate to http://bit.ly/a/your_api_key,
# retrieve your details, uncomment and set the following:
# shortenedurl.implementation.bitly.login=johnsmith
# shortenedurl.implementation.bitly.key=123qwe456asd789zxc
# shortenedurl.implementation=org.sakaiproject.shortenedurl.api.BitlyUrlService
## UI SUPPORT
# Enable the UI in various tools for presenting shortenedurls
# Note: UI support for short URLs are enabled by default
# Resources
# DEFAULT: true
# shortenedurl.resources.enabled=false
# Direct URLs to tools
# enables a link icon for each tool in the portal so you can get a direct URL to the tool.
# DEFAULT: true
# portal.tool.direct.url.enabled=false
# In conjunction with the above, if set to true, shows the option to shorten that link.
# DEFAULT: true
# shortenedurl.portal.tool.enabled=false
## EXTERNAL URL SHORTENING
# By default, external URLs (ie a URL for another site) cannot be shortened using the /direct/url entity provider
# You can change this by setting the following to true.
# DEFAULT: false
# shortenedurl.external.enabled=true
# QUICK LINKS CONFIG ON TOP NAV BAR
# url, title, name and icon must be populated.
# These can be per skin as well as the top level, put the skin name in the key e.g. portal.quicklink.[skin].url.1
# Icon entry can specify an icon to be used as an HTML class or an image to be added as a background-image
# attribute in the HTML. If using an icon put 'cl' before the name, if using an image put 'im' before the name.
# Information message at the top of the quicklinks pop-up box:
#portal.quicklink.info=Links open in a new window
#portal.quicklink.url.count=2
#portal.quicklink.title.count=2
#portal.quicklink.name.count=2
#portal.quicklink.icon.count=2
#portal.quicklink.url.1=https://sakaiproject.org/
#portal.quicklink.title.1=Sakai Project Website
#portal.quicklink.name.1=Sakai Project
#portal.quicklink.icon.1=im /library/image/sakai/url.gif
#portal.quicklink.url.2=https://www.apereo.org/
#portal.quicklink.title.2=Apereo Website
#portal.quicklink.name.2=Apereo
#portal.quicklink.icon.2=cl fa fa-globe
# ########################################################################
# DATABASE
# ########################################################################
# Let Sakai generate database objects on startup.
# If this is false then Sakai will NOT create tables or load default DB data on startup (it will have to be created manually)
# DEFAULT: true (from component-manager/kernel.properties)
# auto.ddl=true
# This works in conjunction with auto.ddl in the following way
# if auto.ddl=true then hibernate.hbm2ddl.auto=update
# other values can only be set when auto.ddl is false:
# validate - validate the schema, makes no changes to the database but startup will fail if validation fails
# update - update the schema
# create - creates the scheming destroying existing data
# create-drop - drop the schema when sakai is stopped destroying existing data
# CAREFUL with using create or create-drop as it will drop hibernate tables and recreate them wiping out your existing data
# DEFAULT: empty string
# hibernate.hbm2ddl.auto=update
# Enable hibernate SQL debugging output in the logs.
# DEFAULT: false
# hibernate.show_sql=false
# The database username and password. The defaults are for the out-of-the-box HSQLDB.
# Change to match your setup. Do NOT enable access to your database without a password.
# Defaults: HSQLDB default user: "sa"/""
# username@javax.sql.BaseDataSource=sa
# password@javax.sql.BaseDataSource=
# Colon (":") separated list of tables to cache. Start the list with a colon. Use :all: to cache all tables
# DEFAULT: none (null)
# DbFlatPropertiesCache=
## HSQLDB settings (active/in-memory by DEFAULT)
# vendor@org.sakaiproject.db.api.SqlService=hsqldb
# driverClassName@javax.sql.BaseDataSource=org.hsqldb.jdbcDriver
# hibernate.dialect=org.hibernate.dialect.HSQLDialect
# validationQuery@javax.sql.BaseDataSource=select 1 from INFORMATION_SCHEMA.SYSTEM_USERS
# Two hsqldb storage options: first for in-memory (no persistence between runs), second for disk based.
# url@javax.sql.BaseDataSource=jdbc:hsqldb:mem:sakai
# url@javax.sql.BaseDataSource=jdbc:hsqldb:file:${sakai.home}db/sakai.db
## MySQL settings
# vendor@org.sakaiproject.db.api.SqlService=mysql
# driverClassName@javax.sql.BaseDataSource=com.mysql.jdbc.Driver
# driverClassName@javax.sql.BaseDataSource=org.mariadb.jdbc.Driver
# hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
# url@javax.sql.BaseDataSource=jdbc:mysql://127.0.0.1:3306/sakai?useUnicode=true&characterEncoding=UTF-8
# validationQuery@javax.sql.BaseDataSource=select 1 from DUAL
# defaultTransactionIsolationString@javax.sql.BaseDataSource=TRANSACTION_READ_COMMITTED
# To get accurate MySQL query throughput statistics (e.g. for graphing) from the mysql command show status like 'Com_select'
# This alternate validation query should be used so as not to increment the query counter unnecessarily when validating the connection:
# validationQuery@javax.sql.BaseDataSource=show variables like 'version'
## Oracle settings - make sure to alter as appropriate
# vendor@org.sakaiproject.db.api.SqlService=oracle
# driverClassName@javax.sql.BaseDataSource=oracle.jdbc.driver.OracleDriver
# hibernate.dialect=org.hibernate.dialect.Oracle9iDialect
# hibernate.dialect=org.hibernate.dialect.Oracle10gDialect
# url@javax.sql.BaseDataSource=jdbc:oracle:thin:@your.oracle.dns:1521:SID
# validationQuery@javax.sql.BaseDataSource=select 1 from DUAL
# defaultTransactionIsolationString@javax.sql.BaseDataSource=TRANSACTION_READ_COMMITTED
# For improved Oracle performance, implementers using Oracle should strongly consider
# enabling all the following settings just as they appear (suggestion from the University of Michigan).
#validationQuery@javax.sql.BaseDataSource=
#defaultTransactionIsolationString@javax.sql.BaseDataSource=
#testOnBorrow@javax.sql.BaseDataSource=false
# Check and warn (to logging) when the SAKAI_EVENT table size is approaching the point of impacting performance
# DEFAULT: true
# events.size.check=false
# Sakai Hibernate extension to inform the default hibernate "uuid2" id generator to allow certain persistence classes
# the ability to set their ID manually. Normally this is prohibited by hibernate but there are times where it is appropriate
# for the id to be assigned and persisted with a specific id, for example during a conversion (see assignments conversion).
# Warning this should only be set if you fully understand its use. see org.sakaiproject.hibernate.AssignableUUIDGenerator
# hibernate.assignable.id.classes=org.sakaiproject.packageB.persistence.class,org.sakaiproject.packageA.persistence.class
# ########################################################################
# CONTENT (FILE STORAGE)
# ########################################################################
# Sakai will store the file content in the database as BLOBs by default,
# set this value to change it to store the content on the filesystem instead.
# The file system root for content hosting's external stored files
# (default is null, i.e. store them in the db)
# see the readme file (2.2.7 File Based Content Hosting) for more details
# bodyPath@org.sakaiproject.content.api.ContentHostingService=/someplace/
# KNL-309 : To enable support for deleted files set this property to some location
# bodyPathDeleted@org.sakaiproject.content.api.ContentHostingService=${sakai.home}db/bodyContentDeleted/
# When storing content hosting's body bits in files, an optional set of folders just within the bodyPath -
# to act as volumes to distribute the files among - a comma separate list of folders. If left out, no volumes will be used.
# see the readme file (2.2.7 File Based Content Hosting) for more details
# bodyVolumes@org.sakaiproject.content.api.ContentHostingService=vol1,vol2,vol3
# Set to true to enable the release/retract and hiding of resources in ContentHostingService, Default: true
# availabilityChecksEnabled@org.sakaiproject.content.api.ContentHostingService=true
# Set to true to enable custom sorts within folders in ContentHostingService and the Resources tool
# DEFAULT: true
# prioritySortEnabled@org.sakaiproject.content.api.ContentHostingService=true
### ARCHIVES
## Storage location (file location) where archive data is stored and read from
# Root of archive file system area - used to write archive files and to read them
# when clustering app servers, this should be a shared network location
# DEPRECATED: storagePath@org.sakaiproject.archive.api.ArchiveService=${sakai.home}/archive/
# DEFAULT: ${sakai.home}/archive/
# archive.storage.path=${sakai.home}/archive/
# SAK-28087 Set the max time an archive job will run (in millseconds)
# DEFAULT: 1800000 (1000 ms * 60 seconds * 30 minutes)
# A large institution with many courses may need 24 hours or more to process a large term
# archive.max.job.time=86400000
## Archive filtering
# This controls what types of data and users are allowed to work with archive imports in Sakai
# Controls if data type filtering is enabled. If enabled, any data types not in the services list will be skipped
# DEPRECATED: mergeFilterSakaiServices@org.sakaiproject.archive.api.ArchiveService=false
# DEFAULT: true
# archive.merge.filter.services=false
# List of data service types that can merge in data from an archive
# DEFAULT: AnnouncementService,AssignmentService,ContentHostingService,CalendarService,ChatEntityProducer,DiscussionService,MailArchiveService,SyllabusService,RWikiObjectService,DiscussionForumService,WebService,LessonBuilderEntityProducer
# archive.merge.filtered.services={list of service names}
# Controls if user role filtering is enabled. If enabled, any user roles not in the list cannot archive or merge data
# DEPRECATED: mergeFilterSakaiRoles@org.sakaiproject.archive.api.ArchiveService=false
# DEFAULT: true
# archive.merge.filter.roles=false
# List of user roles that can merge and archive data
# DEFAULT: Affiliate,Assistant,Instructor,Maintain,Organizer,Owner
# archive.merge.filtered.roles={list of roles}
# URL of text file containing URLs of Sakai archives to import on startup.
# The file has one URL per line and lines starting with a comment are ignored.
# DEFAULT:
# archives.import.source=http://someserver.edu/file/import.txt
# Upload limit per request, in MBs.
# "ceiling" is used for resources. "max" is used for attachments.
# In the case when both are set, resources are limited to the smaller of the two. If only one of the two are set, resource uploads
# are limited to the value whichever is set. Attachments are limited at either 20 or the setting of "max".
# Example: content.upload.max=50 and content.upload.ceiling=25 (attachments limit of 50MB and resource uploads at 25MB)
# Example: content.upload.max=10 and content.upload.ceiling=15 (attachments limit of 10MB and resource uploads at 10MB)
# Example: content.upload.ceiling=25 (attachments limit of 20MB and resource uploads at 25MB)
# Example: content.upload.max=50 (attachments limit of 50MB and resource uploads at 50MB)
# DEFAULT: 20
# content.upload.max=20
# **Note - online documentation states ceiling is set in bytes - this is incorrect. Settings are in MB.
# content.upload.ceiling=20
# The UI should show hidden as the default when uploading files
# content.dnd.visibility.hidden=false
# Enable zip content handling (affects resources), on by default
# Allows users to upload zip files and have them be expanded into the content (resources tool) and
# allows downloading a zip file of a folder or folders from Sakai content (through resources tool)
# DEFAULT: true
# content.zip.enabled=true
# Set the limit of the max number of files to extract from a zip archive
# DEFAULT: 1000
# content.zip.expand.maxfiles=1000
# Enable zip file expansion into content (affects resources), on by default
# DEFAULT: true
# content.zip.expand.enabled=true
# Enable content compression into zip file (affects resources), on by default
# DEFAULT: true
# content.zip.compress.enabled=true
# KNL-1221 Charsets used to expand zip file name.
# No matter set or not, UTF-8 will be tested.
# The sample is used in simplified Chinese envirnoment.
# DEFAULT: (not set, and UTF-8 will be used)
# content.zip.expand.charsets.count=1
# content.zip.expand.charsets.1=GBK
# Enable creation of Web Content tools from resources, on by default.
# DEFAULT: true
# content.make.site.page=true
# SAK-21955 - Enforce a limit for how many files are displayed in resources
# Not having a limit could potentially lead to slow performance or errors
# Having a limit could mean that some files are not possible to access via the UI
# DEFAULT: 0 (Unlimited)
# sakai.content.resourceLimit = <int>
# SAK-30739 - Whether or not to display a content copyright dialog for web links
# DEFAULT: true (dialog option)
# content.url.rightsdialog=false
## Quotas
# Allows limits to be placed on the amount of content a user can place in resources
# All quotas default to unlimited (0)
# Set the maximum size for resources (content) in sites, does not affect the dropbox
# DEFAULT: 1048576 (1GB)
# content.quota={value in KB}
# Allows the all sites quota to be overridden by site type (e.g. "project", "course", "workspace") - SAK-8060
# DEFAULTS: to the content.quota default
# content.quota.{sitetype}={value in KB}
# Set the dropbox quota for all sites/dropboxes
# DEFAULT: 1048576 (1GB)
# content.dropbox.quota={value in KB}
# Allows the all dropboxes quota to be overridden by site type (e.g. "project", "course", "workspace") - SAK-8060
# DEFAULTS: to the content.dropbox.quota default
# content.dropbox.quota.{sitetype}={value in KB}
# Manually set conversion completion status (anyone on sakai 2.5+ should be "converted" already)
# DEFAULT: true (online documentation incorrectly states default is false)
# content.filesizeColumnReady=false
# Set whether to use the smart sorting as the default for content
# DEFEAULT: true
# content.smartSort=false
# Turn on/off Content Hosting Handler support
# DEFAULT: false (off)
# content.useCHH=true
# KNL-101: Turn on mime type detection
# DEFAULT: true (on)
# content.useMimeMagic=false
# KNL-1306 - Support to ignore content from certain types and extensions
# If this file extension is in the list, the content from the file will not be used to aide in detection of the type
# DEFAULT: js
# content.mimeMagic.ignorecontent.extensions=js,html,txt
# If the mime type is in the list returned, it will be redetected without content which may produce a different result
# DEFAULT: none
# content.mimeMagic.ignorecontent.mimetypes=text/html,text/plain
# SAK-29389 Added quirks mode to html wrapping options (no doctype)
# DEFAULT: <!DOCTYPE html>
#content.html.doctype=<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">
# #######################################################################
# CLOUD-CONTENT
# #######################################################################
# SAK-30325 Largest blob size in bytes that will be processed in the JVM memory
# Any blob larger than this size will be written to a temp file.
# Hopefully, your blobs are being delivered directly to the user via a direct link
# but Sakai sometimes still needs the blob directly (e.g., Assignments ZIP download)
# DEFAULT: 104857600
# cloud.content.maxblobstream.size=52429600
# SAK-30325 Where should the temp blob files be written
# DEFAULT will use java temp dir
# cloud.content.temporary.directory=/big/partition/with/space
# SAK-30325 Should we send headers X-Accel-Redirect and X-Sendfile so the load balancer can proxy the file
# This accomplishes the goal of making your loadbalancer handle large file proxying instead of the JVM.
# DEFAULT false
# cloud.content.sendfile=true
# SAK-30325 Should we redirect the user directly to the file asset instead of proxying the asset in Sakai's JVM?
# DEFAULT true if using a valid FileSystemHandler that supports direct url links (ignored for default file system handler)
# cloud.content.directurl=false
# ########################################################################
# DIGEST
# ########################################################################
# Set to true to skip email digests when doing debug work
# DEFAULT: false
# digest.email.bypass.for.debug=true
# This is how long (in seconds) the digest service will wait between checking to see if there
# are digests that need to be sent (they are always only sent once per day)
# DEFAULT: 3600
# email.digest.check.period=3600
# This is how long (in seconds) the digest service will wait after starting up
# before it does the first check for sending out digests, default=300
# DEFAULT: 300
# email.digest.start.delay=300
# ########################################################################
# LOCALE
# ########################################################################
## Supported language locales for user preferences (and other areas in the code).
# Current supported set: en_US, ja_JP, zh_CN, es_ES, fr_FR, ca_ES, sv_SE, pt_BR, eu, tr_TR, mn, hi_IN, fa_IR
# Current legacy set: en_GB, ko_KR, nl_NL, zh_TW, fr_CA, ar, ru_RU, pt_PT, vi_VN, es_MX, pl_PL, de_DE, it_IT
# NOTE FOR i18n TEAM: please update kernel/component-manager/src/main/java/org/sakaiproject/component/locales/SakaiLocales.java#SAKAI_LOCALES_DEFAULT string array if you add more supported locales
# Legacy language packs: To install any legacy language pack visit https://github.com/sakaicontrib/legacy-language-packs
# DEFAULT: the full supported set (will always be at LEAST include the default Locale for the server)
# locales = en_US, en_GB, en_AU, en_NZ
# Extra locales to add on to the list of locales (usually only enabled for debugging), Default: "" (empty string)
# locales.more = en_US_DEBUG
## Set this to control the font used in site participants and other PDF exports (like Samigo)
# https://jira.sakaiproject.org/browse/SAK-21909
# DEFAULT: the system default font (probably helvetica)
# pdf.default.font=Helvetica
# Set locales with RTL orientation
# DEFAULT: ar,dv,fa,ha,he,iw,ji,ps,ur,yi
# locales.rtl =
# ########################################################################
# SKINS
# ########################################################################
# The default skin for sites without a skin setting
# DEFAULT: morpheus-default
# skin.default=morpheus-default
# the path to the skin files
# DEFAULT: /library/skin
# skin.repo=/library/skin
# Disable list of appearance/icon with "edit site information" for course sites.
# Set to true to display only default appearance.
# Default: false (enabled)
# disable.course.site.skin.selection=true
# Disable list of appearance/icon with "edit site information" for non-course sites.
# Default: true (disabled).
# disable.noncourse.site.skin.selection=false
# ########################################################################
# PORTAL
# ########################################################################
# Specifies the templates to be used for the portal.
# SAK-29113 'morpheus' is the default for 11+
# DEFAULT: morpheus
# portal.templates=morpheus
# This property controls when to bypasss the portal inlining process based on the URL.
# Often this is the file suffix - but other patterns can be used.
# This is a regular expression with vertical bars to indicate "or"
# DEFAULT: \\.jpg$|\\.gif$|\\.js$|\\.png$|\\.jpeg$|\\.prf$|\\.css$|\\.zip$|\\.pdf\\.mov$|\\.json$|\\.jsonp$\\.xml$|\\.ajax$|\\.xls$|\\.xlsx$|\\.doc$|\\.docx$|uvbview$|linktracker$|hideshowcolumns$
# portal.bypass=
# To specify a different regular expression than the overall default for a particular Sakai tool,
# use a property with this pattern:
# portal.bypass.[toolid]=
# This property controls when to bypasss the portal inlining process based on the query parameters
# This is a regular expression with vertical bars to indicate "or"
# DEFAULT: wicket:interface=.*iresourcelistener:|wicket:ajax=true
# portal.bypass.query=
# When true - it runs Tidy in noisy mode. It does *not* take the output of Tidy, just checks the portlet output and then uses it unchanged.
# DEFAULT: false
# portal.portlet.tidy.warnings=true
# DEPRECATED: no longer in use. see SAK-22335
# portal.portlet.tidy=false
## The tool ids for the tools that end up in the top bar and slide out drawer
# The ID of the tool to use - set to 'none' to suppress the top bar linking behavior
# DEFAULT: sakai.sitesetup
# portal.worksitetool=sakai.sitesetup
# ID of the tool to use for the calendar - set to 'none' to suppress the top bar linking behavior
# DEFAULT: sakai.schedule
#portal.calendartool=sakai.schedule
# ID of the tool to use for preferences - set to 'none' to suppress the top bar linking behavior
# DEFAULT: sakai.preferences
# portal.preferencestool=sakai.preferences
# ID of the tool to use for user profiles - set to 'none' to suppress the top bar linking behavior
# DEFAULT: sakai.profile2
# portal.profiletool=sakai.profile2
# The minimum number of tabs that must be present before search is shown in the portal
# DEFAULT: 2
# portal.show.search.when=
# How many tools to show in portal pull downs
# DEFAULT: 10
# portal.tool.menu.max=
# Whether or not to attempt to generate a custom stylesheet based on the user preferences.
# DEFAULT: false
# portal.stylable=true
# Whether or not to attempt to generate javascript to support a custom stylesheet based on the user preferences.
# DEFAULT: false
# portal.styleable.contentSummary
# Enable/disable portal chat feature in the portal: always / never / true / false
# If true or false, portal chat may be overwritten by the site property value "portal.neochat" (true or false)
# DEFAULT: never
# portal.neochat=true
# Lookup page aliases. May cause performance issues when enabled. See SAK-15002
# DEFAULT: false
# portal.use.page.aliases=true
# Lookup site aliases. May cause performance issues when enabled. See SAK-15002
# DEFAULT: false
# portal.use.site.aliases=true
# To turn on clustering for portal chat, set this to the same value on all of your app servers. A
# uuid makes a good choice. Setting this enables the jGroups based chat message stack synchronisation
# mechanism.
# If you run a cluster and you don't set this value, chat messages *will not be replicated* across
# the nodes and receivers on differing servers to senders *will not get their messages*.
# NOTE: You must have multicast enabled on the network hosting your cluster. JGroups does
# unicast, but I've not looked into that yet.
# DEFAULT: none (null)
# portalchat.cluster.channel=
# Controls whether or not an individual user's profile image will appear in the portal chat
# DEFAULT: true
# portal.neoavatar=false
# Specifies the amount of time, in milliseconds, between latestData requests sent by the javascript client.
# DEFAULT: 5000
# portal.chat.pollInterval=5000
# Set this to false and the site users section will NOT be shown, for privacy purposes.
# DEFAULT: true
# portal.chat.showSiteUsers=false
# Set this to true and video calling will be enabled on portal chat.
# DEFAULT: true
# portal.chat.video=false
# A list of nat traversal servers to try during portal chat video calling.
# DEFAULT: stun:stun.l.google.com:19302
# portal.chat.video.servers={list of ice servers}
# The timeout, in seconds, for operations like waiting for a call to be answered.
# DEFAULT: 25
# portal.chat.video.timeout=50
# Set this to true and portal chat will be disabled for a user UNLESS portal.chat.permitted is set
# in their MyWorkspace site.
# DEFAULT: false
# portal.chat.securedByUser=true
# If set to true enables direct urls to access deep content inside a tool.
# DEFAULT: true
# charon.directurl=false
# This setting determines if the portal will reset state at each navigation operation.
# DEFAULT: false
# portal.experimental.auto.reset=true
# Controls the use of iframes in the portal. It is a colon-separated list
# of common tool ids like sakai.assignment
# If the string contains the text ":all:", then by default all iframes
# will be suppressed, and only the tools whose ids are listed will
# be displayed with iframes.
# DEFAULT: :all:sakai.gradebook.gwt.rpc:com.rsmart.certification:sakai.delegatedaccess:sakai.rsf.evaluation:kaltura.media:kaltura.my.media
# portal.iframesuppress=
# Whether or not to maximize the display when only one site is available.
# DEFAULT: false
# portal.experimental.maximizesinglepage=true
# Prefix of the handler to use.
# DEFAULT: site
# portal.handler.default=site
# Whether or not to include subsites in the portal. If set to never, subsites will never be included.
# If set to false, subsites may be included depending on the site preferences.
# If set to any other value, subsites will always be included.
# DEFAULT= none (null) = always include
# portal.includesubsites=never
# DEFAULT: - (a dash)
# portal.mutable.pagename=
# DEFAULT: - (a dash)
# portal.mutable.sitename=
# If set to "stealth", portlet support will be stealthed. Otherwise, portlets will be available in myworkspace, project, and course worksite types.
# DEFAULT: none (null)
# portlet.support=stealth
# Display the help icon
# DEFAULT: true
# display.help.icon=false
# Display the help menu
# DEFAULT: true
# display.help.menu=false
# Neo Portal - Display the current user login information
# DEFAULT: true
# display.userlogin.info=false
# Enable/disable presence display in the portal: always / never / true / false
# If true or false, site presence display may be overwritten by the site property value "display-users-present" (true or false)
# DEFAULT: true
# display.users.present=false
# SAK-19129 Use the old method of displaying presence in an iframe with courier
# DEFAULT: false
# display.users.present.iframe=true
# Enable/disable presence display in myworkspace (true|false)
# DEFAULT: false
# display.users.present.myworkspace=true
# Delay to wait before doing first presence check
# DEFAULT: 3000 (milliseconds)
# display.users.present.time.delay=3000
# Show the my workspace to users (if it is not shown the user is taken to the first course they have access to instead)
# DEFAULT: true
# myworkspace.show=false
# When visiting a site that is joinable and the current user isn't joined, should they be given the option to join?
# DEFAULT: true
# portal.redirectJoin=false
# Allow admin site changes
# DEFAULT: false
# eb.membership.admin.site.changes.allowed=true
# Put the application in portlet JSR-168 testmode
# DEFAULT: null (false)
# portal.allow.test168=true
# Property to disable setting the HttpOnly attribute on the cookie (if false)
# DEFAULT: true (enabled)
# sakai.cookieHttpOnly=false
# Property to disable or alter the SameSite attribute on the cookie. Set to empty to disable.
# DEFAULT: lax
# sakai.cookieSameSite=strict
# The classname of the Java SAX parser to use
# DEFAULT: com.sun.org.apache.xerces.internal.parsers.SAXParser
# sakai.xml.sax.parser=
# Allows disabling of the Profile2 tool in Neo-portal
# DEFAULT: true
# portal.use.profile=false
# Allows for adding additional code into the header of both the standard and pda portals,
# for example for adding in kaltura or other javascript code
# DEFAULT: Empty, no value
# portal.include.extrahead=<script type="text/javascript" language="JavaScript" src="/kaltura/javascript/kaltura-display.js"></script>
# Allows for setting the cdn path for static portal content
# DEFAULT: Empty
# portal.cdn.path=http://nightly2.sakaiproject.org
# Allows for setting a version for static portal content
# DEFAULT: uses a git SHA from the build
# portal.cdn.version=c3cc2a0
# Allows for setting an expire param in addition to the version for static portal content
# if you wish to only use an expire param you can set version to some constant
# DEFAULT: 0
# portal.cdn.expire=0
# Allows forcing the 'Overview' tool to the top of tool list LHS menu system wide.
# See SAK-32386.
# DEFAULT: false
# portal.forceOverviewToTop=true
# SAK-32296 - Set default tabs to show
# DEFAULT:
# portal.default.tabs=15
# SAK-32532 - Change the default for auto favorite feature true/false
# DEFAULT: true
# portal.autofavorite=false
# SAK-32690 Enable a link in the LHS tool menu to add more tools, it redirects the user to the tool manage helper.
# The legacy property was "portal.experimental.addmoretools", this property is also supported.
# DEFAULT: false
# portal.addmoretools.enable = true
# ########################################################################
# SECURITY
# ########################################################################
# Force all URLs out of Sakai back to Sakai to be secure, i.e. to use HTTPS, on this port.
# Do not enable if you plan to respond with the same transport as the request.
# Otherwise, the URLs will reflect the attributes of the request URL. (443 | 8443 | or any other port)
# DEFAULT: no secure port or protocol (https) will be used, setting this to 0 will have the same effect as not setting it
# force.url.secure=443
# Force browser to download rather than render inline any file served from content hosting with a content-type of text/html.
# DEFAULT: true
# content.html.forcedownload=false
# Whether or not to append a target=_blank if there is no target attribute on anchor tags
# DEFAULT: true
# content.cleaner.add.blank.target=false
# Configure the value of the "rel" attribute of anchor tags when using target="_blank"
# See KNL-1524
# DEFAULT: noopener
# content.cleaner.referrer-policy=noopener noreferrer
# Force the user of a lower security profile for content processing and scanning,
# if this is not overridden then high security settings are used.
# The standard high and low files are located in "kernel/sakai-kernel-impl/src/main/resources/antisamy/"
# Override the standard files by placing your own files in:
# ${sakai.home}/antisamy/high-security-policy.xml
# ${sakai.home}/antisamy/low-security-policy.xml
# DEFAULT: false (use high security - no unsafe embeds or objects)
#content.cleaner.default.low.security=true
# KNL-1075: allow Sakai to behave more like other LMSes and silently clean the user-entered HTML,
# valid options are listed below:
# - none - errors are completely ignored and not even stored at all
# - logged - errors are output in the logs only
# - return - errors are returned to the tool (legacy behavior)
# - notify - user notified about errors using a non-blocking JS popup
# - display - errors are displayed to the user using the new and fancy JS popup
# Default: notify
#content.cleaner.errors.handling=return
# Force the logging of errors despite the handling setting
# (useful for debugging but can get very noisy)
# Default: false (still it could be logged if content.cleaner.errors.handling=logged above)
#content.cleaner.errors.logged=true
# KNL-1431
# MySQL by default can only store mb3 UTF-8 characters. In future versions we'll have a conversion and be able to store utf8mb4, however this will
# also require increasing the size of the indexes.
# It's recommended that if you're running MySQL that you leave this true for now or else you will encounter errors
# Oracle users can set this to true as Oracle UTF-8 characters already support 4 byte values
# Default: true (will limit the characters printed as UTF8)
#content.cleaner.filter.utf8=false
# KNL-1431
# If you'd like to replace them with something (like for instance a ?) add this here
# Default: Nothing (just remove)
#content.cleaner.filter.utf8.replacement=?
# Certain institutions consider Sakai error messages as overly verbose, revealing technical information that is not relevant to the user (e.g., stack traces, SQL error messages, etc.).
# You can limit such disclosures by setting portal.error.showdetail to false.
# DEFAULT: false
# portal.error.showdetail=true
# Filter properties when performing a site export
# To exclude properties with the string 'secret' or 'password' in the resulting site.xml file.
# DEFAULT: password|secret
# archive.toolproperties.excludefilter=password|secret
# To turn this filter off and export all properties, use:
# archive.toolproperties.excludefilter=none
# To replace the filter with your own regex, use this setting. It replaces the default regex,
# so if you want to filter properties matching 'password' or 'secret', you must include them
# in the replacement regex.
# archive.toolproperties.excludefilter=launch|release|secret
# SAK-12489 enable/disable reCAPTCHA
# To configure, signup at http://www.google.com/recaptcha, get the API keys, add them to the properties below and set recaptcha.enabled=true.
# DEFAULT: false (disabled)
# user.recaptcha.enabled=true
# user.recaptcha.public-key=yourAcsiiPublicKey
# user.recaptcha.private-key=yourAcsiiPrivateKey
## Limit account creation types by user type (SAK-18509 - security)
# registration types - Comma-separated list of account types permitted for an anonymous session to create.
# DEFAULT: registered (equivalent to a new user registering on the gateway site)
# user.registrationTypes=registered
# non-admin types - Comma-separated list of account types permitted for a non-admin user to create.
# DEFAULT: guest (equivalent to a user adding a guest user through Site Info / Add Participants)
# user.nonAdminTypes="guest"
# Control user password policy (KNL-1123)
# Enable the user password policy handling, must be true to enable the password policy
# Other "user.password" settings have no effect if this is false
# Default: false
#user.password.policy=true
# Controls the name of the password policy provider class, changing this will make the settings below meaningless
# Default: org.sakaiproject.user.api.PasswordPolicyProvider
#user.password.policy.provider.name=name.of.the.spring.bean
# default PasswordPolicyProvider: Controls the entropy settings for the password policy check
# Defaults: as shown below (minimum.entropy=16, medium.entropy=32, high.entropy=48)
#user.password.minimum.entropy=16
#user.password.medium.entropy=32
#user.password.high.entropy=48
# default PasswordPolicyProvider: Controls the maximum length of sequence of characters from the user EID that is allowed for the password
# Default: 3
#user.password.maximum.sequence.length=3
# SAK-29182
# Defines a customizable, paramaterized user facing message in the event that the New Account tool
# is being forced use the email address of the user as their EID (SAK-28184), and the user attempts to use an
# email with a domain restricted via invalidEmailInIdAccountString sakai.property.
# NOTE: You can utilize the two parameters {0} and {1} as often as necessary. {0} will be replaced with the contents
# of the sakai.property ui.institution. {1} will be replaced with the offending email domain string.
# Default: You have entered an email address ending with "{1}", which is restricted. Please try again with a different email address.
# user.email.invalid.domain.message=You have entered a {0} email address ending with "{1}". Please log in with your existing {0} account.
# ########################################################################
# LOGGING
# ########################################################################
## Control the logging level by class packages
# DEFAULT: INFO level
# Example 1:
# log.config.count=2
# log.config.1=DEBUG.org.sakaiproject.content
# log.config.2=DEBUG.org.sakaiproject.event.impl
# ALTERNATELY: use a comma seperate list of the debug levels desired
# log.config=DEBUG.org.sakaiproject.content.*,DEBUG.org.sakaiproject.event.impl.*
## Override the logging configuration file
# Default: kernel/kernel-common/src/main/config/log4j.properties
# Place a new logging configuration file (for log4j it would be log4j.properties) in your sakai home
# ########################################################################
# REST (EB - EntityBroker)
# ########################################################################
## Speed up REST lookup of Users (SAK-21654)
# Set this to true to disable friendly id/eid failover checks
# (this means lookups will only attempt to use id or eid as per the exact params which are passed or as per the endpoint API)
# In other words, the user ID must be prefixed with "id=", otherwise it will be treated like an EID
# DEFAULT: false
# user.explicit.id.only=true
# The maximum depth of object graph which can be transcoded into JSON. (Online documentation incorrectly notes possible values as 1-7)
# An integer between 4 and 26. Anything below 5 is set at 5, anything above 25 is set to 25.
# DEFAULT: 7
# entitybroker.maxJSONLevel=5
# Enable/disable direct batch servlet
# DEFAULT: false
# entitybroker.batch.enable=true
# Configure what services are allowed to be registered with entity broker. Comma separated list of prefixes (SAK-27902)
# Do not be too restrictive with this list as you might disable functionality required by Sakai
# DEFAULT: everything
# entitybroker.allowed.services=prefix1,prefix2
# ########################################################################
# CACHE
# ########################################################################
# Forcibly disable statistics collection for caches
# This can improve performance slightly but makes it impossible to monitor cache status
# DEFAULT: false
# memory.cache.statistics.force.disabled=true
# Register the EhCaches with JMX server
# If true then the EhCache will be registered with the JMX agent to make it easier to monitor the
# cache statistics.
# DEFAULT: true
# memory.ehcache.jmx=true
# Set event interval at which to report the current status of the site cache
# DEFAULT: 0
# org.sakaiproject.site.impl.SiteCacheImpl.cache.cacheEventReportInterval=0
## NOTE: all caches can be configured like so:
# memory.{cachename}={key=value,key=value,...}
# The main keys are eternal, timeToLiveSeconds, timeToIdleSeconds, maxElementsInMemory
# See the admin memory tool for a complete list of caches in your environment
# cache list may include but is not limited to:
#org.hibernate.cache.StandardQueryCache
#org.hibernate.cache.UpdateTimestampsCache
#org.sakaiproject.alias.api.AliasService.callCache
#org.sakaiproject.api.privacy.PrivacyManager.PrivacyQueryCache.queryGetPrivacy
#org.sakaiproject.authz.api.SecurityService.cache
#org.sakaiproject.authz.impl.DbAuthzGroupService.realmRoleGroupCache
#org.sakaiproject.calendar.impl.BaseExternalCacheSubscriptionService.institutional
#org.sakaiproject.calendar.impl.BaseExternalCacheSubscriptionService.user
#org.sakaiproject.citation.api.SearchManager.metasearchSessionManagerCache
#org.sakaiproject.citation.api.SearchManager.sessionContextCache
#org.sakaiproject.db.BaseDbFlatStorage.SAKAI_ALIAS_PROPERTY
#org.sakaiproject.db.BaseDbFlatStorage.SAKAI_REALM_PROPERTY
#org.sakaiproject.db.BaseDbFlatStorage.SAKAI_SITE_GROUP_PROPERTY
#org.sakaiproject.db.BaseDbFlatStorage.SAKAI_SITE_PAGE_PROPERTY
#org.sakaiproject.db.BaseDbFlatStorage.SAKAI_SITE_PROPERTY
#org.sakaiproject.db.BaseDbFlatStorage.SAKAI_USER_PROPERTY
#org.sakaiproject.event.api.ActivityService.userActivityCache
#org.sakaiproject.event.api.NotificationService.cache
#org.sakaiproject.event.api.UsageSessionService.recentUserRefresh
#org.sakaiproject.lessonbuildertool.service.AssignmentEntity.cache
#org.sakaiproject.lessonbuildertool.service.BltiEntity.cache
#org.sakaiproject.lessonbuildertool.service.LessonBuilderAccessService.cache
#org.sakaiproject.lessonbuildertool.service.SamigoEntity.cache
#org.sakaiproject.lessonbuildertool.tool.producers.ShowPageProducer.url.cache
#org.sakaiproject.news.api.NewsService.cache
#org.sakaiproject.profile2.cache.connections
#org.sakaiproject.profile2.cache.kudos
#org.sakaiproject.profile2.cache.preferences
#org.sakaiproject.profile2.cache.privacy
#org.sakaiproject.profile2.cache.search
#org.sakaiproject.shortenedurl.cache
#org.sakaiproject.site.api.SiteService.userSiteCache
#org.sakaiproject.site.impl.SiteCacheImpl.cache
#org.sakaiproject.sitestats.api.PrefsData
#org.sakaiproject.sitestats.api.report.ReportDef
#org.sakaiproject.sitestats.impl.event.EntityBrokerEventRegistry
#org.sakaiproject.sitestats.impl.event.EventRegistryServiceImpl
#org.sakaiproject.springframework.orm.hibernate.L2Cache
#org.sakaiproject.time.impl.BasicTimeService.userTimezoneCache
#org.sakaiproject.user.api.AuthenticationManager
#org.sakaiproject.user.api.UserDirectoryService
#org.sakaiproject.user.api.UserDirectoryService.callCache
#org.sakaiproject.user.impl.BasePreferencesService.preferences
#uk.ac.cam.caret.sakai.rwiki.service.api.radeox.RenderCache
# User cache - ehcache default overrides (params = timeToLiveSeconds, timeToIdleSeconds, maxElementsInMemory)
# NOTE: The defaults here are NOT safe for production, you will want to increase this to match your user base and server power
# 24 hours - 86400, 12 hours - 43200, 1 hour - 3600
# memory.org.sakaiproject.user.api.UserDirectoryService.callCache=timeToLiveSeconds=3600,timeToIdleSeconds=900,maxElementsInMemory=20000
# KNL-600 authz realms grants caching (true|false)
# cacheName: org.sakaiproject.authz.impl.DbAuthzGroupService.realmRoleGroupCache
# DEFAULT: true (caching on)
# DEPRECATED: authz.cacheGrants=true *** see KNL-1325 ***
# KNL-1325
# realmRoleGroupCache introduced in KNL-600 is now always on as using sakai without this cache would not be ideal
# time in seconds a refresh is allowed to take before rate limiting begins
# rate limits refreshing when refreshing is taking to long, this is useful in a sakai system with many nodes
# where excessive refreshing can cause the database to slow down.
# DEFAULT: 15
# authzgroup.refresh.max.time = 15
# time in seconds between consecutive refreshs,
# regardless of how long processing the queue takes this interval is guaranteed between executions.
# DEFAULT: 60
# authzgroup.refresh.interval = 60
# KNL-800 provider id should synchronize with parent site on manually updated member roles
# DEFAULT: false
# EXPERIMENTAL: before setting please read issues KNL-1250 and KNL-1270
# authz.synchWithContainingRealm=true
# AUTHZ cache - Minutes to cache each security question in the SecurityService; set to 0 to disable caching.
# DEPRECATED: cacheMinutes@org.sakaiproject.authz.api.SecurityService=3
# the deprecated setting has no effect anymore (since before 2.5)
# memory.org.sakaiproject.authz.api.SecurityService.cache=timeToLiveSeconds=300,timeToIdleSeconds=300,maxElementsInMemory=10000
# SITE cache - Minutes to cache each site (site, page, tool) access in the SiteService; set to 0 to disable caching.
# DEPRECATED: cacheMinutes@org.sakaiproject.site.api.SiteService=3
# the deprecated setting has no effect anymore (since before 2.5)
# memory.org.sakaiproject.site.impl.SiteCacheImpl.cache=timeToLiveSeconds=300,timeToIdleSeconds=300,maxElementsInMemory=10000
## Users Pre-caching
## Controls the users precaching process on the Sakai servers,
## The goal is to make it easier to access large sites because users are generally fetched on demand
## IF you are storing all users in your local database and do not have a UserDirectoryProvider configured and enabled,
## then there is no reason to enable this
## By default the user precaching is completely disabled
## NOTE: User cache is called: org.sakaiproject.user.api.UserDirectoryService.callCache
## You will need to increase the timeToLive/Idle to at least 24 hours for that cache or the
## precaching is useless (see the "User cache" above)
# Enable the precache on server startup
# **NOTE: this will run on each server within 5-15 mins of the server starting up
# DEFAULT: false
# precache.users.run.startup=true
# Enable the daily refresh of the users cache
# DEFAULT: false
# precache.users.run.daily=true
# Control the time (24 hour clock - current server timezone)) of the daily refresh
# DEFAULT: 04:00
# precache.users.refresh.time=04:00
# Control the query used to find the list of all user IDs to preload into the cache
# DEFAULT: SELECT distinct(USER_ID) FROM SAKAI_SITE_USER where PERMISSION = 1 order by USER_ID
# precache.users.userlist.query=
## User Precache logging
## Control additional logging of the precaching process (Defaults: SHOWN BELOW)
# precache.users.log.usersRemoved=false
# precache.users.log.usersNotRemoved=false
# precache.users.log.usersAccessed=false
# precache.users.log.usersNotAccessed=true
# JLDAP cache - ehcache default overrides (only meaningful if using the JLDAP provider)
# edu.amc.sakai.user.JLDAPDirectoryProvider.userCache=timeToLiveSeconds=14400,timeToIdleSeconds=3600,maxElementsInMemory=20000
# Cache authentication to improve DAV performance for provided users.
# A maximumSize of 0 disables the cache. The cache is disabled by default.
# maxElementsInMemory@memory.org.sakaiproject.user.impl.AuthenticationCache=500
# Cache timeout for successful login-password combos.
# Cache timeout for failed login-password combos. (same timeout for success)
# timeToLive@memory.org.sakaiproject.user.impl.AuthenticationCache=120000
# Suppress the refresh of the sakai realm tables with the latest information from CM tables
# DEFAULT: false (do not surpress)
# suppressCMRefresh=true
# CLUSTER CACHING (KNL-1184)
# WARNING: this requires an external distributed caching server
# Enable distributed caching
# DEFAULT: false
#memory.cluster.enabled=true
# The URLs of the distributed cache servers
#memory.cluster.server.urls.count=2
#memory.cluster.server.urls.1={CACHE_SERVER_URL_1}:9510
#memory.cluster.server.urls.2={CACHE_SERVER_URL_2}:9511
## The caches that will be using the distributed cache.
## The only ones known to be safe are listed:
## EVENTS clustering: org.sakaiproject.event.impl.ClusterEventTracking.eventsCache, org.sakaiproject.event.impl.ClusterEventTracking.eventLastCache
## (events caching shown below as example)
## Events caching uses a distributed cache to propagate events, rather than reading from the database, events are still stored in the database
## SESSION failover: org.sakaiproject.tool.impl.RebuildBreakdownService.cache
## PERFORMANCE: org.sakaiproject.authz.impl.DbAuthzGroupService.realmRoleGroupCache
#memory.cluster.names.count=2
#memory.cluster.names.1=org.sakaiproject.event.impl.ClusterEventTracking.eventsCache
#memory.cluster.names.2=org.sakaiproject.event.impl.ClusterEventTracking.eventLastCache
## Any Cache properties below that are not set will use the default values
# Valid properties include: maxEntries(int>0), timeToIdle(int>0, seconds), timeToLive(int>0, seconds), eternal(true|false)
# Defaults: maxEntries=10000, timeToIdle=600, timeToLive=600, eternal=false
# Configure cluster caches using: memory.cluster.{cacheName}.{property)={value}
# Events caching properties
#memory.cluster.org.sakaiproject.event.impl.ClusterEventTracking.eventsCache.maxEntries=80000
#memory.cluster.org.sakaiproject.event.impl.ClusterEventTracking.eventsCache.timeToIdle=60
#memory.cluster.org.sakaiproject.event.impl.ClusterEventTracking.eventsCache.timeToLive=60
# eventLastCache caching properties (only needs to ever store 1 entry but we need it forever)
#memory.cluster.org.sakaiproject.event.impl.ClusterEventTracking.eventLastCache.maxEntries=1
#memory.cluster.org.sakaiproject.event.impl.ClusterEventTracking.eventLastCache.eternal=true
# Session replication caching properties
#memory.cluster.org.sakaiproject.tool.impl.RebuildBreakdownService.cache.maxEntries=50000
#memory.cluster.org.sakaiproject.tool.impl.RebuildBreakdownService.cache.timeToIdle=3600
#memory.cluster.org.sakaiproject.tool.impl.RebuildBreakdownService.cache.timeToLive=10800
# Role and Group caching properties
#memory.cluster.org.sakaiproject.authz.impl.DbAuthzGroupService.realmRoleGroupCache.maxEntries=100000
#memory.cluster.org.sakaiproject.authz.impl.DbAuthzGroupService.realmRoleGroupCache.timeToIdle=2000
#memory.cluster.org.sakaiproject.authz.impl.DbAuthzGroupService.realmRoleGroupCache.timeToLive=2400
# ########################################################################
# SESSION MANAGEMENT
# ########################################################################
# Sessions expire if nothing happens in this many seconds (1 hour)
# DEFAULT: 1800 (seconds = 1/2 hour)
# inactiveInterval@org.sakaiproject.tool.api.SessionManager=3600
# Presence expires if not refreshed in this many seconds
# DEFAULT: 60 seconds
# timeoutSeconds@org.sakaiproject.presence.api.PresenceService=120
# Resolve client hostnames on login (stored in SAKAI_SESSION).
# DEFAULT: false.
# session.resolvehostname=true
## Session timeout dialog popup configuration
# DEFAULT: true
# timeoutDialogEnabled=true
# DEFAULT: 600
# timeoutDialogWarningSeconds=600
# Allow passing a session id in the ATTR_SESSION request parameter
# DEFAULT: false
# session.parameter.allow=true
# Whether to monitor the SAKAI_SESSIONS table size. If true, warnings will be posted in the log when performance may degrade due
# to large table size
# DEFAULT: true
# sessions.size.check=false
# Limits the maximum number of session on a per user basis
# If a user exceeds this number of sessions then the oldest ones will be expired
# when a new one is established until the total is at the max again
# DEFAULT: 0 (no limit)
# session.max.per.user=100
## Session Replication settings
## WARNING: This requires a distribution mechanism of some kind (currently requires a distributed cache)
## NOTES:
## cache: org.sakaiproject.tool.impl.RebuildBreakdownService.cache must be set to a distributed cache (see memory.cluster)
## cache: org.sakaiproject.tool.impl.RebuildBreakdownService.stash should be configured to last as long
## as your user might need to navigate to JSF or other on-demand session tools after landing on a new server
# Enable session cluster replication (see notes above)
# Default: false
#session.cluster.replication=true
## Performance tuning settings below - be careful with these numbers as adjusting them downward can create heavy load
# Tuning setting, minimum seconds old the session must be before it will be replicated
# Default: 20
#session.cluster.minSecsOldToStore=20
# Tuning setting, minimum seconds that must pass before session data is updated (since last store)
# NOTE: certain events will cause the session data to be updated in the store regardless of this setting
# Default: 10
#session.cluster.minSecsBetweenStores=10
# Tuning setting, minimum seconds after a session has been rebuilt from the store before it can be updated in the storage again
# Default: 30
#session.cluster.minSecsAfterRebuild=30
# When a node is in shutdown should we redirect to another working node?
# When a node is in shutdown and this is true we pick another node in the cluster and redirect to that node by setting
# the cookie to point to that node, when this is false we just delete the cookie and let the load balancer decide
# Default: true
# cluster.redirect.random.node=false
# ########################################################################
# SERVLET CONTAINER
# ########################################################################
# Specify servlet container. Tomcat is assumed to be default so leave commented out.
# DEFAULT: none (null) - code only responds if this is set to "websphere"
# servlet.container=websphere
# JSF Saving State Method
# By default Sakai is using "client" as SAVING_STATE_METHOD in JSF tools
# You can change this value to "server" in all jsf tools with default or in selected ones
# jsf.state_saving_method=server
# jsf.state_saving_method.{servlet-name}=server
# Example: jsf.state_saving_method.sakai.samigo=server
# Example: jsf.state_saving_method.sakai.summary.calendar=server
# ########################################################################
# EMAIL
# ########################################################################
## INCOMING EMAIL
# Flag to enable or disable SMTP service for incoming email (true | false)
# DEFAULT: false.
# smtp.enabled=true
# SMTP port on which incoming SMTP service listens.
# Recommend running on 8025, and using a standard mailer on 25 to forward mail to Sakai.
# Default=25.
# smtp.port=8025
# Email support address used in incoming email rejection messages.
# DEFAULT: none (null)
# mail.support=
# Email support actual name used for email rejection messages
# DEFAULT: none (null)
# mail.support.name=
## OUTGOING EMAIL
# SMTP server for outgoing emails.
# smtp@org.sakaiproject.email.api.EmailService=some.smtp.org
# SMTP port to connect to outgoing SMTP Server
# DEFAULT: 25
# smtpPort@org.sakaiproject.email.api.EmailService=25
# UserName to connect to SMTP server (Optional)
# smtpUser@org.sakaiproject.email.api.EmailService=<SMTP_USER>
# Password for connection to SMTP server (Optional)
# smtpPassword@org.sakaiproject.email.api.EmailService=<SMTP_PASSWORD>
# Use SSL/TLS to connect to the SMPT server
# DEFAULT: false
# smtpUseSSL@org.sakaiproject.email.api.EmailService=false
# Run in test mode - email will be written to the log rather than sent
# NOTE: this will work even if no other settings have been set
# DEFAULT: false
# testMode@org.sakaiproject.email.api.EmailService=true
# Show additional debugging information in the logs when email is being processed (sent or received)
# Mostly should only use this if there are problems with the email processing and you are debugging.
# DEFAULT: false
# smtpDebug@org.sakaiproject.email.api.EmailService=true
# Set the default from address for the Sakai email service
# DEFAULT: postmaster@serverName
# smtpFrom@org.sakaiproject.email.api.EmailService=<SMTP_FROM>
# Email address to send errors caught by the portal, and user bug reports in response.
# DEFAULT: none (null)
# portal.error.email=
# Email address used as the "from" address for any email sent by any Sakai tool.
# If the value is not set, the tools will use no-reply@${serverName} or postmaster@${serverName}
# DEFAULT: none (null)
# setup.request=
# Comma-separated list of domain names that are not allowed in guest accounts
# This property is useful for preventing the accidental creation of guest accounts
# for users (based on email address) that already have an external account (based on
# username). For instance, if this property is set to umich.edu, then a user
# trying to add knoop@umich.edu to a site will receive an error, as there is an
# expectation that a "knoop" user should already exist.
# Example: umich.edu
# DEFAULT: null (all domains are valid)
# invalidEmailInIdAccountString=
# Email notifications reply FROM preference
# Set this to true to send notifications from the triggering user email addresses for announcements
# instead of from a general server email address (no-reply@...)
# OLD (deprecated) config value: emailFromReplyable@org.sakaiproject.event.api.NotificationService
# DEFAULT: false (use the no-reply@... instead)
# notify.email.from.replyable = true
# Email notifications reply TO preference
# Set this to true to send notifications with the to field set to a user email instead of a general server email address
# OLD (deprecated) config value: emailToReplyable@org.sakaiproject.event.api.NotificationService
# DEFAULT: false (use the server address instead of the user)
# notify.email.to.replyable = true
# DEFAULT: postmaster
# mail.prohibitedaliases.count=1
# mail.prohibitedaliases.1=postmaster
# ALTERNATELY: a list of comma separated list of aliases
# mail.prohibitedaliases=postmaster, adminuser
# Connection timeout for SMTP server. Not set by default
# DEFAULT: none (null)
# mail.smtp.connectiontimeout=
# Timeout for SMTP server. Not set by default
# DEFAULT: none (null)
# mail.smtp.timeout=
# Replacing From addresses in email
# Major mail providers are starting to use DMARC, to demand that all mail From addresses from their domain
# must be signed. Since we can't sign messages for another mail service, this means that email passed through
# the archiver or generated by Mailtool / Messages will fail the test, and be rejected.
# By default we now replace From addresses with postmaster@site, and move the original From address to
# Reply-To. These properties control that behavior.
#
# Should we replace the From address? true|false
# Can also be an email address. If not specified the new from address is postmaster@site.
# Example: mailagent@sakai.myinstitution.edu
# false if you don't want any replacement
# DEFAULT: true
#mail.sendfromsakai=false
# Should we have exceptions for the replacement? Any from address matching this Java regular expression
# will be retained unmodified. You might want to include addresses within your own institution, since
# they shouldn't cause any trouble unless your own institution is using DMAEC.
# Note that mail addresses using your Sakai instance's server name will always be exceptions
# DEFAULT: missing, no exceptions
#mail.sendfromsakai.exceptions=.*[@.]institution\\.edu
# When replacing the From address, what text should we use. {} will be
# replaced with the original From address, e.g. John Smith (jsmith@site.edu)
# DEFAULT: {}
#mail.sendfromsakai.fromtext=On behalf of {}
# KNL-1469: some tools like Forums will include user-attached PDFs in the outgoing email
# Sakai needs to strip large attachments because SMTP servers will reject large attachments
# Default is 25MB because that is current max accepted by Yahoo/Outlook365/Gmail
#mail.sendfromsakai.maxsize=25000000
# The number of messages above which searching is disabled
# DEFAULT: 2500
# sakai.mailbox.search-threshold=
# DEFAULT: true
# mail.*.sendpartial=false
# ########################################################################
# WEB SERVICES
# ########################################################################
# Indicates whether or not we allow SOAP web-service logins.
# Enable this enable SOAP webservices
# DEFAULT: false - so folks are forced to add this in their local properties file.
# webservices.allowlogin=true
# Indicates the shared secret between the Sakai JSR-168 Portlet and this instance of Sakai
# This is commented out so folks are forced to add this in their local properties file
# DEFAULT: none
# webservice.portalsecret=plugh-xyzzy
# Indicates what hostnames and IP addresses are allowed to connect to the SOAP web services. This must be secured properly.
# See: https://confluence.sakaiproject.org/display/WEBSVCS/How+to+use+the+Sakai+Web+Services
# webservices.allow=.*
# webservices.allowlogin=
# webservices.deny=
# webservices.log-allowed=
# webservices.log-denied=
# A comma separated list of requests that should be allowed, regardless of the other access rules. Anything added here
# will OVERRIDE the other rules.
#
# webservices.allow-request=/sakai-ws/rest/something,/sakai-ws/soap/somethingelse
# SAK-29943 - Lock down the report service
# The report service allows running arbitrary SQL queries, it is diabled by default. Even when enabled you need a super user session to run reports.
# DEFAULT: false
# webservice.report.enabled=true
# ########################################################################
# COURSE MANAGEMENT
# ########################################################################
# Set the default implementation of the Course Management API.
# DEFAULT: org.sakaiproject.coursemanagement.impl.CourseManagementServiceFederatedImpl
# org.sakaiproject.coursemanagement.api.CourseManagementService=org.sakaiproject.coursemanagement.impl.CourseManagementServiceFederatedImpl
# DEFAULT: true
# site-manage.courseManagementSystemImplemented=false
# site-manage.cms.subject.label=Department
# site-manage.cms.subject.category=DEPT
# Enable alias for new sites
# DEFAULT: false
# site-manage.enable.alias.new=true
# Enable editing alias for existing sites
# DEFAULT: false
# site-manage.enable.alias.edit=false
#### SAK-23257: Restrict site maintainer from adding or elevating users to certain roles.
#### For example, prevent the Instructor of a course site from adding new Instructor users
# DEFAULT: empty (no restricted roles)
# You can narrow the restriction to a specific type of site by appending .sitetype
# sitemanage.addParticipants.restrictedRoles=CustomRole
# sitemanage.addParticipants.restrictedRoles.course=Instructor
# sitemanage.addParticipants.restrictedRoles.project=maintain
#### SAK-21707: Sort dropdowns in Worksite Setup
# For each worksitesetup.sort.key property that is specified, the associated worksitesetup.sort.order property must also be specified
# The following are all comma separated values. If these properties are not present, the drop-downs will be sorted as they were sorted before (on eid, then title).
# The key on which the sessions are sorted. Possible values are: authority, description, eid, endDate, startDate, title
# worksitesetup.sort.key.session=
# The key on which the courseSets are sorted. Possible values are: authority, category, description, eid, parent, title
# worksitesetup.sort.key.courseSet=
# The key on which the courseOfferings are sorted. Possible values are: academicSession, authority, canonicalCourseEid, courseSetEids, description, eid, endDate, startDate, status, title
# worksitesetup.sort.key.courseOffering=
# The key on which the sections are sorted. Possible values are: authority, category, courseOfferingEid, description, eid, enrollmentSet, maxSize, meetings, parent, title
# worksitesetup.sort.key.section=
## The following are all comma separated lists of sorting orders that correspond to the above keys. They have values of 'asc' or 'desc' for ascending/descending
# The order on which the sessions are sorted
# worksitesetup.sort.order.session=
# The order on which the courseSets are sorted
# worksitesetup.sort.order.courseSet=
# The order on which the courseOfferings are sorted
# worksitesetup.sort.order.courseOfferings=
# The order on which the sections are sorted
# worksitesetup.sort.order.section=
#### End SAK-21707
# SAK-41287 Control the default selection of "Site Visibility" when creating new sites
# Only applies to site types which are able to have this setting changed, and not restricted to either
# always being private, or always being public. For context, see "site.types.publicChangeable",
# "site.types.publicOnly", and "site.types.privateOnly" sakai.properties
# DEFAULT: true ("public")
# wsetup.defaultSiteVisibility=false
# SAK-23256 - Whether or not to filter the dropdown in Worksite Setup to just terms that the instructor has sites in
# This is only relevant if you are using the CM_MEMBERSHIP tables and the internal course management
# Admin will still see the full list
# DEFAULT: false (Uses the IS_CURRENT on the CM_ACADEMIC_SESSION_T still)
#worksitesetup.filtertermdropdowns=true
# SAK-27809 Disabling of page order feature on page order helper
# DEFAULT: true
# site-manage.pageorder.allowreorder=false
# SAK-28990 Disable 'Continue with no roster' button during course site creation
# DEFAULT: true
# sitemanage.continueWithNoRoster=false
# SAK-16842 Skip the course/section selection step in Worksite Setup
# DEFAULT: false
# wsetup.skipCourseSectionSelection=true
# SAK-21706 Skip manual course site creation process in Worksite Setup
# DEFAULT: false
# wsetup.skipManualCourseCreation=true
# SAK-22437 Add Welcome (site description) to site import options list
# DEFAULT: true
# site-manage.importoption.siteinfo=false
# SAK-41286 Control display of roster EIDs in Worksite Setup > New Course Site &
# Site Info > Edit Class Roster(s)
# DEFAULT: false
# wsetup.showRosterEIDs=true
# ########################################################################
# GROUP PROVIDER (defined in kernel.properties)
# ########################################################################
# ########################################################################
# ROLES
# ########################################################################
# A comma seperated list that defines a set of roles that can one switch between and still retain a "student view."
# It is highly recommended that you DO NOT add roles to this list that are used for site adminstration.
# DEFAULT: Student,Teaching Assistant,access
# studentview.roles=Student,Teaching Assistant,access
# ########################################################################
# CONFIGURATION
# ########################################################################
# Cause the configuration service to dump the entire set of configuration items to the logs after loading
# DEFAULT: false
#config.dump.to.log=true
# Control the marking of certain configuration values as secured (secure values are not output in the logs)
# DEFAULT: (comma separate string): password@javax.sql.BaseDataSource
#config.secured.key.names=key1,key2
# Control the dereferencing of configuration values on initial load
# (values are always dereferenced but this affects whether they are done on config load or not)
# Dereferencing values means that all values like "${property.name}" are replaced
# with the value from the config item of that name (unmatched ones are left as is)
# DEFAULT: true (dereference all values loaded from the config properties files)
#config.dereference.on.load.initial=false
# DEFAULT: false (do not dereference all values including those loaded from other sources - e.g. database)
#config.dereference.on.load.all=true
## Database configuration storage handling options (KNL-1063)
## These options control the way the database can be used as a source for the Sakai configuration
## NOTES:
## Will never store (persist) "password@org.jasypt.encryption.pbe.PBEStringEncryptor"
## the use of a raw property like "${sakai.home}/db/body" can be useful at times instead of the dereferenced value
# Enable the database check for configuration items,
# also registers default handler with SCS as a provider of config items
#sakai.config.provide.enable=true
# Enables the database poller to check for new or changed config items at runtime (otherwise only check on system start)
# Default: false
#sakai.config.poll.enable=true
# How often to poll the DB for config items
# Default: 60 (once every 60 seconds)
#sakai.config.poll.seconds=30
# Indicate config items that should never be persisted
# Default: passwords
#sakai.config.never.persist=blah,something,another.one
# Enables persistence of ConfigItems that SCS knows about
# (controls whether or not to store all properties that it learns from SCS in to the DB on system start)
# Default: false
#sakai.config.store.enable=true
# Store raw instead of dereferenced values (see explanation for config.dereference.on.load.initial above)
# Default: true
#sakai.config.use.raw = false
# ########################################################################
# LRS (TinCanAPI / Experience API)
# ########################################################################
# Enable LRS processing
# Default: false
# lrs.enabled=true
# Enable statement origin filters (cause certain statements to be skipped based on their origin)
# NOTE: most origins are the names of the tools. e.g. assignments, announcement, calendar, chat, content, gradebook, lessonbuilder, news, podcast, syllabus, webcontent, rwiki
# Default: No filters (all statements processed)
# lrs.origins.filter=tool1,tool2,tool3
# ########################################################################
# TOOLS (tool specific settings)
# ########################################################################
# STEALTH TOOLS
# A stealth tool is a tool that is running in Sakai but is not available to be added to a site in Worksite Setup.
# List any tools to be stealthed, using their tool ids, in a comma-separated string (no spaces).
# In this example, the rwiki tool, su tool, roster tool, and the assignment tool w/o grading are stealthed:
# stealthTools@org.sakaiproject.tool.api.ActiveToolManager=sakai.rwiki,sakai.su,sakai.site.roster,sakai.assignment
# DEFAULT: none (No tools are stealthed)
# stealthTools@org.sakaiproject.tool.api.ActiveToolManager=sakai.rwiki
# The list of tool IDs to hide from the "Edit Tools" menu.
# List any tools to be hidden, using their tool ids, in a comma-separated string (no spaces).
# This option and the stealthTools@org.sakaiproject.tool.api.ActiveToolManager together make up the entire list of tools that
# will not appear. You might use this if you wished to preserve the default settings for stealthTools but add a few additional tools to the list.
# DEFAULT: none (no tools are hidden)
# hiddenTools@org.sakaiproject.tool.api.ActiveToolManager=
## Override/Append Sakai Tool categories
# NOTE: categories are also set in the sakai tool xml files in each tool
# Standard categories: project, course, myworkspace, sakai.admin
# Normally, if you want to add a new category (site type) to a tool, you have to change the /tools/toolid.xml file.
# This config option adds 2 ways to adjust the categories. The first is to append new categories to any
# already defined for the tool. The second is to override any categories set for the tool with a new set.
## (1) Append the categories to the existing set of categories (has no effect if it is blank)
# Example: tool.categories.append.sakai.announcements=course
# DEFAULT: use the categories defined in the tool xml file
# tool.categories.append.{toolid}=category1,category2,category3
## (2) Override the current tool categories with a new set of categories (removes all categories if it is blank)
# Example: tool.categories.sakai.announcements=course,project
# DEFAULT: use the categories defined in the tool xml file
# tool.categories.{toolid}=category1,category2,category3
# Controls whether when importing / duplicating a site to have them be as draft
# Applies to announcements, assignments, and messages
# msgcntr has own property of msgcntr.forums.import.importAsDraft
# DEFAULT: true
# import.importAsDraft=false
# GRADEBOOK 1
# Controls the display of the number of decimal points for the class average.
# In Gradebook Items -> {click on an item}.
# DEFAULT: The default is 0 decimal places and truncation of the score occurs, not rounding.
#gradebook.class.average.decimal.places=0
# Controls the display of the "Total Points" column on the overview screen.
# DEFAULT: false (Total Points column is not shown)
#gradebook.display.total.points=false
# SAK-22205 - Gradebook custom export format
# Controls which columns are included by default in the export format
# DEFAULT: usereid,sortname,coursegrade
# gradebook.standard.export.default.fields=usereid,sortname,coursegrade,calculatedgrade,gradeoverride,finalscore,lastmodifieddate
# SAK-22204 - Gradebok Course Grade Export
# Controls whether or not instructors can change which columns are sent
# In gradebook export
# DEFAULT: false
# gradebook.institutional.export.enabled=true
# SAK-18588 - Allow students to see total number of points in gradebook
# Default: false
# gradebook.showCoursePoints
# SAK-20370 - Show total points in all grades view for instructor
# Default: false
# gradebook.roster.showCourseGradePoints=true
# SAK-27973 Allow for changing default values for displaying course grade/points
# Default for course points being display (you need the option above for showCoursePoints
# Default: false
# gradebook.coursepoints.displayed=true
# Default for course grade displayed
# Default: false
# gradebook.coursegrade.displayed=true
# Default for assignments displayed
# Default: true
# gradebook.assignments.displayed=false
# Default for assignment stats displayed
# Default: true
# gradebook.stats.assignments.displayed=false
# Default for course grade stats displayed
# Default: true
# gradebook.stats.coursegrade.displayed=false
# Show the option to grade with letter grade (converted to points)
# Default: false
# gradebook_enable_letter_grade=true
# SAK-33833: show the 'Grade Entry' panel in 'Settings' to non-admin users.
# Default: true
# gradebook.settings.gradeEntry.showToNonAdmins=false
# SAK-15311: Gradebook Classic - set default student view to sort by 'sort order'
# Default: false
# gradebook.students.use.sorting=true
# SAK-33836: control the maximum character length of gradebook item comments.
# NOTE: this property is not enforced in Gradebook Classic.
# Default: 20,000
# gradebookng.maxCommentLength=500
# SAK-41209: control visibility of the 'Set Zero Score for Empty Cells' menu option
# DEFAULT: true (visibile)
# gradebookng.showSetZeroScore=false
# SAK-41222: control the ability for users to enable displaying course grades to students.
# DEFAULT: true
# gradebookng.showDisplayCourseGradeToStudent=false
# SAK-41200: Show the section column
# DEFAULT: true
# gradebookng.showSections=false
# SAK-41380: Set the sections column width
# DEFAULT: 140
# gradebookng.sectionsColumnWidth=100
# SAK-41380: Set the student number column width
# DEFAULT: 140
# gradebookng.studentNumberColumnWidth=100
# SAK-41590: Turn on gradebook column resizing
# DEFAULT: false
# gradebookng.allowColumnResizing=true
# ASSIGNMENT 1
# Allows an instructor or any user with assignments management permissions to submit the assignment on behalf of a student
# who has no submission yet (via the View Assignment list by student)
# DEFAULT: true (enabled)
# assignments.instructor.submit.for.student=true
# Allow configuration of assignment dates
# assignment.visibledate = <seconds offset from now default 0>
# assignment.opendate = <seconds offset from now default 0>
# assignment.duedate = <seconds offset from now default 604800>
# assignment.acceptuntildate = <seconds offset from now, default 691200>
# assignment.peerevaluationdate = <seconds offset from now, default 1296000>
# Allows assignments to support group submission of an assignment (for groups or sections)
# Any individual in the group may make submissions/changes and all members of the group are emailed notifications on submissions.
# All behaviors on individual submissions can be applied to Group Submissions such as Grading,
# Resubmissions, Grade Release, Downloads, Uploads, etc. One grade is designated for the entire Group and
# all individuals receive this grade in the Gradebook. Overrides for a single user grade is supported.
# https://jira.sakaiproject.org/browse/SAK-22282
# DEFAULT: true (enabled)
# assignment.group.submission.enabled=true
# Enable visible date feature. When enabled, student can see assignment but can not submit/save yet.
# This feature is driven by a need for us to show students upcoming tasks but not allow them to act on them until the open date.
# DEFAULT: false (disabled)
# assignment.visible.date.enabled=true
# The system setting for whether to show the Option tool link or not (true|false)
# DEFAULT: true (enabled)
# assignment.enableViewOption=true
# Enable a content review service (true|false). Enabling this is only one part of the check - the review service has to be available and enabled for each site as well.
# DEFAULT: false (disabled)
# assignment.useContentReview=false
# Comma separated list of possible letter grades to use
# DEFAULT: A+,A,A-,B+,B,B-,C+,C,C-,D+,D,D-,E,F
# assignment.letterGradeOptions=
## SAK-23812 Peer Review feature for Assignments
# set to true to use peer assessment in the Assignments tool
#assignment.usePeerAssessment=true
# Enable the download all flat folder structure option (SAK-19147), allows instructor to download assignments without folders in the zip
# Default: false
#assignment.download.flat=true
# Enable anonymous grading for assignments (default is false)
# assignment.anon.grading.enabled=false
# Remove members with one of the following permissions from the submitter list
# Default: asn.new
# assignment.submitter.remove.permission=asn.new,asn.delete
# SAK-7920 Configure a honor pledge that differs from the default
# Default: Honor Pledge: I have neither given nor received aid on this assignment.
# assignment.honor.pledge=Honor Pledge: My own custom honor pledge.
# SAK-33971 Filter assignments by group in the Assignments List
# DEFAULT: false (disabled)
# Set to true to show the filter in the Assignments List view
# assignment.group.filter.enabled=true
# SAK-40544 Number of hours before due date to remind users to submit an assignment
# DEFAULT: 24
# assignment.reminder.hours=24
# SAK-29210 Show official photo from student when an instructor grading an assignment
# Default: false
# assignment.show.official.photo=true
# ######################################
# 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-41821 Student confirmation page
# ######################################
# Custom text shown for students on the confirmation screen, loaded by default from properties but it can be overriden here
# assignment.submissionConfirmMessage=You are about to submit this submission for grading. Please check that the following items have been completed before submitting.
# If set to true, submissionConfirmOptions items will have to be checked to submit
# DEFAULT: false - submissionConfirmOptions items will appear as a bullet list
# assignment.submissionConfirmOptionsRequired=true
# assignment.submissionConfirmOptions.count=2
# assignment.submissionConfirmOptions.1=By submitting this submission, you are acknowledging that you have read and agree the plagiarism policies of the course.
# assignment.submissionConfirmOptions.2=Other test message
# If set to any value, no calendar will ever be returned/used by the calendar service
# DEFAULT: none (null) - will try to reference the calendar for the context
# calendar=
# Default value for "Submit papers to the following repository"
# DEFAULT: 0 (note, online documentation incorrectly says 1)
# turnitin.repository.setting.value=
# List of settings
# DEAFULT: none (null)
# turnitin.repository.setting.count=2
# turnitin.repository.setting.1=0
# turnitin.repository.setting.2=1
# ALTERNATELY use the comma separated list of values
# turnitin.repository.setting=0,1
# DEFAULT: 0
# turnitin.report_gen_speed.setting.value
# Allows you to customize the list of report generation options when creating an assignment.
# 0=Immediately
# 1=Immediately and At Due Date
# 2=At Due Date
# turnitin.report_gen_speed.setting.count=3
# turnitin.report_gen_speed.setting.1=0
# turnitin.report_gen_speed.setting.2=1
# turnitin.report_gen_speed.setting.3=2
# Option appears in GUI to check paper against Turnitin.
# DEFAULT: true
# turnitin.option.s_paper_check=false
# Option appears in GUI to check paper against Internet (web search).
# DEFAULT: true
# turnitin.option.internet_check=false
# Option appears in GUI to check paper against Journals.
# DEFAULT: true
# turnitin.option.journal_check=false
# Option appears in GUI to check paper against Institutional repository.
# DEFAULT: true
# turnitin.option.institution_check=false
# The default checkmark in the Turnitin option in the GUI.
# DEFAULT: false
# turnitin.option.s_paper_check.default=true
# The default checkmark in the Internet (web search) option in the GUI.
# DEFAULT: false
# turnitin.option.internet_check.default=true
# The default checkmark in the Journal option in the GUI.
# DEFAULT: false
# turnitin.option.journal_check.default=true
# The default check mark in the Institutional repository option in the GUI.
# DEFAULT: false
# turnitin.option.institution_check.default=true
# Shows or hides the store in institutional index option
# Default: true
# contentreview.option.store_inst_index=true
# The default check mark in the Store in Institutional Index option in the GUI
# Default: true
# contentreview.option.store_inst_index.default=true
# Shows or hides the exclude self plagiarism option
# Default: true
# contentreview.option.exclude_self_plag=true
# The default check mark in the Exclude Self Plagiarism option in the GUI
# Default: true
# contentreview.option.exclude_self_plag.default=true
# Shows or hides the report when it is preliminary / non-final
# Default: true
# contentreview.config.show_preliminary_score=false
# Show student preview option, to view report of draft submission, in the GUI
# Default: false
# contentreview.option.student_preview=true
# The default check mark in the Show student preview option in the GUI
# Default: false
# contentreview.option.student_preview.default=true
# Determines if error messages directly from the content review service will be exposed to end users
# If false, a generic message is displayed instead
# Default: true
# contentreview.expose.errors.to.ui=false
# SAK-31923
# Sets the separation char on exporting to
# Default: ,
# csv.separator=;
## ANNOUNCEMENTS
# Allow reordering of Announcements using Fluid drag-and-drop reordering component
# DEFAULT: true
# sakai.announcement.reorder=false
# Set to 0 (or any non-null, no-"1" value) if it is okay to show the merge button in the menu.
# DEFAULT: 1 (do not show).
# announcement.merge.display=1
# Then false allow announcements from merged sites to be shown when current user isn't a member of the merged site.
# DEFAULT: false
# announcement.merge.visibility.strict=true
# The ID of the announcement channel to use instead of the site channel
# DEFAULT: none (null)
# channel=
# List of site types to disable public announcements to
# DEFAULT: none (null)
# prevent.public.announcements.count=1
# prevent.public.announcements.1=project
# prevent.public.announcements.2=portfolio
# ALTERNATELY, use the comma seperated list form
# prevent.public.announcements=project,portfolio
# Decide whether to use the site title or the short description in the subject when notifying an announcement by email.
# DEFAULT: false
# announcement.email.use.short.description=true
# SAK-39992 - make announcement email notifications 'To' address match 'From' address
# DEFAULT: false
# announcement.notification.email.to.matches.from=true
## BASICLTI PROVIDER
# blti.producer prefix no longer used, should be basiclti.provider
# Enable the Provider
# **NOTE This setting was "imsblti.producer.enabled" in versions prior to 2.9.x
# DEFAULT: false
# basiclti.provider.enabled=true
# BasicLTI Provider-enabled tools
# Colon separated list of tool ids
# DEFAULT: none
# basiclti.provider.allowedtools=sakai.announcements:sakai.singleuser:sakai.assignment.grades:blogger:sakai.dropbox:sakai.mailbox:sakai.forums:sakai.gradebook.tool:sakai.podcasts:sakai.poll:sakai.resources:sakai.schedule:sakai.samigo:sakai.rwiki
# BasicLTI Provider secret - you must provide a password
# DEFAULT: none (null)
# basiclti.provider.[hostname].secret=
# Colon separated list of trusted consumers - permit clean pass through of site/user credentials for the list of trusted consumers,
# e.g., basiclti.provider.highly.trusted.consumers=lmsng.school.edu:another.school.edu.
# DEFAULT: none (null)
# basiclti.provider.highly.trusted.consumers=
#Colon separated list of trusted email consumers - will allow the Sakai as LTI provider to optionally 'trust' the consumer and lookup the userid
#based on the consumer provided user email address.
#e.g., basiclti.provider.email.trusted.consumers=lmsng.school.edu:another.school.edu.
#DEFAULT: none (null)
# basiclti.provider.email.trusted.consumers=
#Creates a site of mentioned type
#e.g., basiclti.provider.newsitetype=project
#basiclti.provider.newsitetype=
#default role mapping for the sakai provider site when could not find matching role from consumer
# e.g., lti.role.mapping.Student=Member
#lti.role.mapping.Student=
# e.g.,lti.role.mapping.Instructor=Owner
#lti.role.mapping.Instructor=
# Use to override the URL to the launch presentation CSS file
# DEFAULT: none (null) - results in "[SERVER_URL]/library/skin/default/tool.css" being used
# basiclti.consumer.launch_presentation_css_url=
# DEFAULT: none (null) - results in "[SERVER_URL]/imsblis/service/return-url" being used
# basiclti.consumer_return_url=
# Set to "true" to enable. Any other value or missing will keep this from being enabled. This allows the launch to specify a URL that contains some resource content.
# **NOTE: Experimental Feature 2.8.0
# DEFAULT: none (null).
# basiclti.contentlink.enabled=
# Set to "true" to enable. Any other value or missing will keep this from being enabled.
# Additionally, there must be a gradebook tool on the site in order for this to enable.
# DEFAULT: none (null).
# basiclti.outcomes.enabled=
# Allows an external tool (if granted proper permissions) to retrieve a course roster for the course that they were launched from.
# This allows the launch to specify a URL that contains some resource content.
# **NOTE: Experimental Feature 2.8.0
# DEFAULT: true. Set to "false" to disable.
# basiclti.roster.enabled=
# Enable the pulling of rosters from LTI consumers. Users are created in Sakai
# and added to the provisioned site.
# DEFAULT: false. Set to "true" to enable.
# basiclti.incoming.roster.enabled=true
# DEFAULT: true. Set to "false" to disable.
# basiclti.settings.enabled=
## BASICLTI Organizational information
# DEFAULT: none (null)
# basiclti.consumer_instance_contact_email=
# DEFAULT: none (null)
# basiclti.consumer_instance_description=
# DEFAULT: serverName
# basiclti.consumer_instance_guid=lmsng.school.edu
# DEFAULT: none (null)
# basiclti.consumer_instance_name=
# DEFAULT: none (null)
# basiclti.consumer_instance_url=
# LMS-wide key, e.g., basiclti.consumer_instance_key.imsglobal.org=lmsng.school.edu
# DEFAULT: none (null)
# basiclti.consumer_instance_key.[hostname]
# LMS-wide secret, e.g., basiclti.consumer_instance_secret.imsglobal.org=secret
# DEFAULT: none (null)
# basiclti.consumer_instance_secret.[hostname]
# IMS LTI 1.3 includes a concept called deployment_id for servers that serve multiple tennants
# from the same URL or for SASS based servers that use a single PKI key pair
# for signing across all of their hosted instances (like Canvas or Blackboard). At this point
# Sakai supports neither of these use cases but if in the future, we could have one server with
# multiple truly distinct tenants (and different sakai.properties) this field would be useful.
# When set to anything other than "1", it is added to the "issuer" and "subject" strings in
# all things LTI OAuth 2.0. For now leave it alone - it defaults to "1" to align
# with other self-hosted environments like Moodle.
# DEFAULT: "1"
# lti13.deployment_id=1
# Name of the site property to display in the table.
# DEFAULT: Department
# basiclti.tool.site.attribution.key=Division
# Title for the column header for the attribution column, can be a text or a translation key
# DEFAULT: content.attribution
# basiclti.tool.site.attribution.name=content.attribution
# Show the LTI 2.0 user interface - deprecated in Sakai-19
# DEFAULT: false
# basiclti.lti2.show=
# Suppress portlet form field with supplied launch end-point URL.
# DEFAULT: none (null)
# sakai.testlti.launch=
# Suppress portlet form field with supplied key.
# DEFAULT: none (null)
# sakai.testlti.key=
# Suppress portlet form field with supplied secret.
# DEFAULT: none (null)
# sakai.testlti.secret=
# Allow maintainers to add new LTI tools to system.
# DEFAULT true
# lti:allow_maintainer_add_system_tool=false
# Allow maintainers to add LTI tools to the site (outside manage tools).
# DEFAULT true
# lti:allow_maintainer_add_tool_site=false
## CALENDAR SUMMARY
# View (week or month)
# DEFAULT: month
# calendarSummary.viewMode=month
# Calendar day background color (as hexadecimal value).
# DEFAULT: background-color in tool CSS (.calDayWithActivity) for all priorities.
# calendarSummary.highPriorityColor=#FF0000
# calendarSummary.mediumPriorityColor=#00FF00
# calendarSummary.lowPriorityColor=#0000FF
# Define priorities for calendar events.
# DEFAULT: all events not listed in highPriorityEvents or mediumPriorityEvents default to the low list (no need to define).
# Note: no need to specify all events, neither all priorities (high, medium, low).
# calendarSummary.highPriorityEvents.count=2
# calendarSummary.highPriorityEvents.1=Deadline
# calendarSummary.highPriorityEvents.2=Exam
# ALTERNATELY, define calendarSummary.highPriorityEvents as a comma separated list of values to use
# calendarSummary.highPriorityEvents=Deadline,Exam
# calendarSummary.mediumPriorityEvents.count=1
# calendarSummary.mediumPriorityEvents.1=Web Assignment
# ALTERNATELY, define calendarSummary.mediumPriorityEvents as a comma separated list of values to use
# calendarSummary.highPriorityEvents=Web Assignment
# All calendar events not specified in high and medium priority lists are treated as low priority and added to anything defined here.
# Because of this, there is no need to specify low priority events.
# calendarSummary.lowPriorityEvents.count=1
# calendarSummary.lowPriorityEvents.1=Activity
## iCAL
# Allows iCal/ics subscriptions to calendar via impossible-to-guess (opaque) url. Introduced in SAK-21497
#--- SAK-31413 : new property added ical.public.secureurl.subscribe to replace ical.opaqueurl.subscribe. Both will be supported. ical.public.secureurl.subscribe has priority.
# DEFAULT: true
# ical.public.secureurl.subscribe=false
# Enable iCal import/export via instructor-named ICS file.
# DEFAULT: true
# ical.public.userdefined.subscribe=true
# This is legacy: recommend using ical.public.userdefined.subscribe instead
# ical.experimental=true
## CONDITIONAL RELEASE
# Enable conditional release
# DEFAULT: false.
# conditions.service.enabled=true
## CALENDAR TOOL
# DEFAULT: week (options: day|week|month|year|list)
# calendar.default.view=week
# EXTERNAL CALENDAR SUBSCRIPTION
# Enable External iCal Subscriptions
# DEFAULT: true
# calendar.external.subscriptions.enable=false
# Merge External iCal Subscriptions from other sites into Home?
# DEFAULT: false
# calendar.external.subscriptions.mergeIntoMyworkspace = true
# Determine whether to show users the merge calendar option. Users additionaly still must have rights to edit/merge the calendar.
# DEFAULT: 1 - any value other than 1 will hide the merge option to users
# calendar.merge.display=1
# 1. Institutional iCal Subscriptions: URL (optional)
# calendar.external.subscriptions.url.count=2
# calendar.external.subscriptions.url.1=file:///servicos/sakai-home/trunk/ical-ufp.ics
# calendar.external.subscriptions.url.2=http://localhost:8080/access/calendar/ical/outro_site.ics
# 2. Institutional iCal Subscriptions: NAME (optional)
# This is optional and will assign a name to the subscription urls above (default is the url)
# calendar.external.subscriptions.name.count=2
# calendar.external.subscriptions.name.1=Calend\u00e1rio Acad\u00e9mico UFP
# calendar.external.subscriptions.name.2=Home de nuno2
# 3. Institutional iCal Subscriptions: EVENT TYPES (optional)
# This is optional and will force events to have a specified type (default is Activity)
# calendar.external.subscriptions.eventtype.count=2
# calendar.external.subscriptions.eventtype.1=Academic Calendar
# calendar.external.subscriptions.eventtype.2=Special event
# 4. Subscription cache settings (optional)
# Institutional subscription defaults: reload every 120min
# User subscriptions defaults: max 32 subscriptions in memory, reload every 120min
# calendar.external.subscriptions.institutional.cacheentries=32
# calendar.external.subscriptions.institutional.cachetime=120
# calendar.external.subscriptions.user.cacheentries=32
# calendar.external.subscriptions.user.cachetime=120
# Determine the range for calendar export
# Number of months from the past required in the export
# DEFAULT: 6
# calendar.export.previous.months=6
# Number of months in the future required in the export
# DEFAULT: 12
# calendar.export.next.months=12
# SAK-21242 - Determine the number of hours to show in one page (default is 10).
# Second page (default) starts at 8:00 so 12 hours will show events until 20:00 and 14 hours until 22:00.
# Third page starts at 24-calendar.hoursPerPage
# Value is limited from 8 to 16 because this view is hardcoded to 3 pages.
# calendar.hoursPerPage=10
## HELP TOOL (helpPath defined in PATHS section above)
# Comma separated list of tools or categories whose help should not be added to the help index.
# DEFAULT: none
# help.hide=sakai.profile,OSP Guide
# External URL to direct help
# DEFAULT: none (null)
# help.location=
# Base URL to an external webapp handling help
# DEFAULT: none
# help.redirect.external.webapp=
# URL to external starting page for help. The application will try to adjust the URL to a localized page
# DEFAULT: none (null)
# help.welcomepage=
# SAK-32069 - Path in file system to index help documents
# The default is the tmpdir but if this is cleaned the help is wiped out
# DEFAULT: ${java.io.tmpdir} / sakai.help
# help.indexpath=${sakai.home}/helpindex
# Attribute for news tool (static) for Sakai 10 and earlier
# DEFAULT: none (set this if you want it to work)
# wsetup.config.tool.attribute_sakai.news=channel-url
# Title for Default RSS Feed (10-)
# DEFAULT: Sakai News
# wsetup.config.tool.title_sakai.news=Sakai News
# RSS feed to set for the default (10-)
# DEFAULT: https://www.sakailms.org/blog-feed.xml
# wsetup.config.tool.attribute.default_sakai.news=https://www.sakailms.org/blog-feed.xml
# Attribute for news tool (static) for Sakai 11 and later
# DEFAULT: none (set this if you want it to work)
# wsetup.config.tool.attribute_sakai.simple.rss=javax.portlet-feed_url
# Title for Default RSS Feed (11+)
# DEFAULT: Sakai News
# wsetup.config.tool.title_sakai.simple.rss=Sakai News
# RSS feed to set for the default (11+)
# DEFAULT: https://www.sakailms.org/blog-feed.xml
# wsetup.config.tool.attribute.default_sakai.simple.rss=https://www.sakailms.org/blog-feed.xml
## NEWS/LINK/WEB TOOLS
# Assumes all web content, news and link tool pages have custom titles and should not be localized when true (default)
# legacyPageTitleCustom=false
## WEB PORTLET (2.9.1+)
# How long should we cache the headers from an iframed web content page? Default is six hours (3600*1000*6)
# We check the page headers to see if they set an X-Frame-Options header that disallows iframing
# iframe.xframe.cachetime=21600000
# What is the timeout for checking the headers of the iframed page?
# Default is 8 seconds (in milliseconds)
# iframe.xframe.loadtime=8000
# Regular expressions to force a popup or force inlining and avoid any header checks.
# For example, if you never want Sakai to check Google headers and always force it to popup, you could add a regex for iframe.xframe.popup
# Default is null
# iframe.xframe.popup=
# iframe.xframe.inline=
## LINKTOOL
# When deploying in a clustered configuration, you will need to use the same key and salt on
# all app servers. To do this, specify a shared location which all app servers
# can read (and the first app server to start up can write to)
# DEFAULT: Sakai home path - e.g. = ServerConfigurationService.getSakaiHomePath()
# linktool.home=/data/sakai/config/
# This is the url to call back to the server. To be secure, this must be SSL, and your software must check the certificate.
# This is needed because PHP applications may talk to more than one Sakai implementation. When you get a call, you'll need to talk to
# web services on the specific Sakai server that called you. This URL is normally serverUrl in this file. However if necessary
# you can override it using this.
# DEFAULT: (uses the server url from property "serverUrl")
# sakai.rutgers.linktool.serverUrl=
# Expose a set of macros that the Web Content tool can use to customise the URL for each user.
# You should understand the security implications of this before enabling.
# Note that you can create custom macros that expose properties but they need to be specified in this list
# DEFAULT: ${USER_ID},${USER_EID},${USER_FIRST_NAME},${USER_LAST_NAME},${SITE_ID},${USER_ROLE}
# iframe.allowed.macros=${USER_ID},${USER_EID},${USER_FIRST_NAME},${USER_LAST_NAME},${SITE_ID},${USER_ROLE},${SITE_PROP:course-unique-id},${SITE_PROP:course-section-key}
# PAGE ORDER HELPER
# List of tool IDs that if present in a page prevent the page's title from being edited.
# Multiple tools should be separated by commas.
# DEFAULT: null
# poh.uneditables=sakai.siteinfo
# List of tool IDs that shouldn't be hideable through the page order helper too.
# Multiple tools are separated by commas.
# DEFAULT: null
# poh.unhideables=sakai.siteinfo
# Allow users to edit the titles of tools.
# DEFAULT: true
# org.sakaiproject.site.tool.helper.order.rsf.PageListProducer.allowTitleEdit=false
# Allow users to hide tools in Page Order Helper.
# DEFAULT: true
# poh.allow.hide=false
# Allow users to lock tools in Page Order Helper.
# DEFAULT: true
# poh.allow.lock=false
# SAK-32127
# If making the Resources tool Hidden, subsequently make the Resources root content "Hidden but Accessible"
# Default changed in SAK-40270
# DEFAULT: true
# poh.resources.content.sync.visibility = true
## PODCAST
# Configurable toolId for Resources tool check
# DEFAULT: sakai.resources
# podcasts.toolid=sakai.resources
# PORTFOLIO (OSP)
# A map of the default permissions for the OSP presentation tool. Each numbered instance of this variable should have a corresponding siteTypes and value option.
# For example, if presentation.permissions.map.1 is set, at a minimum:
# presentation.permissions.map.1.siteTypes
# presentation.permissions.map.1.value.count
# presentation.permissions.map.1.value.1
# must be set.
# Count of the number of items in the settings
# presentation.permissions.map.count=
# A list of site types (portfolio, course, project, etc.) for which the permission map defined in presentation.permissions.map should be used.
# presentation.permissions.map.1.siteTypes=
# A list of the permissions that should be assigned to the role specified in presentation.permissions.map.
# presentation.permissions.map.1.value.count=
# presentation.permissions.map.1.value.1=
# Whether or not to override or include the existing presentation layout permissions with those set in presentationLayout.permissions.map.
# If set to true, only the permissions set in presentationLayout.permissions.map will be set.
# If set to false, the permissions set in presentationLayout.permissions.map will be set in addition to any existing permissions.
# presentationLayout.permissions.override
# A map of the default permissions for the OSP presentation layout tool. Each numbered instance of this variable should have a corresponding siteTypes and value option.
# For example, if presentation.permissions.map.1 is set, at a minimum:
# presentationLayout.permissions.map.1.siteTypes
# presentationLayout.permissions.map.1.value.count
# presentationLayout.permissions.map.1.value.1
# must be set.
# Count of the number of items in the settings
# presentationLayout.permissions.map.count
# A list of site types (portfolio, course, project, etc.) for which the permission map should be used.
# presentationLayout.permissions.map.1.siteTypes
# A list of the permissions that should be assigned to the role specified in presentationLayout.permissions.map.
# presentationLayout.permissions.map.1.value.count=
# presentationLayout.permissions.map.1.value.1=
# A map of the default permissions for the OSP presentation template tool. Each numbered instance of this variable should have a corresponding siteTypes and value option.
# For example, if presentationTemplate.permissions.map.1 is set, at a minimum:
# presentationTemplate.permissions.map.1.siteTypes
# presentationTemplate.permissions.map.1.value.count
# presentationTemplate.permissions.map.1.value.1
# must be set.
# Count of the number of items in the settings
# presentationTemplate.permissions.map.count=
# A list of site types (portfolio, course, project, etc.) for which the permission map defined in presentation.permissions.map should be used.
# presentationTemplate.permissions.map.1.siteTypes=
# A list of the permissions that should be assigned to the role specified in presentation.permissions.map.
# presentationTemplate.permissions.map.1.value.count=
# presentationTemplate.permissions.map.1.value.1=
# Option to turn off having display names when zipping file
# DEFAULT: true
# dropbox.zip.haveDisplayname=false
## PREFERENCES TOOL
# Page order/visibility control. Controls the order pages appear in the Preferences tool,
# and whether a page appears at all. The property enable.privacy.status, which previously
# turned on the privacy status page in preferences is no longer used.
# The default if no value for preference.pages is set is Tab control prefs, Notification prefs,
# Timezone pref, Language pref (and privacy pref page is not shown as per the previous default).
# To show the privacy page, include pref_privacy_title in the preference_pages setting.
# To eliminate a page, explicity set preference.pages and leave the page value out.
# DEFAULT: prefs_noti_title, prefs_timezone_title, prefs_lang_title, prefs_hidden_title, prefs_editor_title
# preference.pages=prefs_noti_title, prefs_timezone_title, prefs_lang_title, prefs_privacy_title, prefs_hidden_title, prefs_editor_title
# Should research/collab specific preferences (no syllabus) be displayed?
# DEFAULT: false.
# prefs.research.collab=true
## PRESENCE
# Enables logging of presence events as expected for site stats. Does not enable the presence list.
# DEFAULT: true
# presence.events.log=false
# Define the icon for users present in chat - if this is undefined, no icon will be used
# DEFAULT: /library/icon/chat.gif
# presence.inchat.icon=/library/icon/chat.gif
#########################################
# PROFILE2
#########################################
# Enables a listener that looks for user.del events and when they happen remove that users profiles.
# DEFAULT: true
# profile.autoCleanUp=false
# Upload limit for profile pictures, in MB
# DEFAULT: 2
# profile2.picture.max=2
# Convert images from old profile to new?
# DEFAULT: false
# profile2.convert=true
# Allow users to post status updates to Twitter? (true/false)
# DEFAULT: true
# profile2.integration.twitter.enabled=true
# Source listed for Twitter status updates.
# DEFAULT: Profile2
# profile2.integration.twitter.source=
# Allow users to change their profile picture? (true/false)
# DEFAULT: true
# profile2.picture.change.enabled=true
# Can users upload an image or just link to an existing one? (upload/url/official)
# *NOTE: If using official, see below.
# DEFAULT: upload
# profile2.picture.type=upload
# Allow users to change their privacy settings? (true/false)
# DEFAULT: true
# profile2.privacy.change.enabled=true
# Override the default privacy settings with these options (0=everyone, 1=only connections, 2=only me)
# This will set the defaults for a person with no existing privacy record
# or when the privacy settings are locked (change.enabled=false)
# Key: 0=everyone, 1=only connections, 2=only me, 3=nobody
# DEFAULT: If not specified, all properties below default to the values shown below
# *NOTE: not all properties have the full range (0,1,2,3). Each is documented underneath the property itself.
# profile2.privacy.default.profileImage=0
# 0,1 only
# profile2.privacy.default.basicInfo=0
# 0,1,2
# profile2.privacy.default.contactInfo=0
# 0,1,2
# profile2.privacy.default.staffInfo=0
# 0,1,2
# profile2.privacy.default.studentInfo=0
# 0,1,2
# profile2.privacy.default.personalInfo=0
# 0,1,2
# profile2.privacy.default.birthYear=true
# true/false
# profile2.privacy.default.myFriends=0
# 0,1,2
# profile2.privacy.default.myStatus=0
# 0,1 only
# profile2.privacy.default.businessInfo=0
# 0,1 only
# profile2.privacy.default.myPictures=0
# 0,1 only
# profile2.privacy.default.messages=1
# 1,3 only
# profile2.privacy.default.myKudos=0
# 0,1 only
# profile2.privacy.default.socialInfo=0
# 0,1,2
# profile2.privacy.default.myWall=0
# 0,1 only
# profile2.privacy.default.onlineStatus=0
# 0,1 only
# List of userIds (not eids) that will never show in searches or friends lists (comma separated no spaces)
# DEFAULT: postmaster
# profile2.invisible.users=postmaster
# Set this to tell the ProfileManager to get it's data from Profile2.
# If left unset, any tools that use the ProfileManager from the original profile tool (ie Roster)
# will continue to use the data from org.sakaiproject.api.app.profile.LegacyProfileManager.
# So you must set this to enable the integrations.
# If you are using a version of Sakai prior to 2.7, you need to apply the patch attached to
# SAK-17573 in order for this property to have any effect.
# DEFAULT: org.sakaiproject.api.app.profile.LegacyProfileManager
# profile.manager.integration.bean=org.sakaiproject.profile2.legacy.ProfileManager
# Optional parameters if you have registered a Twitter application and want to use that as the registered application instead of Profile2.
# See the section on registering a Twitter application, as this is rather involved.
# profile2.twitter.oauth.key=
# profile2.twitter.oauth.secret=
# Profile2 provides a formatted entity via EntityBroker at /direct/profile/{userid}/formatted.
# However large amounts of data, particularly in the personal summary section of a user's profile, can make this view rather large.
# This property can restrict how much is shown.
# DEFAULT: 1000
# profile2.formatted.profile.summary.max=1000
# Sets the ability for a user to change their profile image on a per user type basis. (true/false)
# DEFAULT: if not set, defaults to the value of profile2.picture.change.enabled which defaults to true
# profile2.picture.change.USER_TYPE.enabled=true
# Official Image Support - to enable support for using official images, set to true
# DEFAULT: false
# profile2.official.image.enabled=false
# If enabled, where should Profile2 look for the officially provided images?
# If 'url', you need to add a URL for each user to the PROFILE_IMAGES_OFFICIAL_T table in the database.
# If 'provider', you need your UserDirectoryProvider implementation to add a BASE64 encoded image to a property
# on the User object. This is already in place for the LDAP provider, just setup the jpegPhoto attribute.
# See http://jira.sakaiproject.org/browse/SAK-17816.
# profile2.official.image.source=url
# If enabled and you set the source to 'provider' above you also need to specify the attribute, if different to this value.
# Used when profile2.official.image.source=provider is configured. Attributre should match the value your provider populates in the properties for a User.
# see SAK-17816
# DEFAULT: jpegPhoto
# profile2.official.image.attribute=jpegPhoto
# Note that if you want to use *only* officially provided images you also should set
# profile2.picture.type=official
# If you want to allow a user to choose either the official image or an uploaded/url one of their choice,
# do not set type=official and rather set profile2.picture.type=url/upload. They will then be able to choose
# to use either the official image, or one they select.
# Remember, you can always disable changes altogether via profile2.picture.change.enabled=false
# The maximum number of search results that should be returned per search
# DEFAULT: 50
# profile2.search.maxSearchResults=50
# The maximum number of search results per page
# DEFAULT: 25
# profile2.search.maxSearchResultsPerPage=25
# Import profile data from a CSV
# You can now import profile data from a CSV file. The CSV file must be located on the Sakai server.
# For the format of the CSV file, see
# https://jira.sakaiproject.org/browse/PRFL-684?focusedCommentId=140799&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-140799
# profile2.import=false (set to true to enable and also set the profile2.import.csv field)
# profile2.import.csv=/path/to/file/import.csv
# Gravatar Support
# Allow users to set gravatars as their images (true/false)
# DEFAULT: true
# profile2.gravatar.image.enabled=true
# Wall Support
# Enable/disable the Profile2 wall page globally (true/false)
#
# DEPRECATED: UNLESS THERE IS AN EXPRESSED DESIRE FOR THIS FUNCTIONALITY THE WALL WILL BE REMOVED FOR 13.
#
# DEFAULT: false
# profile2.wall.enabled=true
# Use the wall page as the default Profile2 page (true/false)
# DEFAULT: false
# profile2.wall.default=false
## Email notification of a profile change
# You can configure an email to be sent to a specific user whenever anyone updates their profile. (true/false)
# This defaults off and must be explicitly configured. The user gets a notification only, no actual profile content is sent.
# They still need to login to view the info and the same permissions are applied.
# Therefore it is recommended the eid property be set to a super user.
# DEFAULT: false
# profile2.profile.change.email.enabled=false
# profile2.profile.change.email.eid=admin
# Enable/disable the profile menu feature? (true/false)
# Disabling the menu, hides all the profile menu tabs
# This setting overrides the following properties:
# profile2.gallery.enabled
# profile2.connections.enabled
# profile2.messaging.enabled
# profile2.search.enabled
# profile2.privacy.enabled
# profile2.preference.enabled
# profile2.menu.enabled=true
# Enable/disable the gallery feature? (true/false)
# DEFAULT: true
# profile2.gallery.enabled=true
# Enable/disable the connections feature? (true/false)
# If Connections are disabled, than messaging is also disabled as
# messages may only be sent to connections.
# DEFAULT: true
# profile2.connections.enabled=true
# Enable/disable the messaging feature? (true/false)
# DEFAULT: true
# profile2.messaging.enabled=true
# Enable/disable the friend search options (true/false)
# DEFAULT: true
# profile2.search.enabled=true
# Enable/disable the privacy feature? (true/false)
# Be sure to set global privacy settings as desired if this is disabled.
# DEFAULT: true
# profile2.privacy.enabled=true
# Enable/disable the preferences tab? (true/false)
# DEFAULT: true
# profile2.preference.enabled=true
# Allow status updates and display? (true/false)
# DEFAULT: true
# profile2.profile.status.enabled=true
# Enable/dsiable the myKudos feature? (true/false)
# DEFAULT: true
# profile2.myKudos.enabled=true
# Enable/disable the online status feature (true/false)
# This feature shows if you are currently logged in.
# profile2.onlineStatus.enabled=true
# Should users profiles be linked in forum posts? (true/false)
# Works in conjunction with *msgcntr.forums.showProfileInfo* and *msgcntr.messages.showProfileInfo*
# DEFAULT: true
# profile2.profile.link.enabled=true
# User type image
# Set the image for the user based on their user type (true/false)
# If enabled, you also need to set the full URL to images for each user type.
# If a user type has no associated image it will fall back to whatever other image is set, either via upload/url/official/gravatar, or the default.
# To restrict a user from changing the image, combine with profile2.picture.change.enabled=true
# DEFAULT: false
# profile2.user.type.image.enabled=false
# profile.user.type.image.guest=http://url.to/some/image.jpg
# profile.user.type.image.registered=http://url.to/some/otherimage.png
# Email notification on profile change
# You can configure an email to be sent to a specific user whenever anyone updates their profile. (true/false)
# This defaults off and must be explicitly configured. The user gets a notification only, no actual profile content is sent.
# They still need to login to view the info and the same permissions are applied.
# Therefore it is recommended the eid property be set to a super user.
# DEFAULT: false
# profile2.profile.change.email.enabled=false
# profile2.profile.change.email.eid=admin
# Show any of the profile fields? (true/false)
# Useful if you want people to have profiles but not have any information. Users will then only have a name and image
# Use in combination with the privacy defaults/locking to set this as desired otherwise it will show redundant options.
# You can further customise this in the individual settings below
# DEFAULT: true
# profile2.profile.fields.enabled=true
# Enable/disable the staff profile section? (true/false)
# DEFAULT: true
# profile2.profile.staff.enabled=true
# Enable/disable the student profile section? (true/false)
# DEFAULT: true
# profile2.profile.student.enabled=true
# Enable/disable the social profile section? (true/false)
# DEFAULT: true
# profile2.profile.social.enabled=true
# Enable/disable the interests profile section? (true/false)
# DEFAULT: true
# profile2.profile.interests.enabled=true
# Enable/disable the business profile section? (true/false)
# DEFAULT: false
# profile2.profile.business.enabled=false
# If using official images via a URL, the default behaviour is to redirect to that image.
# You can optionally tell Profile2 to fetch the data on your behalf and render it the same as an uploaded image rather than performing a redirect
# This will mean the URL is not exposed to students, which may or may not be a privacy issue for you.
# Note that enabling this may reduce performance. (true/false, default false)
# profile2.official.image.url.secure=false
# Enable/disable the default profile avatar as user name initials (true/false)
# DEFAULT: true
# profile2.avatar.initials.enabled=false
# Change the length of characters used in profile avatar (1 or 2)
# DEFAULT: 2
# profile2.avatar.initials.size=1
# Override the array of background colors (in hexadecimal) used in profile avatars, separated by commas
# DEFAULT: #1abc9c,#16a085,#f1c40f,#f39c12,#2ecc71,#27ae60,#e67e22,#d35400,#3498db,#2980b9,#e74c3c,#c0392b,#9b59b6,#8e44ad,#bdc3c7,#34495e,#2c3e50,#95a5a6,#7f8c8d,#ec87bf,#d870ad,#f69785,#9ba37e,#b49255,#b49255,#a94136
# profile2.avatar.initials.colors=#cd5c5c,#f08080,#fa8072,#e9967a,#ffa07a
# Change the font family used in profile avatar name initials
# DEFAULT: sans-serif
# profile2.avatar.initials.font=Comic Sans MS
# Change the font size used in profile avatar name initials
# DEFAULT: 120
# profile2.avatar.initials.font.size=120
# Enable/disable the name pronunciation profile section? (true/false)
# DEFAULT: false
# profile2.profile.name.pronunciation.enabled=true
# Change the name pronunciation recording duration (in seconds)
# DEFAULT: 10
# profile2.profile.name.pronunciation.duration=20
# URL for the phonetic pronunciation examples link
# profile2.profile.name.pronunciation.examples.link=
#########################################
# RESOURCES/COLLECTIONS
#########################################
## NOTE: for quotas control, see the content section
# File name expressions to ignore in WebDav - Dav will not allow files which have these strings in them to be created.
# This is primarily used to ignore files generated by Apple of the form:
# /access/content/user/zt10/.DS_Store and the files for Resource "forks" which start with "._"
# webdav.ignore.count=2
# webdav.ignore.1=/.DS_Store
# webdav.ignore.2=/._
# ALTERNATELY use the comma separated value form:
# webdav.ignore=/.DS_Store,/._
# Indicates whether to show the WebDav link
# DEFAULT: true
# resources.show_webdav.link=false
# Indicates whether users should see "Show Other Sites" twiggle in list mode of resources tool
# DEFAULT: false
# resources.show_all_collections.tool=true
# Indicates whether users should see "Show Other Sites" twiggle in list mode of dropbox tool
# DEFAULT: false
# resources.show_all_collections.dropbox=false
# Indicates whether users should see "Show Other Sites" twiggle in list mode of file picker
# DEFAULT: false
# resources.show_all_collections.helper=true
# Indicates whether users should see "Show Other Sites" twiggle in file picker
# If this is not set explicity it will look to the resources helper twiggle setting as it is very similar
# DEFAULT: resources.show_all_collections.helper
# filepicker.show_all_collections=true
# The default number of members for a collection at which the resourcse tool should refuse to expand the collection.
# DEFAULT: 256
# resources.expanded_folder_size_limit=256
# What roles should users be able to grant in a folder
# DEFAULT .anon
# resources.enabled.roles=.anon,.auth
# SAK-29389 Added quirks mode to html wrapping options (no doctype)
# DEFAULT: false
#resources.filter.show=true
# SAK-29389 Added quirks mode to html wrapping options (no doctype)
# DEFAULT: false
#resources.filter.showquirks=true
# COPYRIGHT TYPES
# DEFAULT: copyright.types=public_domain,hold_copyright,have_permission,not_determined,use_below,fair_use
# copyright.types=
# NOTE: alternatively, you can use the legacy style to define the list. Ex.:
# copyright.types.count=6
# copyright.types.1=public_domain
# copyright.types.2=hold_copyright
# copyright.types.3=have_permission
# copyright.types.4=not_determined
# copyright.types.5=use_below
# copyright.types.6=fair_use
# SAK-39953 - define the default copyright option. When set, this will force the desired copyright option to be pre-selected in the copyright status drop down
# NOTE: For this property to take effect, you must also explicity set the above 'copyright.types' property, and the desired default must exist in the 'copyright.types' list.
# Alternatively, this property can be used with custom copyright options. Simply set the property to the desired custom copyright message bundle key (ex. custom.copyright.1)
# NOTE: This property is not obeyed when using the copyright require choice property is set to true (described below, copyright.requireChoice, SAK-39953)
# DEFAULT: copyright.type.default=
# copyright.type.default=not_determined
# SAK-39953 - use custom copyright options rather than the predefined list
# NOTE: define your custom copyright options in /content/content-copyright/impl/src/bundle/org/sakaiproject/content/copyright/copyright.properties
# NOTE: examples are defined in the above file, with the keys 'custom.copyright.#'; define as many or as few as needed by your institution
# DEFAULT: false
# copyright.useCustom=true
# SAK-39953 - require users to explicity define the copyright status for uploaded files in the Resources tool
# NOTE: does not require any other copyright sakai.properties to be set (works with defaults, copyright.types and custom copyright)
# DEFAULT: false
# copyright.requireChoice=true
# Use the Creative Commons dialog instead of the default copyright dialog
# DEAFULT: false
# copyright.use_creative_commons=true
# List of macros that will be expanded to their full value when used in a web link in resources.
# DEFAULT: ${USER_ID},${USER_EID},${USER_FIRST_NAME},${USER_LAST_NAME}
# content.allowed.macros=${USER_FIRST_NAME},${USER_LAST_NAME}
# One or more site types (course, project, etc.) for which public resources should be disallowed.
# DEFAULT: none (null)
# prevent.public.resources.count=1
# prevent.public.resources.1=project
# prevent.public.resources.2=portfolio
# ALTERNATELY, use the comma seperated list form
# prevent.public.resources=project,portfolio
## ROSTER
# Show roster x weeks before term starts.
# DEFAULT: 0
# roster.available.weeks.before.term.start=4
# This is an option to display names in the format of firstName lastName
# DEFAULT: none (null) (ie false).
# roster.display.firstNameLastName=true
# This determines whether to show or hide the group filter if only one group or section is displayed in the roster.
# DEFAULT: none (null) (ie false).
# roster.display.hideSingleGroupFilter=true
# This determines whether to show official pictures first
# DEFAULT: true
# roster.display.officialPicturesByDefault=false
# This determines the default sort column in the roster - one of ( sortName | role | email | displayId )
# DEFAULT: sortName.
# roster.defaultSortColumn=sortName
# SAK-28901 Ability to set view as the default
# DEFAULT: 0
# Possible values: 0=overview, 1=pictures, 2=group membership, 3=status
# roster.defaultState=2
# Whether to render the email column for the roster view
# DEFAULT: true
# roster_view_email=false
# Hide connection information from picture view (default=false), Profile2 >=1.4
# NOTE: If Profile2.connections.enabled is false, set accordingly.
# roster_view_connections=true
# Whether to allow site visit data to be displayed with each member
# DEFAULT: false
# roster.showVisits=true
# Include user properties in roster
# DEFAULT: true
# roster_view_user_properties=false
# Filter user properties that should never be visible using a regex pattern
# DEFAULT: ^udp\\.dn$
# roster.filter.user.properties.regex=^udp\\.dn$
# SAK-28904 Ability to hide roles in roster
# DEFAULT: null (none)
# roster2.visibleroles=instructor,student
# SAK-34057: show 'Permissions' widget to site maintainers (otherwise only admins)
# DEFAULT: true
# roster.showPermsToMaintainers=false
# SAK-40451: implement pronounciation provider (NameCoach only one for now)
# DEFAULT: null (none)
# roster.pronounciation.provider=namecoach
# namecoach.auth_token=xxxxxxxxxx
# namecoach.url=https://name-coach.com/api/private/v4/participants
# SAK-41826: Roster: Surface name pronunciation from SAK-41812
# Displays the students' audio recordings from profile in roster, feature introduced in SAK-41812
# DEFAULT: false
# roster.display.user.name.pronunciation = true
## SEARCH
# Elastic search is the default search as of Sakai 10
# For more information please see this confluence page
# https://confluence.sakaiproject.org/display/SEARCH/Elasticsearch
# Every property of elasticsearch can be configured by using the prefix
# elasticsearch.
# And then using the property from the elasticsearch.yml file
# (As of version .90 this is https://github.com/elasticsearch/elasticsearch/blob/0.90/config/elasticsearch.yml)
# This file just contains some of the most common, please see that Yaml file and page
# for additional info.
# Enable the elastic search
# DEFAULT: false
# search.enable=true
# SAK-27657 Select search service impl (sample property is to switch to legacy builder)
# DEFAULT: org.sakaiproject.search.elasticsearch.ElasticSearchService
# Note: Other search services may be available to switch to
#search.service.impl=org.sakaiproject.search.component.service.impl.ConcurrentSearchServiceImpl
# SAK_27657 Select search index builder (property is to switch to legacy builder)
# DEFAULT: org.sakaiproject.search.elasticsearch.ElasticSearchIndexBuilder
# Note: Other search index builders may be available to switch to
# search.indexbuilder.impl=org.sakaiproject.search.component.service.impl.SearchIndexBuilderImpl
# Whether or not to build indexes for the search tool.
# DEFAULT: true
# search.indexbuild=false
# Controls access to the Admin page within search.
# This should only be activated on the actual search server node and all other nodes should have this turned off to restrict access.
# See https://jira.sakaiproject.org/browse/SRCH-96
# DEFAULT: true
# searchServer@org.sakaiproject.search.api.SearchService=true
# Exclude indexing user sites
# DEFAULT: true
# excludeUserSites@org.sakaiproject.search.api.SearchService=false
# To only index sites that have the Search tool placed
# DEFAULT: true
# onlyIndexSearchToolSites@org.sakaiproject.search.api.SearchIndexBuilder=false
# Sites to ignore in the search
# DEFAULT: ~admin,!admin,PortfolioAdmin
# ignoredSites@org.sakaiproject.search.api.SearchService=~admin,!admin,PortfolioAdmin
# To enable facetting, which will allow the "tag" tab to work: (not recommended for production)
# DEFAULT: false
# useFacetting@org.sakaiproject.search.api.SearchService=true
# To turn off site filtering (this is on by default). You can decide to use filters to match against sites, or the query itself can list the sites. In theory, filters should be faster as the results of filters are cached in ES. This may require more memory to do so. In practice, the response times don't seem to differ much with this on or off.
# DEFAULT: false
# useSiteFilters@org.sakaiproject.search.api.SearchService=true
# To turn the autocomplete feature on/off.
# DEFAULT: false
# useSuggestions@org.sakaiproject.search.api.SearchService=true
# To control the size of the batch index thread. The larger this is the most likely it is that nodes will end up indexing the same thing wasting cycles. If it set to low indexing will be slow. In practice you want your bulk size to not take longer than how often you are running the bulk thread.
# DEFAULT: 100
# contentIndexBatchSize@org.sakaiproject.search.api.SearchIndexBuilder=100
# The bulkRequestSize controls the number of requests that are rolled into one ES call. Settings this too low will cause a lot more merges and can slow things down or even cause data issues. Setting is too high is a memory concern as the docs will be in memory until they are flushed out. 10-20 is probably a reasonable number depending on the size of your docs.
# DEFAULT: 20
# bulkRequestSize@org.sakaiproject.search.api.SearchIndexBuilder=20
# How often the bulk index job runs in seconds
# DEFAULT: 60
# period@org.sakaiproject.search.api.SearchIndexBuilder=60
# How many shards to start up for elastic search
# DEFAULT: 5
# elasticsearch.index.number_of_shards=5
# How many replicates to start up for elastic search
# DEFAULT: 1
# elasticsearch.index.number_of_replicas=1
# Turning on http communication so you can use curl and other tools. You want to make sure this is firewalled to the outside world, but its really handy to have on even in production.
# DEFAULT: true
# elasticsearch.http.enabled=true
# Default port to use for http communication above
# DEFAULT: 9200
# elasticsearch.http.port=9200
# Multicast is the default but unicast should be supported you need these options
# Turn multicast off
# elasticsearch.discovery.zen.ping.multicast.enabled=false
# Pick your communication port
# elasticsearch.transport.tcp.port=9300
# Set the location of all your nodes, including the port
# elasticsearch.discovery.zen.ping.unicast.hosts=ec2-184-169-221-255.us-west-1.compute.amazonaws.com:9300,ec2-204-236-163-255.us-west-1.compute.amazonaws.com:9300,ec2-184-169-227-255.us-west-1.compute.amazonaws.com:9300,ec2-204-236-170-255.us-west-1.compute.amazonaws.com:9300
# See the confluence page for more details on unicast/multicast/EC2 discovery options.
# SAK-40838: If you're running multiple Sakai's, for customers for example, against one ES instance, you'll need this
# or your Sakai instances will share the sakai_index, questions_index and any others in the future.
#
# DEFAULT: not set
# search.indexNamespace=mynamespace
# SECTION MANAGER CONFIGURATION
# Options include MANUAL_DEFAULT, MANUAL_MANDATORY, AUTOMATIC_DEFAULT and AUTOMATIC_MANDATORY.
# See https://source.sakaiproject.org/svn/sections/tags/sakai_2-6-0/xdocs/README.txt)
#config@org.sakaiproject.section.api.SectionManager=AUTOMATIC_DEFAULT
# SAK-22537: How many sections can be added at one time?
# DEFAULT: 10
#sections.maxgroups.category=20
## SITE INFO
# SAK-22450: Controls for the template creation screen
# site.setup.templateControls (previous alias templateControls)
# DEFAULT: ""
# This is a special property that has to be defined as json that allows control of each item on the "create item from template" page.
# For example to set if you want copyUsersChecked or even the checkbox for that visible per site type
# Below is an example for using it. For example to check everything and have it visible in a course site and to have nothing visible in a project site. See jira for more information.
#site.setup.templateControls={"templateControls": {"course":{ "blurb": "(select from templates for common <u>class</u> types)", "copyUsersVis": true, "copyUsersChecked": true, "copyUsersLocked": false, "copyContentVis": true, "copyContentChecked": true, "copyContentLocked": false, "publishSiteVis":true, "publishSiteChecked":true, "publishSiteLocked": false},"project":{ "blurb": "(select from templates for common <u>project</u> types)", "copyUsersVis": false, "copyUsersChecked": false, "copyUsersLocked": false, "copyContentVis": false, "copyContentChecked": false, "copyContentLocked": false, "publishSiteVis":true, "publishSiteChecked":false, "publishSiteLocked": false}}}
# Control the visibility of the Site Info toolbar action - Edit Class Roster(s).
# If set to true, the action is present. If set to false, the action is not present
# in the toolbar. If not set, or set to true, the action is present in the toolbar.
# DEFAULT: true
# site.setup.allow.editRoster=false
# Control if stealthed tools are removed when duplicating sites
# DEFAULT: false
# site.duplicate.removeStealthTools=true
# SAK-41346: Control if maintainer of course sites are able to delete the last remaining roster
# attached to a site. If this is enabled, the user deleting the roster will automatically be
# enrolled as a non-provided user in the maintain role, allowing the user to continue using
# the site after the roster has been removed.
#
# WARNING: enabling this may have legal implications depending on your local privacy laws. For
# example: FERPA in USA, FIPPA in regions of Canada, GDPR in regions of Europe, etc. More
# information and an example of how this can come into play can be found on the JIRA ticket:
# https://jira.sakaiproject.org/browse/SAK-41346
#
# DEFAULT: false
# site.setup.allowDelLastRoster=true
# SAK-13389: the ability to hide input area for adding non-official participant
# DEFAULT=true
# nonOfficialAccount=false
# Disable from worksite setup the "import file" option
# The toolbar of the Site Info tool can optionally contain an item Import from File if site.setup.import.file equals true.
# DEFAULT: true
# site.setup.import.file = false
# SAK-27575: Sakai 10.0 introduced a notification to the current user that their import is complete
# DEFAULT: true
# site.setup.import.notification = false
# SAK-28069: Enable the automatic addition of any missing tools into a site when content from another site is selected for import
# DEFAULT: true
# site.setup.import.addmissingtools=false
# SAK-27580: Ability to disable site creation notification that goes to the setup.request address
# DEFAULT: true
# site.setup.creation.notification = false
# SAK-41091: Ability to disable site creation notification that goes to the user who created the site
# DEFAULT: true
# site.setup.creation.notification.user = false
# SAK-29525: Open Template list by default when creating site
# DEFAULT: false
# site.setup.creation.expand.template = true
# SAK-22432: Template descriptions are not copied
# DEFAULT: true
# site.setup.copy.template.description = false
# SAK-40828: Prevent creating sites with ids that contain spaces or other characters
# DEFAULT: false
# site.api.allow_malformed_ids = true
# Comma separated list of site types to hide PageOrder tab,
# e.g. if set to "course,project", the PageOrder tool tab will be hidden for all course sites and project sites.
# DEFAULT: none (null)
# hide.pageorder.site.types=
# Set the default page size for lists of entities.
# DEFAULT: 50
# site.entity.pagesize.default=25
# Set the maximum page size for lists of entities.
# DEFAULT: 500
# site.entity.pagesize.maximum=200
# Set the site entity broker properties that can be updated by a user with site update permission.
# Only works for single value properties, not multivalued.
# DEFAULT: contact-email, contact-name
# site.entity.updateable.props=contact-email, contact-name
# Show the menu option for duplicate site
# SAK-27908: disabled this option by default because it is not run in a separate thread like Import from Site
# DEFAULT: false
# site.setup.allowDuplicateSite=true
### SAK-28059 Auto filter term to the most recent term
# DEFAULT: false
# site.setup.autoFilterTerm=false
### SAK-21336 Allow maintainers/admins to remove orphaned members from a site
# Valid possibilities: admins or maintainers; admins=super users only, maintainers=maintain user of the site like Instructor
# DEFAULT: admins
# Disable it by setting to "none"
# site.setup.showOrphanedMembers=admins
### SAK-22510 Add a site id column to worksite setup
# DEFAULT: false
# site.setup.showSiteIdColumn=true
## Max length for site title input field in the UI
# DEFAULT: 25 characters
# site.title.maxlength=25
### SAK-23567 Flexible way to shorten site title in tabs
## Max length for site title display
# DEFAULT: site.title.maxlength
# site.title.cut.maxlength=25
## Abbreviation method for site title display
# Examples:
# 0:100 display the last site.title.cut.maxlength characters and the separator string at the beginning
# 50:50 display first site.title.cut.maxlength*50% characters the separator string and the last site.title.cut.maxlength*50%
# DEFAULT: 100:0 (display the first {site.title.cut.maxlength} characters and the separator string at the end)
# site.title.cut.method=100:0
## Separator string used to separate characters in cut method
# DEFAULT: "..." (three dots)
# site.title.cut.separator=***
# Comma seperated list of the types of sites that can be created
# DEFAULT: none (null)
# site.types=
# The following properties allow you to override the settings in sakai.siteinfo.xml and sakai.sitesetup.xml
# By default, only project sites are allowed to be changed from private to public. Provide comma separated
# site types to override any of the settings.
# NOTE: site.types.privateOnly and its corresponding property in the XML files (privateSiteTypes) do not
# work; see SAK-28173
#site.types.publicChangeable=
#site.types.publicOnly=
#site.types.privateOnly=
#site.types.defaultType=
# This determines if you want user audit event logging in your instance of Sakai
# This setting controls if the page renders to display user auditing information in Site Info.
# This does NOT prevent writing audit information to the database
# DEFAULT: true
# user_audit_log_display=true
# SAK-34034 Filter by group in the Site Info Groups Management screen
# DEFAULT: false (disabled)
# Set to true to show the filter in the Site Info Groups Management screen
# siteinfo.group.filter.enabled=true
### Sites admin permissions tool
## You may want to adjust these values up if you have a massive number of sites
## or a lot of load on your server. These values are probably OK for maybe 10k sites.
# Maximum number of seconds to run a single set of permissions updates before terminating the thread
# and allowing another thread with updates to be started
# DEFAULT: 3600 (1 hour)
#site.adminperms.maxrun.secs=3600
# Pause for this many milliseconds after every 10 sites permissions are updated
# DEFAULT: 1001 (just over 1 second)
#site.adminperms.pause.ms=1001
# Update this many sites before pausing for the (adminperms.pause.ms) number of ms
# DEFAULT: 10
#site.adminperms.sitesuntilpause=10
# Allow instructors to create and manage sections by themselves while also
# having some types of sections locked (read only). With this configuration
# (and MANUAL type set) an Instructor can create and manage sections except
# with the configured readonly categories.
# Defines the category codes of sections that are readonly (e.g. 01.lct,02.lab)
# DEFAULT: "" (empty) - all sections can be edited
# section.info.readonly.section.categories=
# Control the default hidden status of imported resources content
# when using Import from Site > Re-use Content feature in Site Info (SAK-23305)
# DEFAULT: false (visible)
# Since: 10.0
# content.import.hidden=true
## SYLLABUS
# When you are on the main page and you click "add item",
# the item is added as draft by default.
# Setting this property to true, items are added as published by default.
# DEFAULT: false (items save as draft)
# syllabus.new.published.default=true
## TEST & QUIZZES (SAMIGO)
# Minimum time between timer AJAX requests in miliseconds
# DEFAULT: 5000
# samigo.ajaxTimerMinReqScale=5000
# SAM-948 - Minimum value option for questions
# DEFAULT: FALSE
# samigo.allowMinScore=true
# Samigo File Upload question type settings default settings:
# DEFAULT: 1024
# samigo.sizeThreshold=512
# DEFAULT: 40960
# samigo.sizeMax=20480
# DEFAULT: true
# samigo.saveMediaToDb=false
# If saveMediaToDb has been set to false but there are existing Samigo media
# files stored in the database, set samigo.convertMedia to true to trigger a
# conversion on startup that moves those files out of the database and onto
# the file system.
# This uses batching to be safe for restarts or multiple
# nodes. Records are processed in batches of 10. If a batch is
# interrupted, records may be left with the value of "CONVERTING" in the
# location field. To re-initiate these, that field should be set to null
# for those records.
# DEFAULT: false
# samigo.convertMedia=true
# DEFAULT: {sakai.home}/samigo/answerUploadRepositoryPath/
# samigo.answerUploadRepositoryPath=${sakai.home}/samigo/answerUploadRepositoryPath/
## NOTE: Samigo email is current not used - https://jira.sakaiproject.org/browse/SAM-1249
# The email settings below are for Samigo only. They are used because Sakai email
# doesn't support Resources attachments. Samigo first looks to these settings
# instead of the regular Sakai email settings. If they are not set, the
# Sakai eamil settings will be used. Please note, these settings do not
# override the usual Sakai settings.
#
# Outgoing SMTP server (If not set, the Sakai smtp server setting will be used)
# samigo.smtp.server=
# Outgoing SMTP port (If not set, the default part 25 will be used)
# samigo.smtp.port=
# Temp directory for handling email attachment files.
# DEFAULT: none (null) - not setting will cause an error in sending samigo email with attachments
# samigo.email.prefixedPath=/tmp/
# Enable or disable email notifications for samigo autosubmit failures
# DEFAULT: false (no emails will be sent by default)
# samigo.email.autoSubmit.errorNotification.enabled=true
# Set the address to which autosubmit failure emails will be sent to
# DEFAULT: the current value of the 'mail.support' sakai.property
# DEFAULT: if 'mail.support' is not set, the current value of the 'samigo.fromAddress' sakai.property is used
# DEFAULT: if 'samigo.fromAddress' is not set, the current value of 'setup.request' sakai.property is used
# DEFAULT: if 'setup.request' is not set, property value falls back to "no-reply@" + serverConfigurationService.getServerName()
# samigo.email.autoSubmit.errorNotification.toAddress=notifyUs@example.com
# This is for Samlite, the word-2-QTI converter (default is true)
# DEFAULT: true
# samigo.samliteEnabled=false
# Edit Published Assessment
# When samigo.editPubAssessment.restricted is set to false, the published assessment is editable even if students have started taking it.
# DEFAULT: true.
# samigo.editPubAssessment.restricted=false
# When samigo.editPubAnonyGrading.restricted is set to true, the Students' Identities section in published settings is not editable.
# The default is false, setting grading anonymity is editable. Look for "Hide student identity from grader" checkbox in
# Settings -> Grading and Feedback. When false, default, this checkbox can be unchecked even after publishing the test and at least
# one student taking the test.
# When true, the checkbox cannot be unchecked. Once you set the test to anonymous grading, it stays that way.
# DEFAULT: false.
# samigo.editPubAnonyGrading.restricted=true
# Auto Submit feature (SAK-14474)
# [WARN] You must also run sam/docs/auto_submit/auto_submit_*.sql (choose the appropriate SQL dialect)
# in order to pre-populate the database with required metadata.
# See sam/docs/auto_submit/README.autoSubmit.txt for instructions.
# DEFAULT: false (no auto submit feature)
# samigo.autoSubmit.enabled=true
# Partial Credit for Multiple Choice Assessments (SAM-818)
# DEFAULT: false (cannot give partial credit)
# samigo.partialCreditEnabled=true
# Print Assessment in html/pdf format (SAM-721)
# Was off by default until Sakai 11 (SAM-2381)
# DEFAULT: true
# samigo.printAssessment=false
# The ability to choose "Average" for the "Recorded Score if Multiple Submissions (SAM-862)
# DEFAULT: false (cannot record average score)
# samigo.canRecordAverage=true
# Show or hide Assessment Templates/Types (SAM-921)
# DEFAULT: false (hide)
# samigo.showAssessmentTypes=true
# auto save configuration (SAM-674)
# DEFAULT: -1 (auto save is off)
# Example: If you want to auto save every 15 min, update the value to 900000
# samigo.autoSave.repeat.milliseconds=900000
# Control length of question answers in Questions page (SAM-2085)
# DEFAULT: 1000 (chars)
# samigo.questionScore.answerText.length=2000
# Control the Student recommendations link URL path on the Begin Assessment page (SAM-2092)
# You need to create your own recommendation page and add it to Resource (make it publicly viewable)
# Example: /content/group/RecForStudentsTest.html
# DEFAULT: "" (no link shown)
# samigo.recommendations.path=/content/group/RecForStudentsTest.html
# A list of JAR files separated by ":". Each JAR file plugin can provide one or more secure module implementation(s).
# DEFAULT: none (null)
# samigo.secureDeliveryPlugins=
#SAM-2296 - Allows disabling (or enabling) certain question types
# Show the extended matching item (EMI) question type
# DEFAULT: false
#samigo.question.show.extendedmatchingitems=true
# Show the file upload question type
# DEFAULT: true
#samigo.question.show.fileupload=false
# Show the essay question type
# DEFAULT: true
#samigo.question.show.essay=false
# Show the audio question question type
# DEFAULT: true
#samigo.question.show.audio=false
# Show the matching question type
# DEFAULT: true
#samigo.question.show.matching=false
# Show the true false question type
# DEFAULT: true
#samigo.question.show.truefalse=false
# Show the multiple choice single correct question type
# Note: Currently single correct and multiple are linked and you can't have one without the other, both options must be true to display both. If one is false neither question type will appear
# DEFAULT: true
#samigo.question.show.multiplechoicesinglecorrect=false
# Show the multiple choice multiple correct question type
# Note: Currently single correct and multiple are linked and you can't have one without the other, both options must be true to display both. If one is false neithe question type will appear
# DEFAULT: true
#samigo.question.show.multiplechoicemultiplecorrect=false
# Show the fill in the blank question type
# DEFAULT: true
#samigo.question.show.fillintheblank=false
# Show the fill in numeric question type
# DEFAULT: true
#samigo.question.show.fillinnumeric
# Show the survey question type
# DEFAULT: true
#samigo.question.show.survey=false
# Show the matrix survey question type
# DEFAULT: true
#samigo.question.show.matrixsurvey
# Show the calculated question question type
# DEFAULT: none (null)
#samigo.question.show.calculatedquestion=false
# Show the ImageMap question type
# DEFAULT: true
#samigo.question.show.showImageMapQuestion=true
# Does not let the instructor edit a published test after it has started
# Default: false
#samigo.editPubAssessment.restricted.afterStart=true
# Does not let the instructor remove a published test after it has started
# Default: false
#samigo.removePubAssessment.restricted.afterStart=true
# 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
# Whether or not to disable the wysiwyg option if the wysiwyg is set to the default (delivery mode). The wysiwyg is still visible for instructors when authoring an exam
# Can be used to reduce potential problems for deliverying the test on mobile or restricted browsers
# Default: false
# samigo.wysiwyg.delivery.disable=true
# SAM-2630 subtask SAM-2657
# Use the following paths for the images used in the question progress panel.
# These images should be 15px x 15px. Note that the context is /samigo-app/
# samigo.questionprogress.unansweredpath = /images/whiteBubble15.png
# samigo.questionprogress.answeredpath = /images/blackBubble15.png
# samigo.questionprogress.markdpath = /images/questionMarkBubble15.png
# SAM-1947 Email notifications on Samigo Submission
# The from address for individual submission notifications
# DEFAULT: no-reply@serverName
# samigo.fromAddress=<SAMIGO_SMTP_FROM>
# SAM-1331: Warn user of modification to edited quiz
# DEFAULT: true
# samigo.SelectAssessmentBean.warnUserOfModification=false
# SAM-3186 - Whether or not to update site ids to current site when assessment is published (Added in SAM-1596)
# DEFAULT: true
# samigo.publish.update.siteids=false
# SAM-3383 Filter assessments by group in the Assessments List
# DEFAULT: false (disabled)
# Set to true to show the filter in the Assessments List view
# samigo.group.filter.enabled=true
# Control visibility of the 'Delete' column for submissions in the 'Scores' UI globally.
# Can also be set on a per site basis via site properties, using the same property string.
# See SAM-3210 for more details.
# DEFAULT: false
# samigo.removeSubmission.restricted=true
#########################################
# MEMBERSHIP TOOL
#########################################
# Supplementary information presented at the top of the 'My Official Enrolments' page of the 'Membership' tool
# DEFAULT: "" (empty string, nothing shown)
# membership.enrolments.blurb=Provide extra information about institution SIS processes, etc.
#########################################
# WORKSITE SETUP/SITE INFO
#########################################
# Enable the ability to control a participant's site activation.
# DEFAULT: false
# activeInactiveUser=true
# Suppport group editing in Worksite Setup tool: true or false
# DEFAULT: true
# wsetup.group.support=true
# Show the groups summary on the front of Site Info
# DEFAULT: true
# wsetup.group.support.summary=true
# Support prepopulating mailarchive with email address SAK-19298
# DEFAULT: true
# wsetup.mailarchive.prepopulate.email=true
# One or more site types (course, project, etc.) for which the joinable option is not setable (within Worksite Setup or Site Info tool)
# wsetup.disable.joinable.count=1
# wsetup.disable.joinable.1=course
# Show the group toolbar unless configured to not support group. If the manage group helper is available, <