Configuring Sakai from Outside the Web Application

1. Configuring Sakai from Outside the Web Application Tony Atkins <tony.atkins@uhi.ac.uk>

2. Hypersonic SQL (in memory) Database storage of binary content (except archives) No incoming mail No outgoing mail The Default State OOTB

3. Lives in TOMCAT_HOME/sakai Stores 250+ settings used by components and tools Follows the convention of a normal Java Properties file The sakai.properties file

4. getString A string including spaces but no carriage returns:stringProperty=a string including spaces Example in Sakai: server.url getBoolean TRUE or FALSEbooleanProperty=TRUE Example in Sakai: auto.ddl Simple Properties

5. Anything from a simple list to a full hierarchy of properties can be represented:multiProperty.count=3multiProperty.1=peasmultiProperty.2=porridgemultiProperty.3.count=3multiProperty.3.1=hotmultiProperty.3.2=coldmultiProperty.3.3=in the pot, nine days old Example in Sakai: Terms getStrings properties

6. Start with reference/docs/sakai.properties At a minimum, review and edit: Database settings Filesystem settings Branding Mail Settings Optionally review: Tool Settings Customizing your sakai.properties file

7. Uncomment the appropriate block for your database Edit the username and password properties Database settings:

8. bodyPath@org.sakaiproject.content.api.ContentHostingService The location in which binary content will be stored (also disables storing binary content in the database). storagePath@org.sakaiproject.archive.api.ArchiveService The location in which site archives will be stored. bodyVolumes@org.sakaiproject.content.api.ContentHostingService A comma-delimited list of volumes between which binary content should be distributed siteQuota@org.sakaiproject.content.api.ContentHostingService The maximum amount of content allowed for a single site (in Kb) FileSystem settings

9. ui.institution The name of your institution serverId The name of this node serverName Our service name serverUrl The full service URL Branding

10. smtp.enabled Whether or not to enable incoming mail smtp@org.sakaiproject.email.api.EmailService The server name that handles outgoing mail smtp.dns.1 The primary DNS server used to look up hosts found in mail. smtp.dns.2 The secondary DNS server used to look up hosts found in mail. smtp.port The port on which James will listen. Mail Settings

11. stealthTools@org.sakaiproject.tool.api.ActiveToolManager A list of tool Ids that should be hidden from end users. Provisional tools are hidden by default. hiddenTools@org.sakaiproject.tool.api.ActiveToolManager An additional list of tool Ids that should be hidden from end users. visibleTools@org.sakaiproject.tool.api.ActiveToolManager A list of tool Ids that should be visible to end users (overrides both of the above settings). Tool Settings

12. A contrib tool Written by Tony Atkins (with much advice from Aaron and Antranig). A compendium of 250+ configuration options with guidelines as to: what each option controls what syntax is expected for each option what tools depend on each option Demo Sourcehttp://source.sakaiproject.org/contrib/config-viewer/ Config Viewer Tool

13. Secondary file that controls: Which tools can be selected for each type of site (overrides other settings) The order in which the tools can be selected for each type of site The tools that are checked by default for each type of site toolOrder.xml

14. Start with the defaults:component/component-api/component/src/config/org/sakaiproject/config/toolOrder.xml Copy to TOMCAT_HOME/sakai/toolOrder.xml Configuring toolOrder.xml

15. Questions?