Transcript Configuring Sakai from Outside the Web

Configuring Sakai
from Outside the Web Application
Tony Atkins
<[email protected]>
Creative Commons AttributionNonCommercial-ShareAlike 2.5 License
Sakai Programmer's Café
The Default State OOTB




Hypersonic SQL (in memory)
Database storage of binary content (except archives)
No incoming mail
No outgoing mail
2/15
The sakai.properties file



Lives in TOMCAT_HOME/sakai
Stores 250+ settings used by components and tools
Follows the convention of a normal Java Properties
file
3/15
Simple Properties

getString
 A string including spaces but no carriage returns:
stringProperty=a string including spaces


Example in Sakai: server.url
getBoolean
 TRUE or FALSE
booleanProperty=TRUE

Example in Sakai: auto.ddl
4/15
getStrings properties

Anything from a simple list to a full hierarchy of
properties can be represented:
multiProperty.count=3
multiProperty.1=peas
multiProperty.2=porridge
multiProperty.3.count=3
multiProperty.3.1=hot
multiProperty.3.2=cold
multiProperty.3.3=in the pot, nine days old

Example in Sakai: Terms
5/15
Customizing your sakai.properties file








Start with reference/docs/sakai.properties
At a minimum, review and edit:
Database settings
Filesystem settings
Branding
Mail Settings
Optionally review:
Tool Settings
6/15
Database settings:


Uncomment the appropriate block for your
database
Edit the username and password properties
7/15
FileSystem settings




[email protected]
 The location in which binary content will be stored (also disables
storing binary content in the database).
[email protected]
 The location in which site archives will be stored.
[email protected]
 A comma-delimited list of volumes between which binary content
should be distributed
[email protected]
 The maximum amount of content allowed for a single site (in Kb)
8/15
Branding
ui.institution
 The name of your institution
serverId
 The name of this node
serverName
 Our service name
serverUrl
 The full service URL

9/15
Mail Settings





smtp.enabled
 Whether or not to enable incoming mail
[email protected]
 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.
10/15
Tool Settings



[email protected]
 A list of tool Ids that should be hidden from end users.
Provisional tools are hidden by default.
[email protected]
 An additional list of tool Ids that should be hidden from end
users.
[email protected]
 A list of tool Ids that should be visible to end users (overrides
both of the above settings).
11/15
Config Viewer Tool



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
Source
http://source.sakaiproject.org/contrib/config-viewer/
12/15
toolOrder.xml

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
13/15
Configuring toolOrder.xml


Start with the defaults:
component/componentapi/component/src/config/org/sakaiproject/config/t
oolOrder.xml
Copy to TOMCAT_HOME/sakai/toolOrder.xml
14/15
Questions?
15/15