## 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 ## 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 # ######################################################################## # 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 # The number of sites tabs to display before adding the "More" dropdown list. # DEFAULT: uses portal.default.tabs setting (which if not set is 5) # gatewaySiteListDisplayCount=4 # 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 = Gateway # bottomnav.2 = Mobile View # bottomnav.3 = The Sakai Project # ALTERNATELY, define bottomnav as a comma separated list of values to use # bottomnav=Gateway,Mobile View,The Sakai Project # 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=http://sakaiproject.org # powered.img.count=1 # powered.img.1=/library/image/sakai_powered.gif # 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. Portions of Sakai are copyrighted by other parties as described in the Acknowledgments screen. ## VERSION - The are set in auto.sakai.properties at build time. # Format: ${ui.service} - \${version.service} - Sakai \${version.sakai} (kernel: \${version.kernel}) - 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 # version.kernel=1.3.0-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 # Text to display for the extra login (no effect if xlogin is not enabled) # DEFAULT: Guest Login #xlogin.text=Guest Login # 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=ANU Users #xlogin.choice.icon=http://url/to/sakai.jpg #xlogin.choice.text = Guest Users # 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 # 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 # 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 # ######################################################################## # 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 # 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 # 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 # ######################################################################## # 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} # 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 # 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 # Enable creation of Web Content tools from resources, on by default. # DEFAULT: true # content.make.site.page=true # Enable upload via drag n drop, on by default. # DEFAULT: true # content.upload.dragndrop=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 = ## 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 # OLD setting (still works but you should use the new one instead) # siteQuota@org.sakaiproject.content.api.ContentHostingService={value in KB} # NEW setting # DEFAULT: 0 (unlimited storage/no quota) # 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 all sites quota # content.quota.{sitetype}={value in KB} # Set the dropbox quota for all sites/dropboxes # DEFAULT: 0 (unlimited storage/no quota) # 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 all sites quota # 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 # ######################################################################## # 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, en_GB, en_AU, en_NZ, en_ZA, ja_JP, ko_KR, nl_NL, zh_CN, zh_TW, es_ES, fr_CA, fr_FR, ca_ES, sv_SE, ar, ru_RU, pt_PT, pt_BR, eu, vi_VN, tr_TR, es_MX, mn, pl_PL, de_DE, hi_IN # 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 # 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 # ######################################################################## # SKINS # ######################################################################## # The default skin for sites without a skin setting # DEFAULT: default # skin.default=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 # ######################################################################## # PORTAL # ######################################################################## # Specifies the templates to be used for the portal. 'neoskin' is the default for 2.9+. # To restore the 2.8 and earlier templates, set this property to 'defaultskin' # DEFAULT: neoskin # portal.templates=defaultskin # Specifies the skin prefix # DEFAULT: neo- # portal.neoprefix=neo- # If set to false, auto redirect for mobile devices is disabled and classic view will be used preferentially. # DEFAULT: true # portal.pda.autoredirect=false # SAK-21334 - If set to true (and the portal.pda.autoredirect is also true) will also redirect larger 'tablet' devices to the mobile portal # DEFAULT: false # portal.tablets.use.mobile=true # To override the default regular expression add this property. # To specify a different regular expression for a particular Sakai tool, use a property with this pattern: portal.pda.bypass.[toolid]= # DEFAULT: \\.jpg$|\\.gif$|\\.js$|\\.png$|\\.jpeg$|\\.prf$|\\.css$|\\.zip$|\\.pdf\\.mov$|\\.json$|\\.jsonp$\\.xml$|\\.ajax$|\\.xls$|\\.xlsx$|\\.doc$|\\.docx$|uvbview$|linktracker$|hideshowcolumns$ # portal.pda.bypass= # 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 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 # Controls the portal chat feature # DEFAULT: true # portal.neochat=false # 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 # My Active Sites drop-down (a.k.a., More Sites) # Set to false to disable display of the "More Sites" drop-down as a pop-up window organized by site type. # DEFAULT: true as of Sakai 10.0 # portal.use.dhtml.more=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. If the string contains the text ":all:", then by default all iframes will be suppressed, # and only the tools whose ids are specified will be displayed with iframes. # DEFAULT: none (null) # portal.experimental.iframesuppress=:all:sakai.assignment: # Whether or not to maximize the display when only one site is available. # DEFAULT: false # portal.experimental.maximizesinglepage=true # Configuration option indicaing support for frame set mode. Values (always|never) # DEFAULT: none (null) = never # portal.frameset= # 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 # Number of tabs to display in the portal before sites are placed into a pulldown menu listing # DEFAULT: 5 # portal.default.tabs=5 # 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 # Show the mobile link # DEFAULT: false # portal.add.mobile.link=false # DEFAULT: true # portal.allow.neo.portlet=false # Put the application in portlet JSR-168 testmode # DEFAULT: null (false) # portal.allow.test168=true # Portal minimization preferences # DEFAULT: true # portal.allow.auto.minimize=false # Allows the ability to minimize the navigation of top logo. # DEFAULT: false # portal.allow.minimize.navigation=true # Allows the ability to minimize the tools where only the icons display. # DEFAULT: true # portal.allow.minimize.tools=false # Property to disable setting the HttpOnly attribute on the cookie (if false) # DEFAULT: true (enabled) # sakai.cookieHttpOnly=false # 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 # ######################################################################## # 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 # 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 #content.cleaner.errors.display = true # 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: true # portal.error.showdetail=false # 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 # ######################################################################## # 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 # 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 #org.theospi.portfolio.wizard.mgt.impl.WizardManagerImpl.cache #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) # authz.cacheGrants=true # 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 # ######################################################################## # 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 # ######################################################################## # EMAIL # ######################################################################## ## INCOMING EMAIL # Flag to enable or disable James for incoming email (true | false) # DEFAULT: false. # smtp.enabled=true # DNS addresses used by James for incoming email. # DEFAULT: none (null) # smtp.dns.1=255.255.255.1 # smtp.dns.2=255.255.255.2 # SMTP port on which James runs. # Recommend running on 8025, and using a standard mailer on 25 to forward mail to Sakai. # Default=25. # smtp.port=8025 # Location for James logs, if not set, defaults to {sakai.home}/logs/ # DEFAULT: none (null) # smtp.logdir= # Email support address used in incoming email rejection messages. # DEFAULT: none (null) # mail.support= # Control James email processing rules # Valid processors are: none (ghost), error, local-address-error, relay-denied, and bounces # none - no processing occurs, the message is essentially ignored # error - the error processor is triggered which usually emails the admin and logs the value # local-address-error - bounce back to origin and indicate the address is wrong # relay-denied - bounce back and indicate messages are not accepted from their email / domain # bounces - general bounce back to the origin # All processing is blocked by default to protect Sakai from becoming a spam relay (so all processors are set to "none") # To match pre-sakai-2.7 processing, uncomment the processors below # smtp.archive.disabled.processor=none # smtp.archive.address.invalid.processor=local-address-error # smtp.user.not.allowed.processor=bounces ## 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= # Password for connection to SMTP server (Optional) # smtpPassword@org.sakaiproject.email.api.EmailService= # 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= # 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 Worksite Setup tool or Site Info tool. # 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= # 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= # ######################################################################## # 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-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 # ######################################################################## # 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 # ######################################################################## # GLOSSARY # ######################################################################## # Whether or not to override the existing glossary permissions with those set in glossary.permissions.map. # If set to true, only the permissions set in glossary.permissions.map will be set. # Any other value and the permissions set in glossary.permissions.map will be set added to any existing permissions. # DEFAULT: none (null) - permissions set in glossary.permissions.map will be set added to any existing permissions # glossary.permissions.override=true # Define the map of permissions to either append or replace for glossary permissions # DEFAULT: none # glossary.permissions.map.count=2 # glossary.permissions.map.1=Coordinator # glossary.permissions.map.1.siteTypes=portfolio,project # glossary.permissions.map.1.value.count=4 # glossary.permissions.map.1.value.1=osp.help.glossary.delete # glossary.permissions.map.1.value.2=osp.help.glossary.add # glossary.permissions.map.1.value.3=osp.help.glossary.edit # glossary.permissions.map.1.value.4=osp.help.glossary.export # glossary.permissions.map.2=Assistant # glossary.permissions.map.2.siteTypes=portfolio # glossary.permissions.map.2.value.count=4 # glossary.permissions.map.2.value.1=osp.help.glossary.delete # glossary.permissions.map.2.value.2=osp.help.glossary.add # glossary.permissions.map.2.value.3=osp.help.glossary.edit # glossary.permissions.map.2.value.4=osp.help.glossary.export # ######################################################################## # 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 # 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 # 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 # 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 # 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 # 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 ## 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 # 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 ## 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= # 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: none (null) # basiclti.consumer_instance_guid= # 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] # LORI API allows an External Tool to call back into Sakai and install LTI links in the Lessons tool # See the docs for more info: https://source.sakaiproject.org/svn/basiclti/trunk/basiclti-docs/resources/docs/sakai_basiclti_api.doc # DEFAULT: true # basiclti.lori.enabled=false # 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= ## 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 # Enable iCal import/export # DEFAULT: false # ical.experimental=false ## 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: false # calendar.external.subscriptions.enable=true # Merge External iCal Subscriptions from other sites into My Workspace? # 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=My Workspace 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.cachetime=120 # calendar.external.subscriptions.user.cacheentries=32 # calendar.external.subscriptions.user.cachetime=120 ## 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= ## NEWS TOOL # Default title and feed URL for the news tool # DEFAULT: http://sakaiproject.org/news-rss-feed # news.feedURL= ## 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},${SESSION_ID},${SITE_PROP:course-unique-id},${SITE_PROP:course-section-key} # PAGE ORDER HELPER # Allow users to edit the titles of tools. # DEFAULT: true # org.sakaiproject.site.tool.helper.order.rsf.PageListProducer.allowTitleEdit=false ## 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= # set this to true when upgrading from Sakai 2.4 to 2.5 # DEFAULT: false # osp.upgrade25=true # Enable selection & auto-population of matrix/wizard cell with assignments (SAK-10832) # DEFULT: false # osp.experimental.assignments=truee # If true, allow any (matrix/wizard) reviewer to view members independent of group membership # DEFAULT: false # osp.reviewer.groups.allowall.global=true # If true, include section-groups in reviewer group list (SAK-18538, default is to only include manual groups as of SAK-17055) # DEFAULT: false # osp.reviewer.groups.include.sections=true # Enable/disable caching for rendering of portfolios (SAK-14206) # DEFAULT: false # cache.osp.presentation.data=true # Set this to false to disable caching of xslt templates (good for testing) # DEFAULT: false # xslt-portal.cacheTemplates=true # Option to turn off tool categories in xslt charon portal # DEFAULT: true # xslPortal.displayToolCategories=false # Matrix footer will be displayed if the following number of rows is exceeded. # Setting osp.matrixRowFooter equal to -1 will disable matrix footer display. # DEFAULT: 10 # osp.matrixRowFooter=10 # SAK-15348 # Set the runOnInit to true if you want the check to run on startup. # DEFAULT: false # There is also a quartz job that you can run if you don't want to have this run on startup. # metaobj.schemahash.runOnInit=true # Set the update to true if you want the records to be updated # DEFAULT: false # metaobj.schemahash.update=true # SAK-15540: allow restricted view of preview matrices by permission (e.g. osp.matrix.scaffolding.edit) # DEFAULT: null (all can view) # osp.preview.permission= # SAK-15911: enable cookies to track form save attempts/success. # Default is false, meaning no new cookies # metaobj.save.cookies = true # SAK-16610: If true, users with osp.presentation.review permission may view all portfolios in site (whether or not they've been shared) # DEFAULT: false # osp.presentation.viewall=true # SAK-15884 enable or disable auto-creation of "Portfolio Admin" worksite # DEFAULT: true # PortfolioAdmin.autocreate=false # SAK-17598: Allow free-form portfolio presentations to be disabled # DEFAULT: true # osp.freeform.disabled=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_tab_title, prefs_noti_title, prefs_timezone_title, prefs_lang_title # preference.pages=prefs_tab_title, prefs_noti_title, prefs_timezone_title, prefs_lang_title, prefs_privacy_title # Should research/collab specific preferences (no syllabus) be displayed? # DEFAULT: false. # prefs.research.collab=true # SAK-23582: Should we use the Fluid drag-and-drop component for organizing user tabs? # Note that in 2.9.2 and below, this was controlled by the portal.use.dhtml.more property. # prefs.tabs.dragdrop=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) # DEFAULT: true # 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 gallery feature? (true/false) # DEFAULT: true # profile2.gallery.enabled=true # Enable/disable the messaging feature? (true/false) # DEFAULT: true # profile2.messaging.enabled=true # Allow status updates and display? (true/false) # DEFAULT: true # profile2.profile.status.enabled=false # 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 ######################################### # 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 # 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 # COPYRIGHT TYPES # 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 # ALTERNATELY, define copyright.types as a comma separated list of values to use # copyright.types=public_domain,hold_copyright,have_permission,not_determined,use_below,fair_use # Use the Creative Commons dialog instead of the "old" copyright dialog # DEAFULT: null (not set) # copyright.use_creative_commons=true ## NOTE: these copyright properties may not be valid anymore - 8 Sept 2011 # default.copyright=Copyright status is not yet determined. # default.copyright.alert=true # fairuse.url=http://fairuse.stanford.edu # newcopyrightinput=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 the default sort column in the roster - one of ( sortName | role | email | displayId ) # DEFAULT: sortName. # roster.defaultSortColumn=sortName # Whether to render the email column for the roster view # DEFAULT: true # roster_view_email=false ## 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. # 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 # 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 # 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: false # site.setup.import.addmissingtools=true # SAK-27580: Ability to disable site creation notification that goes to the site creator # DEFAULT: true # site.setup.creation.notification = false # 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 # Show the menu option for duplicate site # DEFAULT: true # site.setup.allowDuplicateSite=false ### 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 ### SAK-23567 Flexible way to shorten site title in tabs ## Max length for site title display # DEFAULT: 25 characters # site.title.maxlength=25 ## Abbreviation method for site title display # Examples: # 0:100 display the last site.title.maxlength characters and the separator string at the beginning # 50:50 display first site.title.maxlength*50% characters the separator string and the last site.title.maxlength*50% # DEFAULT: 100:0 (display the first {site.title.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 ### 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 ## TEST & QUIZZES (SAMIGO) # Samigo File Upload question type settings default settings: # DEFAULT: 1024 # samigo.sizeThreshold=512 # DEFAULT: 40960 # samigo.sizeMax=20480 # DEFAULT: true # samigo.saveMediaToDb=false # 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/ # 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 editable. # 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: true (show) # samigo.showAssessmentTypes=false # 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: true #samigo.question.show.extendedmatchingitems=false # 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 ######################################### # 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, # not stealthed and not hidden, show the link. This it the helper name. # DEFAULT: "sakai-site-manage-group-section-role-helper" # the older version of group helper which is not section/role aware is named:"sakai-site-manage-group-helper" # wsetup.group.helper.name= # DEPRECATED - set {wsetup.group.helper.name} # DEFAULT: {wsetup.group.helper.name} # wsetup.groupHelper= # Auto-add synoptic tools to Home (SAK-16747) for default and course sites # wsetup.home.toolids.count=5 # wsetup.home.toolids.1=sakai.iframe.site # wsetup.home.toolids.2=sakai.synoptic.announcement # wsetup.home.toolids.3=sakai.summary.calendar # wsetup.home.toolids.4=sakai.synoptic.messagecenter # wsetup.home.toolids.5=sakai.synoptic.chat # wsetup.home.toolids.course.count=5 # wsetup.home.toolids.course.1=sakai.iframe.site # wsetup.home.toolids.course.2=sakai.synoptic.announcement # wsetup.home.toolids.course.3=sakai.summary.calendar # wsetup.home.toolids.course.4=sakai.synoptic.messagecenter # wsetup.home.toolids.course.5=sakai.synoptic.chat # SAK-14210 - Enable tracking of membership changing, a lot more events # DEFAULT: false # wsetup.track.membership.change=true # SAK-23555 - Enabling tracking of roster changing, a lot more events # DEFAULT: false # wsetup.track.roster.change=true # SAK-23652 - Make it easier to change the size of the section fields in Site Info # DEFAULT: 8 # wsetup.sectionfield.required_fields_subject.max=## # DEFAULT: 3 # wsetup.sectionfield.required_fields_course.max=## # DEFAULT: 3 # wsetup.sectionfield.required_fields_section.max=## # SAK-20923 - Option to disable authoirzer (and email for authorizer) when creating a new site # DEFAULT: true # wsetup.requireAuthorizer=false # Defines the sites with non-editable title (by site type) # Replaces old titleEditableSiteType property (which is no longer used) # Example: course - course sites will have read only title. # Set as empty "site.type.titleNotEditable=", every site title would be modified. # DEFAULT: course # site.type.titleNotEditable=course # configuration param for showing/hiding "Import From Site with Clean Up" # DEFAULT: true (show menu option) # clean.import.site=false # Course site type string # DEFAULT: course # courseSiteType=course # Type strings that are associated with course site type. # The following is an example of site type settings, which defines two strings as "course"-type # courseSiteType.count=2 # courseSiteType.1=course # courseSiteType.2=course2 # **WARNING: because courseSiteType is explicitly used to define the "Course site type string", do not use the alternate form # here (comma separated list), as you can cause bad behaviors for operations using the above "courseSiteType" property. # Type strings that are associated with portfolio site type. # DEFAULT: none # portfolioSiteType.count=1 # portfolioSiteType.1=portfolio # ALTERNATELY, define portfolioSiteType as a comma separated list of values to use # portfolioSiteType=portfolio # Project site type strings # DEFAULT: none # projectSiteType.count=1 # projectSiteType.1=project # ALTERNATELY, define projectSiteType as a comma separated list of values to use # projectSiteType=project # Types of sites where site view roster permission is editable # DEFAULT: project (in kernel.properties) # editViewRosterSiteType.count=1 # editViewRosterSiteType.1=project # ALTERNATELY, define editViewRosterSiteType as a comma separated list of values to use # editViewRosterSiteType=project,portfolio ## Site browser # The type of site to search by term (typically "course"). # DEFAULT: none (null) # sitebrowser.termsearch.type=course # The site property to use when searching by term # DEFAULT: none (null) # sitebrowser.termsearch.property=term_eid # A type of site to exclude from site search results. "My Workspace" sites are excluded whether or not this is set. # DEFAULT: none (null) # sitesearch.noshow.sitetype=portfolioAdmin # ICONS # The list of iconNames, iconUrls, and iconSkins must all be the same length and all three must be defined to use this # Offer a list of Appearance (Icon) choices (course sites only) # DEFAULT: none (null) # iconNames.count=4 # iconNames.1=*default* # iconNames.2=humanities # iconNames.3=engineering # iconNames.4=pig # ALTERNATELY, define iconNames as a comman separated list of values # iconNames=*default*,humanities,engineering,pig # URL to the images to use for the icons matching the name and skin # DEFAULT: none (null) # iconUrls.count=4 # iconUrls.1= # iconUrls.2=/library/icon/humanities.gif # iconUrls.3=/library/icon/engineering.gif # iconUrls.4=/library/icon/pig.gif # ALTERNATELY, define iconUrls as a comman separated list of values # iconUrls=,/library/icon/humanities.gif,/library/icon/engineering.gif,/library/icon/pig.gif # Skin matching the iconName and iconUrls # DEFAULT: none (null) # iconSkins.count=4 # iconSkins.1= # iconSkins.2= # iconSkins.3= # iconSkins.4=examp-u # ALTERNATELY, define iconSkins as a comman separated list of values # iconSkins=,,,exam-u ## WYSIWYG EDITOR # Specify the wysiwyg editor for most of Sakai # **NOTE: Experimental Feature 2.8.0 # DEFAULT: none (null) - kernel.properties defines this as FCKeditor # wysiwyg.editor=ckeditor # Enable the twinpeaks feature in the WYSIWYG editor in legacy tools. # DEFAULT: false # wysiwyg.twinpeaks=true # ######################################################################## # UPGRADE # ######################################################################## # Calendar 2.5.x Upgrade Flags # Enable/disable all aspects of the SAK.11204 upgrade -- should be set to true following initial upgrade and initial boot of Sakai for efficiency # DEFAULT: false # sak11204.disable=false # enable/disable forced upgrade (if true, upgrade is always run, if false, upgrade is run only if query results find null RANGE_START/RANGE_END fields) # DEFAULT: false # sak11204.forceupgrade=false # ######################################################################## # Notification Preferences # ######################################################################## # prefs.tool.order.count=6 # prefs.tool.order.1=sakai.announcements # prefs.tool.order.2=sakai.resources # prefs.tool.order.3=sakai.syllabus # prefs.tool.order.4=sakai.mailbox # prefs.tool.order.5=osp.matrix # prefs.tool.order.6=osp.wizard # Comma seperated list of tools to hide. # NOTE: Unavailable tools are: the stealth tools plus the hidden tools, minus the visible ones # DEFAULT: none (null) # prefs.tool.hidden= # prefs.type.order.count=3 # prefs.type.order.1=portfolio # prefs.type.order.2=course # prefs.type.order.3=project # prefs.type.autoExpanded=portfolio ## SAK/26036/SAK-21369/KNL-697 - IE Compatibility because of future IE issues in Sakai # DEFAULT for trunk: none (null) - no header included # DEFAULT for 10.x: IE=EmulateIE11 - Emulate IE11 # For 2.9 recommended to set IE=EmulateIE10 # For 2.8 recommended to set IE=EmulateIE9 # To turn off emulation (none) set the value edge as mentioned below # Example headers below #sakai.X-UA-Compatible=IE=8;FF=3;OtherUA=4 # Have IE emulate IE9 #sakai.X-UA-Compatible=IE=EmulateIE9 # Have IE emulate IE9 #sakai.X-UA-Compatible=IE=EmulateIE11 # No IE emulation #sakai.X-UA-Compatible=edge #Note, this does not effect all content only that passed through RequestFilter #For some content you may need to add the following similar Sakai property #response.headers.count=1 #response.headers.1=X-UA-Compatible::IE=EmulateIE11 ## SAK-20928 - set max number of messages chat will return to the user interface(defaults to 100) #messagesMax@org.sakaiproject.chat2.model.impl.ChatManagerImpl=500 # ######################################################################## # WAREHOUSE # ######################################################################## # The configurable properties are read from dbloader.xml (see warehouse). These settings will override the values in the xml config. # DEFAULTS: (from dbloader.xml) # sakai.datawarehouse.dbLoader.properties.alterTables= # sakai.datawarehouse.dbLoader.properties.createTables= # sakai.datawarehouse.dbLoader.properties.createTableScript= # sakai.datawarehouse.dbLoader.properties.dropTables= # sakai.datawarehouse.dbLoader.properties.indexTables= # sakai.datawarehouse.dbLoader.properties.populateTables= # sakai.datawarehouse.dbLoader.properties.tableScriptFileName= # ######################################################################## # Reset Password # ######################################################################## # Role that can use the password reset tool by default. # guest users are ones that are created by Site Info when adding external participants. # registered users are ones the are created by the New Account tool on the Gateway site. # DEFAULT: guest # resetRoles=guest,registered # resetAllRoles allows this to work for any roles in the system (overrides resetRoles above) # DEFAULT: false # resetPass.resetAllRoles=true # If set to false then password reset users get sent a new email, otherwise they get a link to allow # them to reset their password. This prevents people from changing password they don't own. # DEFAULT: false # siteManage.validateNewUsers=true # ######################################################################## # SSP Early Alert integration # ######################################################################## # Allow Early Alerts integration? # DEFAULT: false # ssp.allowed.alerts=true # URL to the SSP server # DEFAULT: "" # ssp.server.url=http://ssp.unicon.net/ssp-platform/sso # Shared password between SSP and Sakai # ssp.alerts.shared.password=********* # roles allowed to have SSP Early Alerts # DEFAULT: access,Student # ssp.allowed.alert.roles=access,Student ## SAK-21406 - Additional user attributes # user.additional.attribute.count=3 # user.additional.attribute.1=att1 # user.additional.attribute.2=att2 # user.additional.attribute.3=att3 # user.additional.attribute.display.att1=Attribute 1 # user.additional.attribute.display.att2=Attribute 2 # user.additional.attribute.display.att3=Attribute 3 ## SAK-15769 Make 'My Active Sites' always display, even if there is no site overflow # DEFAULT: false # portal.always.display.active_sites=true ## SAK-7802 - Add clock to interface # DEFAULT: true # portal.show.time=false ## SAK-15887 - Creation of citationsAdmin configurable # DEFAULT: true # citationsAdmin.autocreate = true ## SAK-22297 - Configure the default number of citations on a page # DEFAULT: 50 # citations.default.list.page.size = 50 #### KNL-640 ## Use the raw redirecting code in RequestFilter.java. The end result is pretty simple, and you can ## actually host it on just 1 app node if you have multiple domain names pointing to it from Apache ## Turns on the functionality # DEFAULT: false # content.separateDomains=true # The FQDN of the Resources Domain in your environment. # DEFAULT: none (null) # content.chs.serverName=files.sakaiapp.org # The full schema and domain name for constructing URLs in your environment # DEFAULT: none (null) # content.chs.serverUrl=http://files.sakaiapp.org # These are the configured defaults, so no reason to override unless you intend to change them # content.login.urlprefixes.count = 4 # content.login.urlprefixes.1 = /access/login # content.login.urlprefixes.2 = /sakai-login-tool # content.login.urlprefixes.3 = /access/require # content.login.urlprefixes.4 = /access/accept # These are the configured defaults, so no reason to override unless you intend to change them # content.chs.urlprefixes.count = 2 # content.chs.urlprefixes.1 = /access/ # content.chs.urlprefixes.2 = /web/ # Exceptions to the content.chs.urlprefixes patterns # These are the configured defaults, so no reason to override unless you intend to change them # content.chsexception.urlprefixes.count = 3 # content.chsexception.urlprefixes.1 = /access/calendar/ # content.chsexception.urlprefixes.2 = /access/citation/export_ris_sel/ # content.chsexception.urlprefixes.3 = /access/citation/export_ris_all/ #### END KNL-640 ## Soft site deletion. # If enabled, sites that are deleted will be inaccessible to normal users but won't be deleted immediately, in case they need to be recovered. # You also need to set the gracetime value, in days. After this period, the softly deleted sites will be hard deleted. Defaults to 30 days. # There is a Quartz job that must be configured to run periodically (once per day or so) to expunge those sites. # site.soft.deletion=true # site.soft.deletion.gracetime=30 ## SAK-22920 # Use this to configure the size of the map used to store client heartbeats. The initial capacity should be set # to the number of app servers in your cluster times the max number of threads per app server (the maximum # concurrent requests it can serve). For more guidance on how this should be set, look at the Javadocs for # ConcurrentHashMap. # portalchat.heartbeatmap.size= ## SAK-22867 - User type selector # Default is legacy behavior: text box and no user type dropdown # Setting the user.type.selector array will change the selector into an HTML select (dropdown) # user.type.selector.count=3 # user.type.selector.1=registered # user.type.selector.2=maintain # user.type.selector.3=guest ## SAK-22703 - Optionally group subsites into flyout menu # The flyout subsites menu is off by default. Grouping the subsites into a flyout menu can be very # useful if you have a wide and shallow site hierarchy. To turn it on, set the following property to true. # DEAFULT: false # portal.showSubsitesAsFlyout=true # ######################################################################## # MSGCNTR # ######################################################################## ## MSGCNTR-584 - Need property to control display of profile pic feature displays user profile images and info next to the user's posts # DEFAULT: true # msgcntr.forums.showProfileInfo=true # msgcntr.messages.showProfileInfo=true # When creating topics in forums, this setting can default the permission section as collapsed to save screen space. # DEFAULT: false # mc.collapsePermissionPanel=true # Disable the long description text area. # DEFAULT: false # mc.disableLongDesc=true # Include a copy of the message to the recipient by default. Works in conjunction with user preference. # DEFAULT: false # mc.messages.ccEmailDefault=true # Show/render the forum title/link in the navigation # DEFAULT: true # mc.showForumLinksInNav=false # Show/render the short description of a forum. # DEFAULT: true # mc.showShortDescription=false # **NOTE: This is true by default and the code doesn't handle anything but setting the value to true, so all other settings are ignored. # DEFAULT: true # mc.threadedview=false # Mark threads as read automatically # DEFAULT: false # msgcntr.forums.default.auto.mark.threads.read=true # Disable the synopotic view of the forums # DEFAULT: false # msgcntr.synoptic.disable.forums=true # Disable the message display in the synopotic display # DEFAULT: false # msgcntr.synoptic.disable.messages=true # By default, the job to update/add only happens when the counts for forums or messages isn't 0, settting this true # overrides that and forces updates for all items no matter what. # DEFAULT: false # msgcntr.synoptic.updateMessageCounts.addItemsWhenNoUnreadCounts=true # Dfeault behavior is to update the synoptic tool for all users. # DEFAULT: false # msgcntr.synoptic.updateMessageCounts.updateNewMembersOnly=true # Allows an implementation to set a default preference for the "watch" notification email functionality introduced in 2.7 # Possible values: 0=email_none, 1=email_reply_to_my_message, 2=email_reply_to_any_message # DEFAULT: 1 # mc.notificationDefault=1 # Specify the size of the CK Editor in Forums. # DEFAULT: 22 # msgcntr.editor.rows=10 # SAK-24862 Option to Import Start & End Dates for Forums # DEFAULT: true # msgcntr.forums.import.openCloseDates=true # SAK-24854 Maxsize of the rankimage for image ranks # DEFAULT: 102400 # msgcntr.forum.rankimage.maxsize=102400 # SAK-24778 Remove all deleted messages from user display # DEFAULT: false # msgcntr.forums.exclude.deleted=true # SAK-24618 Remove deleted messages from display if message has no descendants # DEFAULT: true # msgcntr.forums.exclude.deleted.onlywithoutdescendant=false ## SAK-19178 # Should we load the initial jobs on startup. # - "init" will schedule the jobs *only* on the first startup of Sakai. # SchedulerManagerImpl determines if this is the initial startup by checking for the absence of the QRTZ_TRIGGERS table. # - "true" will schedule the jobs on every startup. # DEFAULT: init # scheduler.loadjobs=init # Interval to run the scheduler (in seconds) # DEFAULT: 600 (10 minutes) # jobscheduler.invocation.interval= # SAK-13776 # Start or stop the job scheduler on this node # DEFAULT: true #startScheduler@org.sakaiproject.api.app.scheduler.SchedulerManager=false # SAK-20885 # Property name for the default quartz file (in classpath) # DEFAULT: quartz.properties #qrtzPropFile@org.sakaiproject.api.app.scheduler.SchedulerManager=quartz.properties # Property name for the default sakai quartz override (in sakai home) # Place this file in your Sakai home to override the quartz properties (You don't need to specify this property if you just use the default name)! # DEFAULT: sakai.quartz.properties #qrtzPropFileSakai@org.sakaiproject.api.app.scheduler.SchedulerManager=sakai.quartz.properties ## SAK-23597 # portal.title.shortdescription.show=false ## SAK-23737 - User types allowed to bypass password validation when editing account details # An empty list (no property set) indicates that all types require password validation (default behavior) # Which user types are provided and will therefore be allowed to bypass the password validation step # user.type.provided.count=2 # user.type.provided.1=asdf # user.type.provided.2=qwerty ######################################## ## POLLS ######################################## # Display Google Chart of poll results (POLL-138) # DEFAULT: false # poll.results.chart.enabled=true # Do not show instructor the public access options by default (SAK-25399) # DEFAULT: false # poll.allow.public.access=true ######################################## ## REVIEW ######################################## # Whether or not to override the existing review permissions with those set in review.permissions.map. If set to true, only the permissions set in review.permissions.map will be set. # If set to false, the permissions set in review.permissions.map will be set in addition to any existing permissions. # review.permissions.override # A list of site types (portfolio, course, project, etc.) for which the permission map should be used. # Each numbered instance of this variable should have a corresponding siteTypes and value option. # For example, if review.permissions.map.1 is set, at a minimum review.permissions.map.1.siteTypes, glossary.permissions.map.1.value.count and review.permissions.map.1.value.1 must be set. # A list of site types (portfolio, course, project, etc.) for which the permission map should be used. # review.permissions.map.{number}.siteTypes # A list of the actual permissions that should be assigned to the role specified in review.permissions.{number}. # review.permissions.map.{number}.value ## SITESTATS # This property helps the stats tool determine the type of db. If set to "internal" (no quotes) or left unset, then system # will pull the hibernate.dialect property to figure out the DB type (oracle, mysql, hsql). # If set to any other value, the system will pull the sitestats.externalDb.hibernate.dialect to figure the db type. # DEFAULT: internal # sitestats.db= # Used when sitestats.db is set to external (or any value which is not "internal"). Indicates the external stats db type # DEFAULT: org.hibernate.dialect.HSQLDialect # sitestats.externalDb.hibernate.dialect=org.hibernate.dialect.HSQLDialect # Enable debug logging in site stats tool # DEFAULT: false # sitestats.debug=true # STAT-61 : Server-wide stats are enabled by default in Sakai 10+ # serverWideStatsEnabled@org.sakaiproject.sitestats.api.StatsManager=true ## VIRUS SCAN # Provide virus scanning to email msgs & byte arrays using ClamAV software # DEFAULT: false # virusScan.enabled=true # virusScan.host= # virusScan.port= ## RWIKI # Whether or not to enable the Rwiki tool. # DEFAULT: false # wiki.experimental=true # Whether or not to allow comments in the Rwiki tool # DEFAULT: true # wiki.comments=false # Display the user ids in the wiki tool # DEFAULT: false # wiki.display.user.id=true # Allow full search in the wiki - search.enable must also be set to true # DEFAULT: true # wiki.fullsearch=false # Maximum string size for a reference # DEFAULT: 4000 # wiki.maxReferences=2000 # Whether or not to enable notification for the Rwiki tool. # DEFAULT: true # wiki.notification=false # Whether or not to track wiki page views in the event tracking table. # DEFAULT: false # wiki.trackreads=true # The name of the default wiki home page # DEFAULT: Home # wiki.ui.homepage= # Adds ability to turn off automatic "promotion" to provided user that was implemented in KNL-403: # If a user is added manually to a course site (non-provided) and the user subsequently appears in a provider group with the # same role, then the user's site membership should be promoted to provided. # DEFAULT: true # promoteUsersToProvided@org.sakaiproject.authz.api.AuthzGroupService=false # Comma separated list of permissions that shouldn't be possessed by roles for site joiner. # DEFAULT: site.upd # siteinfo.prohibited_permission_for_joiner_role= ## START LESSONBUILDER # Should instructor content be filtered for dangerous html? false is filtering off. true is filtering on. # If antisamy is enabled, filtering will be done with level low # If antisamy is enabled, explicit filtering levels can also be used: default, none, low, high # May be overridden for one instance of Lessons using an instance property of filterhtml # DEFAULT: true # THIS IS CHANGE FROM RELEASES *BEFORE* tag CLE 2.9.2, which default to false # lessonbuilder.filterhtml=false # Should HTML files be displayed or downloaded? This is separate from the # Sakai default because befor Antisamy Sakai wanted to download, but for Lessons # that didn't make sense. If the kernel says a content type can be shown inline, # and it's not html or xhtml, the file will be displayed. For html or xhtml, # this variable control behavior. THe default is true, which says to display it. # This can be overriden with the allow inine property (SAKAI:allow_inline) on file or folder. # DEFAULT: true, display HTML files # lessonbuilder.inlinehtml=true # Historical interest only: Control whether a link to edit quizes is shown in # the dialog. Starting with Sakai 2.8.1 the necessary feature was present in # Sakai by default, so there should be no reason to set this explicitly # DEFAULT: true for Sakai 2.8.1 or later, else false # lessonbuilder.samigo.editlink=true # Add certain BLTI tools to the "add content" menu, so they appear to be # native Sakai tools. # DEFAULT: no native tools # lessonbuilder.blti_tools.count = 0 # This is a property with multiple values. Here's a typical example: # lessonbuilder.blti_tools.count = 1 # lessonbuilder.blti_tools.1 = 14,"VoiceThread Assignment","Assignment using VoiceThread, a cloud-based application that allows students to comment on videos, using audio, video or text", "Add a new VoiceThread assignment","Use this link to add a new VoiceThread assignment to your site. The first time you click on it, it will let you go into VoiceThread's assignment builder to design the assignment" # The entries are: # LTI tool ID. See below # Title - will appear in Add Content as the main title, and as the main header in the chooser dialog # Description - will appear in Add Content as the description, and the first thing in the chooser dialog # Link text - this will be the text of the link for adding a new item # Link explanation - this will appear in the chooser dialog under the link, as a further explanation of how the tool works. It is displayed verbatim, so you can include HTML markup. (That's not true of the other fields.) # Unfortunately the only unambiguous identifer for a BLTI tool is the tool ID. But it doesn't show in any obvious way in the UI. As Administrator, go into the "External tool" administrative screen. Choose "Tools available in system." Find the tool you want to use. Do "inspect element" on the Edit link. You'll see an argument id=NNN at the end of the URL. That's the tool ID. # Put folders created by Lessons inside a single base folder. # If you upload files through Lessons, Lessons will put them in folders that Lessons creates. # It creates one folder per Lessons page, named with the title of the page. # This property adds a single top-level folder in which all the per-page folders are put # A typical value would be lessonbuilder.basefolder=Lessons # DEFAULT: no base folder # lessonbuilder.basefolder missing # Cause Lessons to hide the top-level folder it creates. It basefolder is # set, that's the folder that will be hidden. If not, the individual folders # created for each page will be hidden. # DEFAULT: false # lessonbuilder.folder.hidden=false # Allow an institution to configure the name of the default CSS file. This file # can be supplied by the user to set site-specific CSS for Lessons. The file # can be overriden for a specific page in the UI. The file is normally # LB-CSS/default.css within site resources. There can be a site-wide default # at public/LB-CSS/default.css. This variable will replace default.css # with another name, presumably localized. # DEFAULT: default.css # lessonbuilder.default.css=default.css # All site to disable project /direct/lessons. Default is to enable it # DEFAULT: true, allow /direct/lessons # lessonbuilder.keitai=true # Control icons. Lessons has its own icons for some content type. # This property will cause Lessons to use normal Sakai icons for all types # DEFAULT: false, use special Lessons icons # lessonbuilder.use-sakai-icons=false # Control whether links can be attached in the file picker # DEFAULT: true # lessonbuilder.attachlinks=true # Contrrol whether an the options dialog includes a link that will allow # the user to remove all pages not referred to by another page. Normally # this is not needed, as pages can be deleted from the index of pages. However # we had a pathological site with thousands of pages that needed to be deleted. # It was not practical to do that through the index of pages. We recommend # leaving this off unless you have a case like that. # DEFAULT: false, do not show command to let user delete all unattached pages at once # lessonbuilder.delete-orphans=false # configure ist of file ttypes that should be recognized as HTML if the mime type doesn't show it as HTML or XHTML # DEFAULT: html,xhtml,htm,xht # lessonbuilder.html.types=html,xhtml,htm,xht # configure list of mime types that should be displayed using the MP4 player if HTML5 is not available # DEFAULT: video/mp4,video/m4v,audio/mpeg # lessonbuilder.mp4.types=video/mp4,video/m4v,audio/mpeg # configure list of mime types that should be displayed with HTML5 video or audio # DEFAULT: video/mp4,video/m4v,video/webm,video/ogg,audio/mpeg,audio/ogg,audio/wav,audio/x-wav,audio/webm,audio/ogg,audio/mp4,audio/aac # lessonbuilder.html5.types=video/mp4,video/m4v,video/webm,video/ogg,audio/mpeg,audio/ogg,audio/wav,audio/x-wav,audio/webm,audio/ogg,audio/mp4,audio/aac # configuration location of folder with Lessons' builtin help files # these files are normaly in tomcat/webapps/lessonbuilder-tool/templates/instructions/ # the file name specified in this property is an absolute path in the host file eystem # DEFAULT: help files are in tomcat/webapps/lessonbuilder-tool/templates/instructions/ # lessonbuilder.helpfolder missing # Show the item dropdowns in the page index view. # DEFAULT: true # lessonbuilder.enable-show-items=false # Allow Instructor to do a Common Cartridge Export from Lessons # DEFAULT: true # lessonbuilder.cc-export=false ## END LESSONBUILDER ## ACCOUNTVALIDATOR # Password validation based on: verifyPasswordStrength() in # http://grepcode.com/file/repo1.maven.org/maven2/org.owasp.esapi/esapi/2.0_rc10/org/owasp/esapi/reference/FileBasedAuthenticator.java # DEFAULT: false # account-validator.validate.passwords=true # DEFAULT: 16 # account-validator.minimum.password.entropy=16 # If you don't want to use ui.service as the Production name, use: # DEFAULT: {ui.service} value # reset-pass.productionSiteName= # Sets the token expiration days; this property will be overridden by accountValidator.maxReminderDays if present # DEFAULT: 90 # accountValidator.maxDays= # Sets the max number of resends before it expires the token # DEFAULT: 10 # accountValidator.maxResendAttempts= # Sets the 'from' email address and name for password reset emails (if not set, falls back to mail.support) # accountValidator.checkValidations.fromEmailAddress= # accountValidator.checkValidations.fromEmailName= # Sets the maximum number of days for reminders; overrides accountValidator.maxDays # accountValidator.maxReminderDays= # Sets the maximum TTL for reset password validation token in minutes # accountValidator.maxPasswordResetMinutes= ## NOTE: All properties in this files should be commented out AND should include a comment indicating the default value and a sample value # SAK-21398 # Chat delivery expiration (in seconds). Default is 300 seconds (5 minutes) #chat.delivery.ttl=300 # Courier maint thread run interval (in seconds). 0 means won't run. Default is 300 seconds #courier.maintThreadChecks=300 # Courier maint thread aggressiveness. True means the entire address will be removed. # False means only the expired delivery will be removed. # Default is false #courier.aggressiveCleanup=false # END SAK-21398 #SAK-25272 # Default value for the notifications in announcements (r=high, o=optional, n=none) #announcement.default.notification=r #INFRSTR-257 - Delegated Access #delegatedaccess.hierarchy.site.properties #This property allows you to overwrite the default site hierarchy properties expected in a Site. #Example: #delegatedaccess.hierarchy.site.properties.count=3 #delegatedaccess.hierarchy.site.properties.1=School #delegatedaccess.hierarchy.site.properties.2=Department #delegatedaccess.hierarchy.site.properties.3=Subject #delegatedaccess.toolslist #This property allows you to specify a list of tools you want to be able to select in the \u00e2\u0080\u009cRestrict Tools\u00e2\u0080\u009d list. Each tool is specified individually. #Example: #delegatedaccess.toolslist.count=4 #delegatedaccess.toolslist.1=sakai.gradebook.tool #delegatedaccess.toolslist.2=sakai.resources #delegatedaccess.toolslist.3=sakai.samigo #delegatedaccess.toolslist.4=sakai.announcements #delegatedaccess.toolslist.sitetype #This property allows you to choose a site type which the \u00e2\u0080\u009cRestrict Tools\u00e2\u0080\u009d list will be populated from. #Example: #delegatedaccess.toolslist.sitetype=course #Setting term field #delegatedaccess.termfield #This property allows you to choose what the term field property is for your sites. #The default term field is "term_eid". If you don't use that property name, you will need #to set this to the name you do use. #This field will be used for searching as well as displaying term options in the list of terms #Example: #delegatedaccess.termfield=term #delegatedaccess.term.useCourseManagementApi #If you don't use Course Management API for your terms, you will want to set this to false. #Default is true #When true: The term list options are gathered from the Course Management API #When false: A site property query will be used to find the distinct list of terms based on the term property set (delegatedaccess.termfield) #Example: #delegatedaccess.term.useCourseManagementApi=false #delegatedaccess.hometools #If you want to include the Home Tool in the list of restricted tools, then you will need to set this property to the #list of all possible home tools #Example: #delegatedaccess.hometools.count=4 #delegatedaccess.hometools.1=sakai.iframe.site #delegatedaccess.hometools.2=sakai.synoptic.announcement #delegatedaccess.hometools.3=sakai.synoptic.chat #delegatedaccess.hometools.4=sakai.synoptic.messagecenter #delegatedaccess.realmoptions.shopping #This field allows you to set the realm options in the edit shopping period page #Default is !site.* #Example: #delegatedaccess.realmoptions.shopping.count=2 #delegatedaccess.realmoptions.shopping.1=!site.template.course #delegatedaccess.realmoptions.shopping.2=!site.template.portfolio #delegatedaccess.roleoptions.shopping #This field alows you to set the role options in the edit shopping period page #It will filter all roles except these for all realmoptions #Example: #delegatedaccess.roleoptions.shopping.count=2 #delegatedaccess.roleoptions.shopping.1=Instructor #delegatedaccess.roleoptions.shopping.2=access #Note, if there is only one option for realm and one option for role, then the "User Becomes" column will #be hidden and all access will default to that realm/role. #delegatedaccess.realmoptions.delegatedaccess #This field allows you to set the realm options in the edit users page #Default is !site.* #Example #delegatedaccess.realmoptions.delegatedaccess.count=1 #delegatedaccess.realmoptions.delegatedaccess.1=!site.template.course #delegatedaccess.roleoptions.delegatedaccess #This field allows you to set the role options in the edit users page. #It will filter all roles except these for all realmoptions #Example #delegatedaccess.roleoptions.delegatedaccess.count=1 #delegatedaccess.roleoptions.delegatedaccess.1=Instructor #delegatedaccess.root.title #This property allows you to set the root title of your hierarchy #Default is based on the ui.service property, if not set, then "Sakai" #Example: #delegatedaccess.root.title=My Root Title #delegatedaccess.email.errors #This property enables emails to be sent to the address specified when an #error occurs in a high level situation (like a job process failure) #Example: #delegatedaccess.email.errors=noreply@sakai.com #delegatedaccess.shopping.instructorEditable #This property allows instructors to edit their shopping period dates and access information. False by default. #You will see the interface in Site Info -> Manage Access #Example: #delegatedaccess.shopping.instructorEditable=true #delegatedaccess.disable.user.tree.view #False by default. If you set to true, the tree structure will be removed on a delegated access user's landing page. #They will still be able to use the search fields to find their sites. #delegatedaccess.disable.user.tree.view=true #delegatedaccess.disable.shopping.tree.view #False by default. If you set to true, the tree structure will be removed on a shopping tool's landing page. #Users will still be able to use the search fields to find their sites. #delegatedaccess.disable.shopping.tree.view=true #delegatedaccess.term.showLatestXTerms #shows all terms by default. If you want to limit the number of terms that show up in the terms field, #you can set this property to show the latest X number of terms. The order is set depending on the method #you use to gather terms. If you use CourseManagementAPI, then the order is by Start Date. If you do not use #CourseManagementAPI, then the order is set by portal.term.order and any non matching terms are put in last #Example: #delegatedaccess.term.showLatestXTerms=5 #delegatedaccess.sync.myworkspacetool #true by default. This setting will sync a user's MyWorkspace with the Delegated Access tool. Another words, #if the user is granted permissions in the tool, it will add the Delegated Access tool to their My Workspace. #if all the permissions are removed for a user, it will remove the Delegated Access tool from their My Workspace #Example: #delegatedaccess.sync.myworkspacetool=true #delegatedaccess.siteaccess.instructorViewable #false by default. This setting controls whether an instructor can see who has been granted access to their site. #The list of users will show up in "Site Info"->"Manage Access". #Example #delegatedaccess.siteaccess.instructorViewable=true #delegatedaccess.siteaccess.instructorViewable.hiddenRoles #empty by default. Use this setting to restrict certain roles in the Site Info -> Manage Access -> View DA Access table. #Example: #delegatedaccess.siteaccess.instructorViewable.hiddenRoles.count=1 #delegatedaccess.siteaccess.instructorViewable.hiddenRoles.1=Student #delegatedaccess.subadmin.realmrole.order #Create a list of "realm:role;realm:role;" from highest to lowest level of access. #For instance, if you wanted to order the importance of roles #of sakai's default permissions, it would look like: #delegatedaccess.subadmin.realmrole.order.count=3 #delegatedaccess.subadmin.realmrole.order.1=!site.template.course:Instructor;!site.template:maintain; #delegatedaccess.subadmin.realmrole.order.2=!site.template.course:Teaching Assistant #delegatedaccess.subadmin.realmrole.order.3=!site.template.course:Student;!site.template:access; #This will only allow subadmin to assign permissions at their level and below. #Any realm/role that isn't in that list will be considered the last level on the bottom. #If this isn't set, then all options will be available to any sub admin. #delegatedaccess.enable.active.site.flag #false by default. If you want to use this feature, you must apply the patch to jobscheduler attached in #https://jira.sakaiproject.org/browse/DAC-40. The job will populate a table which DA will lookup #to determine whether a course is active or not and display a warning in the site search is its inactive #ex. #delegatedaccess.enable.active.site.flag=true #delegatedaccess.allow.accessadmin.set.allowBecomeUser #DAC-57 Add new permission to allow user to become users within their delegated access #This property controls whether an "Access Admin" will have the ability to set the advanced option permission: allowBecomeUser #Note, requires SAK-23829 and DAC-57 #default true #ex. #delegatedaccess.allow.accessadmin.set.allowBecomeUser=false #delegatedaccess.enableProviderIdLookup #false by default. If you set this to true, the search results table in Delegated Access site search will have #an extra column to "lookup roster". This will show you the "provider id" for that site's realm. #ex. #delegatedaccess.enableProviderIdLookup=true #delegatedaccess.search.hideTerm #false by default. If you set this to true, then the term dropdown option in the search fields will be removed. #This is useful if you already have term in your hierarchy and you don't want term listed twice in the search #fields #ex. #delegatedaccess.search.hideTerm=true #delegatedaccess.search.hierarchyLabel.{hierarchyLevel} #This allows you to set labels for your hierarchy search options. By default it will use the hierarchy level, but you can #override this by setting the label. For example: #Hierarchy = school->dept->subj #delegatedaccess.search.hierarchyLabel.school=School #delegatedaccess.search.hierarchyLabel.dept=Deptartment #delegatedaccess.search.hierarchyLabel.subj=Subject #Suggested Additional Properties: #https://jira.sakaiproject.org/browse/SAK-13778 #siteinfo.prohibited_role.count=2 #siteinfo.prohibited_role.1=.anon #siteinfo.prohibited_role.2=.auth #portal.term.order (Should be automatic in newer versions if you use CM API) #portal.term.order.count=2 #portal.term.order.1=SPRING_2012 #portal.term.order.2=SUMMER_2012 #jobscheduler.invocation.interval controls the automatic update timing to shopping period settings # ######### # SAK-24423 Additional Joinable Site Settings # ######## #sitemanage.join.joinerGroup.enabled=[true/false] #sitemanage.join.notification.enabled=[true/false] #sitemanage.join.excludeFromPublicList.enabled=[true/false] #sitemanage.join.limitAccountTypes.enabled=[true/false #sitebrowser.join.enabled=[true/false] #sitemanage.join.allowedJoinableAccountTypeCategories (count + list) #sitemanage.join.allowedJoinableAccountTypes (count + list) #sitemanage.join.allowedJoinableAccountTypeLabels (count + list) # SAK-22384 - MathJax. All of these are default to not set. (No default) # You have to specify all of them. # See https://jira.sakaiproject.org/browse/SAK-22384 for more details and a demo. # URL to MathJax.js, you can use the one on the mathjax CDN or put one locally. Currently this is not included with Sakai #portal.mathjax.src.path=http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default,Safe # URL to display linking to more information about mathjax and equations #portal.mathjax.website.url=http://www.mathjax.org # Whether to allow useres to enable or disable MathJAX, this still has to be enabled on a per site basis #portal.mathjax.enabled=true # ###### # Kerberos Provider # ###### # The kerberos configuration file to use if you don't want to use the default. # DEFAULT: null # provider.kerberos.krb5.conf=/etc/krb5.cnf # The kerberos login config file to use for Kerberos JAAS # DEFAULT: null # provider.kerberos.auth.login.config=sakai-jaas.conf # Should debugging information be shown about the config at startup # DEFAULT: false # provider.kerberos.showconfig=true # ##### # SAK-27743 Quartz job to seed sites, users, and resources # ##### # number of course sites to create #site.seed.create.sites=5 # number of registered users to create #site.seed.create.students=100 # how many students to enroll in each site selecting randomly from the users created site.seed.create.students #site.seed.enrollments.per.site=50 # how many instructors are created and added to each site #site.seed.instructors.per.site=1 # the size in bytes of generated content that is randomly added to the sites created site.seed.create.sites #site.seed.repository.size=10485760 # ###################################### # SAK-26283 Unenroll users before delete # ###################################### # user.unenroll.before.delete=true