Miscellaneous Dari configuration - Documentation

You can configure the following Dari features in the Tomcat context.xml file, where options are expressed as name-value pairs.

Signed cookies

The following table lists available context.xml configuration values for signed cookies.

Key	Type	Description
dari/cookieSecret	java.lang.String	Used by the JspUtils class to implement secure signed cookies. Enter a reasonably long random string of characters.

Caching filter

The following table lists available context.xml configuration values for caching filters.

Key	Type	Description
dari/isCachingFilterEnabled	java.lang.Boolean	Used by `CachingDatabaseFilter` to create or not create an instance of CachingDatabase.

Mail provider

The following table lists available context.xml configuration values for outgoing mail servers.

Key	Type	Description
dari/defaultMailProvider	java.lang.String	Specifies the default email provider configuration. (For information about default configurations, see Configuration identifiers, key prefixes, and defaults.)
dari/mailProvider/{id}/class	java.lang.String	Mail provider class that implements the MailProvider interface. Set the value to the fully qualified class name. You can specify a custom class or SmtpMailProvider provided with Brightspot. For the default class, replace `{id}` with the value that you set for d`ari/defaultMailProvider`.
dari/mailProvider/{id}/host	java.lang.String	Host on which your mail provider runs. For the default host, replace `{id}` with the value that you set for `dari/defaultMailProvider`.
dari/mailProvider/{id}/port	java.lang.String	Port number on which the outgoing mail server is running. For the default port, replace `{id}` with the value that you set for `dari/defaultMailProvider`.
dari/mailProvider/{id}/username	java.lang.String	Username for the outgoing mail server. For the default username, replace `{id}` with the value that you set for `dari/defaultMailProvider`.
dari/mailProvider/{id}/password	java.lang.String	Password for the outgoing mail server. For the default password, replace `{id}` with the value that you set for `dari/defaultMailProvider`.

The following snippet configures a default outgoing mail server with ID mymailserver.

<Environment name="dari/defaultMailProvider" type="java.lang.String" value="mymailserver" />
<Environment name="dari/mailProvider/mymailserver/class" type="java.lang.String" value="com.psddev.dari.util.SmtpMailProvider" />
<Environment name="dari/mailProvider/mymailserver/host" type="java.lang.String" value="mysmtpserver.amazonaws.com" />
<Environment name="dari/mailProvider/mymailserver/port" type="java.lang.String" value="8080" />
<Environment name="dari/mailProvider/mymailserver/username" type="java.lang.String" value="handsome" />
<Environment name="dari/mailProvider/mymailserver/password" type="java.lang.String" value="evenmorehandsome" />

SMS provider

The following table lists available context.xml configuration values for outgoing SMS services.

Key	Type	Description
dari/defaultSmsProvider	java.lang.String	Specifies the default SMS provider configuration. (For information about default configurations, see Configuration identifiers, key prefixes, and defaults.)
dari/smsProvider/{id}/class	java.lang.String	SMS provider class that implements the SmsProvider interface. Set the value to the fully qualified class name. You can specify a custom class or TwilioSmsProvider provided with Brightspot. For the default class, replace `{id}` with the value that you set for `dari/defaultSmsProvider`.
dari/smsProvider/{id}/accountSid	java.lang.String	Your account ID with the SMS provider. For the default account ID, replace `{id}` with the value that you set for `dari/defaultSmsProvider`.
dari/mailProvider/{id}/authToken	java.lang.String	Authentication token for you SMS account. For the default token, replace `{id}` with the value that you set for `dari/defaultSmsProvide`r.
dari/mailProvider/{id}/defaultFromNumber	java.lang.String	Default “from” number appearing on recipients’ devices. For the default number, replace `{id}` with the value that you set for `dari/defaultSmsProvider`.

The following snippet configures a default outgoing mail server with ID mysmsprovider.

<Environment name="dari/defaultSmsProvider" type="java.lang.String" value="mysmsprovider" />
<Environment name="dari/mailProvider/mysmsprovider/class" type="java.lang.String" value="com.psddev.dari.util.TwilioSmsProvider" />
<Environment name="dari/mailProvider/mysmsprovider/accountSid" type="java.lang.String" value="ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" />
<Environment name="dari/mailProvider/mysmsprovider/authToken" type="java.lang.String" value="myauthenticationtoken" />
<Environment name="dari/mailProvider/mymailserver/defaultFromNumber" type="java.lang.String" value="+15017122661" />

Overriding configuration values

Almost every <environment> element in context.xml includes a Boolean override attribute.

If true, the corresponding setting in the webapp’s web.xml takes precedence over the setting in context.xml.
If false, the setting in context.xml takes precedence over the corresponding setting in the webapp’s web.xml.

For example, the following stanza appears in web.xml.

Configuration in web.xml

<env-entry>
    <env-entry-name>cms/tool/isAutoCreateUser</env-entry-name>
    <env-entry-type>java.lang.Boolean</env-entry-type>
    <env-entry-value>true</env-entry-value>
</env-entry>

The following corresponding element appears in context.xml.

Configuration in context.xml

<Environment name="cms/tool/isAutoCreateUser" type="java.lang.Boolean" value="false" override="false" />

In this scenario, the value false in "Configuration in context.xml" takes precedence over the value in "Configuration in web.xml," because the override attribute is set to false.