Configuration & Settings

Many features in Weavy require some configuration settings. The configuration spans multiple areas and most are straight forward, while others needs a bit of explaining.

This article will describe the available configuration settings and the methods you can use for getting and setting them.

Specifying configuration values

All settings are configured through the App Settings schema, which is a predefined configuration section provided by the .NET Framework.

Configuration with web.config

Most commonly, settings are defined within the appSettings element in web.config, but there are also other ways to configure settings.

<appSettings>
  <add key="weavy.smtp-from" value="noreply@weavy.com" />
  <add key="weavy.smtp-server" value="smtp.hostname.com" />
  <add key="weavy.smtp-port" value="25" />
  <add key="weavy.smtp-ssl" value="false" />
  <add key="weavy.smtp-username" value="usr" />
  <add key="weavy.smtp-password" value="pass" />
  <!-- etc -->
</appSettings>

Configuration with settings file

The appSettings element has an optional attribute, file, that can be used to reference a external file that contains the configuration. This is especially useful when you don't want settings to be under source control. In this case the appSettings element will reference a file which could be excluded from source control.

Example web.config, referencing an external settings.config:

<configuration>
  <appSettings file="settings.config" />
</configuration>

Example settings.config:

<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
  <add key="weavy.smtp-server" value="smtp.hostname.com" />
</appSettings>

Configuration in Azure

Azure has mechanisms for configuring appSettings through Application settings. Any settings that are defined here will affetively override what is configured in web.config or in an external file.

If you are hosting your Weavy tenants in Azure, this is the preferred way to manage configuration settings.

Retrieving configuration settings

Use ConfigurationService to retrieve settings. All built-in settings are available as strongly typed properties while custom settings can be retrieved via the AppSetting method.

Built-in settings