Configuration in EPiServer Community 3.2
Product version: |
EPiServer Community 3.2 |
---|---|
Document version: |
1.0 |
Document last saved: |
09-01-2008 |
Introduction
This tech note describes the EPiServer Community and EPiServer Common configuration settings in the Web.config file.
Table of Contents
Web.config
To locate the settings for a specific site in Web.Config, scroll to the <episerve.common> section.
<configuration>
...
<episerver.common>
<siteHosts>
<sites>
<site>
...
<site>
</episerver.common>
...
</configuration>
EPiServer.Common configuration
Example of framework section below:
<framework>
<rating maxRating="10" />
<tag>
<archiving interval="23:59:59" maxRelatedTags="5" />
<tagCloud noiseLevel="100" cacheExpiration="00:00:01" minItemWeight="1" maxItemWeight="10" defaultItemCount="150" />
</tag>
<activityLog logLevel="Custom">
<loggedTypes>
<add type="EPiServer.Common.Security.IUser, EPiServer.Common.Framework"></add>
</loggedTypes>
</activityLog>
</framework>
Setting Name |
Property Name |
Description |
|||
---|---|---|---|---|---|
tag | archiving tagCloud |
interval |
|||
rating |
maxRating | Max rating for all entities | |||
activityLog |
logLevel |
Log levels are now set by name instead of number. The different levels are: Full, None, Custom. |
Example of replication section below:
Setting Name |
Property Name |
Description |
|||
---|---|---|---|---|---|
subscriber | serverName |
Should be the name of the web server |
|||
siteName |
The site name |
||||
port |
Must be the same on all web servers in the cluster | ||||
alternatePort |
Must be the same on all web servers in the cluster | ||||
|
broadcastAddress | The the must include all web servers in the cluster. Note that the web servers must reside on the same subnet |
Example of integration section below:<integration>
<session sessionTimeout="00:20:00" timeoutCheckInterval="00:01:00" />
</integration>
Setting Name |
Property Name |
Description |
|||
---|---|---|---|---|---|
session | sessionTimeout |
Sets the timeout for sessions | |||
timeoutCheckInterval |
interval timeout check |
Example of cache section below:<cache defaultProvider="EPiServerCacheExpirationProvider">
<providers>
<add name="EPiServerCacheExpirationProvider" type="EPiServer.Common.Cache.CacheExpirationProvider, EPiServer.Common.Cache" />
</providers>
</cache>
Example of entity section below:
<entity>
<providers />
<supportedTypes />
</entity>
EPiServer.Community configuration
To locate the settings for a specific site in Web.Config, scroll to the <episerver.community> section.
Below are the configuration settings/properties for the Administration section:
Property Name |
Name |
Description |
|||
---|---|---|---|---|---|
administrableTypes |
type |
defines for which type the administration URLs should apply |
|||
administrableTypes |
addUrl |
defines the URLs to where the types can be added |
|||
administrableTypes |
updateUrl |
defines the URLs to where the types can be Updated |
|||
administrableTypes |
windowWidth |
WindowWidth defines the default size of the admin window (applicable for popups) |
|||
administrableTypes |
windowHeight | WindowHeight defines the default size of the admin window (applicable for popups) |
Below are the configuration properties for the moblog section:
Property Name |
Description |
|||
---|---|---|---|---|
msIsdnAttributeName |
The name of the attribute containing a user’s msisdn (mobile phone number). |
Below are the configuration properties for the chat section:
Property Name |
Description |
|||
---|---|---|---|---|
webServiceUrl |
The URL of the web service. Default value is http://localhost |
Below are the configuration properties for the newsfeed section:
Property Name |
Description |
|||
---|---|---|---|---|
aggregationInterval |
How often we should attempt to aggregate user’s minifeeds into newsfeeds visible to their friends. |
|||
aggregationSpan |
Defines the time span within which stories are to be aggregated. |
Below are the configuration properties for the videoGallery section:
Property Name |
Description |
|||
---|---|---|---|---|
pollingIntervalSeconds |
The interval which the CDN should be polled for changes. Returned result may be that a video has been uploaded or a video has been successfully converted into a web friendly format. |
|||
cdnProvider |
This is the customer’s account ID provided to them by EPiServer when they sign up with the Video Gallery service. | |||
cdnProvider |
This is the secret key that is given to the customer by EPiServer The secret key is used to create a signature used as authentication when communicating with the CDN | |||
cdnProvider |
The URL to which videos are uploaded to the CDN. This is by default configured to http://videogallery.episerver.com/upload/ | |||
cdnProvider |
The URL pointing us to the CDN’s webservice. This is by default configured to http://videogallery.episerver.com/VideoGalleryService3.asmx | |||
cdnProvider |
The prefix portion of a video’s URL. Since we store the relative path of the video we use this url prefix to compose a complete URL to where the video file can be found. |
Below are the configuration properties for the forum section:
Property Name |
Description |
|||
---|---|---|---|---|
timeBackForHotTopics |
How far back in time we should look to determine if a topic is considered “hot” – meaning it has a lot of attention. |
|||
minNumberOfTopicRepliesToBeHot |
The number of replies the topic should have had during the above mentioned period of time to be considered “hot”. |
Below are the configuration properties for the ConnectionLink section:
Property Name |
Description |
|||
---|---|---|---|---|
bfsMaxDepth |
The maximum number of connections to follow before giving up. -1 means no limit. |
|||
shortestPathCacheTime |
The expiry time in for the shortest path cache. Time is now represented as a TimeSpan, not only minutes. |
|||
timeoutLock | The timeout for read and write attempts to the graph. |
Below are the configuration properties for the Contact section:
Property Name |
Description |
|||
---|---|---|---|---|
reverseAdd |
Mimic add requests on the receiving end, causing automatic two-way friendships. |
|||
reverseRemove |
Mimic remove requests on the receiving end, causing automatic two-way ending of friendships. |
Below are the configuration properties for the DocumentArchive section:
Property Name |
Description |
|||
---|---|---|---|---|
PhysicalPath | The physical path where to store the documents. | |||
VirtualPath |
The virtual path where to get the documents. |
NOTE: To avoid execution of uploaded files (aspx, asp etc) in IIS manager, change execution rights to none on the public folder specified in the VirtualPath. Another option is to put the files in an inaccessible folder and build a proxy to access these files.
Below are the configuration properties for the Expert section:
Property Name |
Description |
|||
---|---|---|---|---|
autoPublish | If answers should be automatically published after submission. | |||
questionRelationSymmetric | If relations between questions should be kept symmetric when changes occur. | |||
assignmentRecommendedMaxDays | The recommended number of days until an expert should have answered a question. If this time span is exceeded a warning will be displayed. |
Below are the configuration properties for the ImageGallery section:
Property Name |
Name |
Description |
||||||||
---|---|---|---|---|---|---|---|---|---|---|
imageAbsoluteFilePath | The physical path to the directory where images should be stored. |
|||||||||
thumbnailVirtualFilePath |
The virtual path to the tumb directory. Thumbnails will be created here from the images in the previously entered directory. |
|||||||||
maxRating | The maximum rating available for an image. | |||||||||
thumbnailBackgroundColor |
Background color of thumbnail images | |||||||||
thumbnailBackgroundColor |
r | The red component value of the background color | ||||||||
thumbnailBackgroundColor |
g | The green component value of the background color | ||||||||
thumbnailBackgroundColor |
b | The blue component value of the background color | ||||||||
imgExtension | The image extension and format to use for images. Available extensions are: .jpg,.gif, .png and .tif. | |||||||||
imgQuality |
Image Quality 0 -100 |
|||||||||
imgMaxWidth |
The maximum width images should be saved in. |
|||||||||
imgMaxHeight | The maximum height images should be saved in. | |||||||||
saveOriginal |
If the original image add to a gallery should be saved for archiving. |
|||||||||
maxUserImageQuota | The maximum number of images allowed to be stored per user | |||||||||
watermark |
watermark |
|||||||||
watermark |
imageAbsoluteFilePath | The physical path to the tag image file. | ||||||||
watermark |
horizontalAlign | The horizontal alignment of the tag. Can be Left or Right. | ||||||||
watermark |
verticalAlign | The vertial alignment of the tag. Can be Top or Bottom. | ||||||||
watermark |
format | The display format of the tag. Can be Exact or Proportional. Proportional tags will be scaled in proportion to thumbnails. | ||||||||
watermark |
canvas | |||||||||
canvas |
top | The top canvas in pixels. | ||||||||
canvas |
right | The right canvas in pixels. | ||||||||
canvas |
bottom | The bottom canvas in pixels. | ||||||||
canvas |
left | The left canvas in pixels. | ||||||||
canvas |
r | The Red component of the canvas color. -1 for transparent. | ||||||||
canvas |
g | The Green component of the canvas color. -1 for transparent. | ||||||||
canvas |
b | The Blue component of the canvas color. -1 for transparent. |
Below are the configuration properties for the NML section:
Name |
Name |
Description |
|||
---|---|---|---|---|---|
categories. |
name | The <categories> collection contains on or more category definitions. Any tags defined are under one of these categories. This means that different categories can have completely different tags defined, or different implementations of the same tag.When rendering NML, the category to use can be specified, otherwise the category named “general” is used. | |||
tags | name | idenitfies this tag definition element . | |||
tags |
trigger | identifies this tag in markup, for instance if you want to be able to use “[b]foo[/b]”, the value to the trigger attribute would be “b”. | |||
tags |
preTemplate | the text that will be inserted before the text that the tag encloses. If you have “[b]foo[/b]”, this is the template for the text that should be added before “foo” in the output. | |||
tags |
postTemplate | exactly like preTemplate except that the value of this attribute will be added after the text. | |||
tags |
Category |
the category from the category collection to which this tag belongs. |
|||
attributes |
name |
idenitfies this tag definition element. |
|||
attributes |
attributeName |
used as the key when inserting the attribute value in the a tag's PreTemplate or PostTemplate text. In the template texts “{keyname}” is replaced with the attribute value with that name. |
|||
attributes |
defaultvalue |
the default value of the NML attribute. |
|||
attributes |
template |
defines the template text for the attribute in the output. |
|||
attributes |
tag |
the tag from the tag colletion to which this attribute belongs. |
|||
allowedPatterns | name |
idenitfies this allowedPattern element. |
|||
allowedPatterns | pattern | defines the string or regex to compare the attribute value to. | |||
allowedPatterns |
tagAttribute | the attribute from the attributes colletion to which this allowedPattern definition belongs. | |||
allowedValues |
name | idenitfies this allowedValue element. | |||
allowedValues |
value | defines the string or regex to compare the attribute value to. | |||
allowedValues |
tagAttribute | the attribute from the attributes colletion to which this or allowsValue definition belongs. |
Below are the configuration attributes for the OnlineStatus section:
Attribute Name |
Description |
|||
---|---|---|---|---|
loginTimeOut | The time in minutes for a user to be inactive before he is regarded as offline | |||
timeOutCheckInterval | The timespan the module should check for timed out users |
Below are the configuration properties for the Webmail section:
Name |
Description |
|||
---|---|---|---|---|
diskCachePath | The path where the webmail cache files should be placed. Please note that the specified folder must have appropriate permissions set. Note: This directory is emptied on startup |
Further Information
For further information about EPiServer Community and EPiServer Common see the Developer Guide and Framework reference in the online EPiServer Community SDK.