-------------------------------------------------------------
Documentation for galleryserverpro.config configuration file
This file contains documentation for the configuration settings in the galleryserverpro.config
configuration file. The config file is linked by web.config and will automatically cause the
application to restart when it is modified, including modifications done through the UI.
galleryserverpro.config contains three config sections:
core - Contains general site-wide settings.
galleryObject - Contains settings for the gallery objects stored within Gallery Server Pro.
Includes HTML templates for various types of media objects, browser-specific mapping, and
settings for specifying which MIME types are managed by Gallery Server.
dataStore - Contains information specific to the data store, such as length specifications for
text fields in tables.
dataProvider - Contains information about the data store used by Gallery Server Pro.
Note: These comments are in this file rather than galleryserverpro.config because the
.NET 2.0 Configuration API strips out all comments and reformats the file when it is modified.
-------------------------------------------------------------
-------------------------------------------------------------
Gallery Server Pro core configuration properties
-------------------------------------------------------------
Overview:
This section stores configuration information for core Gallery Server properties.
mediaObjectPath (default = ""):
The absolute or relative path to a directory on a local hard drive containing the media objects. Relative paths are
relative to the root of the web application. The initial and trailing slashes are optional. For relative paths, the
directory separator character can be either a forward or backward slash. UNC or mapped drives are not valid.
Example: If Gallery Server Pro is installed at C:\inetpub\wwwroot\gsp, the following are all valid and point to the
same location: "C:\inetpub\wwwroot\gsp\mypics\", "C:\inetpub\wwwroot\gsp\mypics",
"\mypics\", "\mypics", "mypics\", "mypics", "/mypics/", "/mypics"
galleryId (default = "1"):
The value that uniquely identifies the gallery for this website. Each web application is associated with a
single gallery.
websiteTitle (default = "Gallery Server Pro"):
The text placed within the <title> tag on each web page.
pageHeaderText (default = "My Media Gallery"):
The header text that appears at the top of each web page.
pageHeaderTextUrl (default = "~/"):
The URL the user will be directed to when she clicks the page header text. Optional. If not
present, no link will be rendered. Examples: "http://www.mysite.com", "/" (the root of the web site),
"~/" (the root of the current application).
defaultAlbumDirectoryName (default = "DefaultName"):
The default name for a directory when a valid name cannot be generated from the album title. This occurs
when a user enters an album title consisting entirely of characters that are invalid for a directory
name, such as ?, *, :.
defaultAlbumDirectoryNameLength (default = "25"):
The maximum length of the directory name when a user creates an album. By default, a directory name is the same as the
album's title, but is truncated when the title is longer than the value specified here.
synchAlbumTitleAndDirectoryName (default = "true"):
Indicates whether to update the directory name corresponding to an album when the album's title is changed. When
true, modifying the title of an album causes the directory name to be changed to the same value. If the
title is longer than the value specified in defaultAlbumDirectoryNameLength, the directory name is truncated. You
may want to set this to false if you have a directory structure that you do not want Gallery Server Pro to alter.
Note that even if this setting is false, directories will still be moved or copied when the user moves or copies
an album. Also, Gallery Server Pro always modifies the directory name when it is necessary to
make it unique within a parent directory. For example, this may happen if you give two sibling albums the same title
or you move/copy an album into a directory containing another album with the same name.
emptyAlbumThumbnailBackgroundColor (default = "#369"):
The color used for the background of the GIF image generated by Gallery Server when creating a default
thumbnail image for a newly created album or an album without any objects. The color can be specified as
hex (e.g. #336699), RGB (e.g. 127,55,95), or one of the System.Color.KnownColor enum values (e.g. Maroon).
emptyAlbumThumbnailText (default = "Empty"):
The default text written on the GIF image generated by Gallery Server when creating a default thumbnail image
for a newly created album or an album without any objects. The GIF is
dynamically generated by the application when it is needed and is never actually stored on the hard drive.
emptyAlbumThumbnailFontName (default = "Arial"):
The font used for text written on the GIF image generated by Gallery Server when creating a default
thumbnail image for a newly created album or an album without any objects. The font must be installed on
the web server. If the font is not installed, a generic sans serif font will be substituted.
emptyAlbumThumbnailFontSize (default = "12"):
The size, in pixels, of the font used for text written on the GIF image generated by Gallery Server when
creating a default thumbnail image for a newly created album or an album without any objects.
emptyAlbumThumbnailFontColor (default = "White"):
The color of the text specified in property EmptyAlbumThumbnailText. The color can be specified as
hex (e.g. #336699), RGB (e.g. 127,55,95), or one of the System.Color.KnownColor enum values (e.g. Maroon).
emptyAlbumThumbnailWidthToHeightRatio (default = "1.33"):
The ratio of the width to height of the default thumbnail image for an album that does not have a thumbnail
image specified. The length of the longest side of the image is set by the MaxThumbnailLength property, and the
length of the remaining side is calculated using this ratio. A ratio or more than 1.00 results in the width
being greater than the height (landscape), while a ratio less than 1.00 results in the width being less
than the height (portrait). Example: If MaxThumbnailLength = 115 and EmptyAlbumThumbnailWidthToHeightRatio = 1.50,
the width of the default thumbnail image is 115 and the height is 77 (115 / 1.50).
maxAlbumThumbnailTitleDisplayLength (default = "25"):
Maximum # of characters to display when showing the title of an album in a thumbnail view.
maxMediaObjectThumbnailTitleDisplayLength (default = "20"):
Maximum # of characters to display when showing the title of a media object in a thumbnail view.
allowHtmlInTitlesAndCaptions (default = "true")
Indicates whether to allow limited HTML tags in the titles and captions for albums and media objects.
When true, the following HTML tags are allowed: a, img, span, div, p, h1, h2, h3, h4, h5, h6, strong, em, u,
b, i, strike, sup, sub, font, blockquote, ul, ol, li, address, pre, hr, br. Also, the following attributes
are allowed: class, style, id. In addition, some tag-specific attributes are also allowed (e.g. src,
alt, and title for img; href, target, name, and title for hyperlink (a)). Javascript is NEVER allowed.
If this value is changed from true to false, existing objects will not be immediately purged of all HTML
tags. Instead, individual titles and captions are stripped of HTML as each object is edited and saved by the user.
mediaObjectTransitionType (default = "Fade")
Specifies the visual transition effect to use when moving from one media object to another. This value maps to the
enumeration GalleryServerPro.Business.MediaObjectTransitionType, and must be one of the following values:
None, Fade.
mediaObjectTransitionDuration (default = ".3")
The duration of the transition effect, in seconds, when navigating between media objects. This
setting has no effect when mediaObjectTransitionType = "None".
slideshowInterval (default = "3000")
The delay, in milleseconds, between images during a slide show.
mediaObjectDownloadBufferSize (default = "32768"):
The size of each block of bytes sent to the client when downloading media objects (images, video, etc.)
maxRequestLengthKB (default = "10000"):
The maximum size of an HTTP request. Used primarily to restrict the size of file uploads through the
web interface. Used in the same way that .NET-defined maxRequestLength is used in web.config. However,
it is stored here and handled through custom code to provide a friendlier error message than is provided
by specifying the value in web.config.
encryptMediaObjectUrlOnClient (default = "true"):
Indicates whether security-sensitive portions of the URL to the media object are encrypted when it is sent
to the client browser. Valid values are "true" and "false". When false, the URL to the media object is sent
in plain text, such as "handler/getmediaobject.ashx?moid=34&aid=8&mo=C%3A%5Cgs%5Cmypics%5Cbirthday.jpeg&mtc=1&dt=1"
These URLs can be seen by viewing the source of the HTML page. From this URL one can determine the album ID
for this media object is 8, (aid=8), the file path to the media object on the server is
C:\gs\mypics\birthday.jpeg, and the requested image is a thumbnail (dt=1, where 1 is the value of the
GalleryServerPro.Business.DisplayObjectType enumeration for a thumbnail). For enhanced security, set
encryptMediaObjectUrlOnClient to true, which uses Triple DES encryption to encrypt the query string.
It is recommended to set this to true except when you are troubleshooting and it is useful to see the
file name and path in the HTML source. The Triple DES algorithm uses the secret key specified in the
EncryptionKey property. Typically, this should be set to The Triple DES algorithm is used and the
EncryptionKey property is used as the secret key.
encryptionKey (default = "Phoenix 13drycity minnea"):
The secret key used for the Triple DES algorithm. Applicable when encryptMediaObjectUrlOnClient = true.
The string must be 24 characters in length and be sufficiently strong so that it cannot be easily cracked.
An exception is thrown by the .NET Framework if the key is considered weak. Change this to a value known only
to you to prevent others from being able to decrypt.
allowUnspecifiedMimeTypes (default = "false"):
Indicates whether Gallery Server Pro is allowed to manage file types not explicitly specified in the mimeTypes configuration
section. When false, any file with an extension not listed in the mimeTypes section is rejected. When true,
Gallery Server Pro accepts all file types regardless of their file extension.
imageTypesStandardBrowsersCanDisplay (default = ".jpg,.jpeg,.gif,.png" )
A comma separated list of file extensions indicating types of images that a standard browser can display. When
the user requests an original image (high resolution), the original is sent to the browser in an HTML tag
if its extension is one of those listed here. If not, the user is presented with a message containing instructions
for downloading the image file. Typically this setting should not be changed.
allowAnonymousHiResViewing (default = "true")
Specifies whether anonymous users are allowed to view the original, uncompressed versions of images. When no
compressed (optimized) version of an image exists, the user is allowed to view the original, regardless of this
setting. This setting has no effect on non-image media objects or for logged on users.
enableImageMetadata (default = "true")
Specifies whether Gallery Server Pro extracts and displays metadata from image files. The metadata is displayed
next to the optimized version of images when the View metadata toolbar icon is invoked. If the attribute
enableWpfMetadataExtraction is true, then additional metadata such as title, keywords, and rating is extracted.
enableWpfMetadataExtraction (default = "true")
Specifies whether metadata is extracted from image files using Windows Presentation Foundation (WPF) classes
in .NET Framework 3.0. The WPF classes allow additional metadata to be extracted beyond those allowed by the
.NET Framework 2.0, such as title, keywords, and rating. This attribute has no effect unless the following
requirements are met: The attribute enableImageMetadata = "true"; .NET Framework 3.0 is installed on the web
server; the web application is running in Full Trust. The WPF classes have exhibited some reliability issues
during development, most notably causing the IIS worker process (w3wp.exe) to increase in memory usage and
eventually crash during uploads and synchronizations. For this reason you may want to disable this feature
until a .NET Framework service pack or future version provides better performance.
enableMediaObjectDownload (default = "true")
Specifies whether Gallery Server Pro renders user interface objects to allow a user to download the file for a media
object. Typically, this setting is used to control whether a download button is displayed in the toolbar that
appears above a media object. Note that setting this value to false does not prevent a user from downloading a
media object, since a user already has access to the media object if he or she can view it in the browser. To
prevent certain users from viewing media objects (and thus downloading them), user private albums or disable
anonymous viewing.
enablePermalink (defaultValue = "true")
Specifies whether Gallery Server Pro renders user interface objects to provide the user with a hyperlink that
links directly to the visible media object. This is convenient because AJAX callbacks are used as the user navigates
the media objects in an album and the url in the browser's address bar is not updated for each media object.
When true, a show permalink button is displayed in the toolbar that appears above a media object.
enableSlideShow (defaultValue = "true")
Specifies whether slide show functionality is enabled. When true, a start/pause slideshow button is displayed in the
toolbar that appears above a media object. The length of time each image is shown before automatically moving
to the next one is controlled by the SlideshowInterval setting. Note that only images are shown during a slide
show; other objects such as videos, audio files, and documents are skipped.
maxThumbnailLength (default = "125"):
The length (in pixels) of the longest edge of a thumbnail image. This value is used when a thumbnail image
is created. The length of the shorter side is calculated automatically based on the aspect ratio of the image.
thumbnailImageJpegQuality (default = "70"):
The quality level that thumbnail images are stored at (0 - 100).
thumbnailClickShowsOriginal (default = "False"):
Specifies whether the original image is displayed when the user clicks the thumbnail of an image.
If unchecked, the optimized image is shown instead. Not applicable for non-image media objects.
thumbnailWidthBuffer (default = "30"):
The length (in pixels) that is added to the width of the each thumbnail image. A larger number creates
more horizontal padding between the image and the border of the thumbnail container.
thumbnailHeightBuffer (default = "60"):
The length (in pixels) that is added to the height of the each thumbnail image. A larger number creates
more vertical padding between the image and the border of the thumbnail container.
thumbnailFileNamePrefix (default = "zThumb_"):
The string that is prepended to the thumbnail file name for each media object. For example, if an image named
puppy.jpg is added, and this setting is "zThumb_", the thumbnail image will be named "zThumb_puppy.jpg".
NOTE: Any file named "zThumb_puppy.jpg" that already exists will be overwritten, so it is important to
choose a value that, when prepended to media object file names, will not conflict with existing media objects.
thumbnailPath (default=""):
The absolute or relative path to a directory on a local hard drive specifying where Gallery Server should store
the thumbnail images of media objects. Relative paths are relative to the root of the web application. The
initial and trailing slashes are optional. For relative paths, the directory separator character can be either
a forward or backward slash. If no path is specified, the directory containing the original media object is
used to store the thumbnail image. UNC or mapped drives are not valid. The following are all valid and point
to the same location (assuming Gallery Server is installed as a web application at C:\inetpub\wwwroot\gsp):
"C:\inetpub\wwwroot\gsp\cache\", "C:\inetpub\wwwroot\gsp\cache",
"\cache\", "\cache", "cache\", "cache", "/cache/", "/cache"
maxOptimizedLength (default = "640"):
The length (in pixels) of the longest edge of an optimized image. This value is used when an optimzed
image is created. The length of the shorter side is calculated automatically based on the aspect ratio
of the image. Not applicable for non-image media objects.
optimizedImageJpegQuality (default = "70"):
The quality level that optimized JPG pictures are created with. This is a number from 1 - 100, with 1
being the worst quality and 100 being the best quality. Not applicable for non-image media objects.
optimizedImageTriggerSizeKB (default = "50"):
The size (in KB) above which an image is compressed to create an optimized version.
Not applicable for non-image media objects.
optimizedFileNamePrefix (default = "zOpt_"):
The string that is prepended to the optimized file name for images. This setting is only used for image
media objects where an optimized image file is created. For example, if an image named
puppy.jpg is added, and this setting is "zOpt_", the optimized image will be named "zOpt_puppy.jpg".
NOTE: Any file named "zOpt_puppy.jpg" that already exists will be overwritten, so it is important to
choose a value that, when prepended to media object file names, will not conflict with existing media objects.
optimizedPath (default=""):
The absolute or relative path to a directory on a local hard drive specifying where Gallery Server should store
the optimized images of media objects. Relative paths are relative to the root of the web application. The
initial and trailing slashes are optional. For relative paths, the directory separator character can be either
a forward or backward slash. If no path is specified, the directory containing the original media object is
used to store the thumbnail image. UNC or mapped drives are not valid. Not applicable for non-image media objects.
The following are all valid and point to the same location (assuming Gallery Server is installed as a web
application at C:\inetpub\wwwroot\gsp): "C:\inetpub\wwwroot\gsp\cache\", "C:\inetpub\wwwroot\gsp\cache",
"\cache\", "\cache", "cache\", "cache", "/cache/", "/cache"
originalImageJpegQuality (default = "95"):
The quality level that original JPG pictures are saved at. This is only used when the original is
modified by the user, such as rotation. Not applicable for non-image media objects.
applyWatermark (default = "false")
Specifies whether to apply a watermark to optimized and original images. If true, the text in the watermarkText
property is applied to images, and the image specified in watermarkImagePath is overlayed on the image. If
watermarkText is empty, or if watermarkImagePath is empty or does not refer to a valid image, that watermark
is not applied. If applyWatermarkToThumbnails = true, then the watermark is also applied to thumbnails.
applyWatermarkToThumbnails (default = "false")
Specifies whether to apply the text and/or image watermark to thumbnail images. This property is ignored if
applyWatermark = false.
watermarkText (default = "")
Specifies the text to apply to images in the gallery. The text is applied in a single line.
watermarkTextFontName (default = "Verdana")
The font used for the watermark text. If the font is not installed on the web server, a generic sans serif font will
be substituted.
watermarkTextFontSize (default = "12")
Gets or sets the height, in pixels, of the watermark text. This value is ignored if the property
watermarkTextWidthPercent is non-zero. Valid values are 0 - 10000.
watermarkTextWidthPercent (default = "50")
Gets or sets the percent of the overall width of the recipient image that should be covered with the
watermark text. The size of the text is automatically scaled up or down to achieve the desired width. For example,
a value of 50 means the text is 50% as wide as the recipient image. Valid values are 0 - 100. The text is never
rendered in a font smaller than 6 pixels, so in cases of long text it may stretch wider than the percentage
specified in this setting.
A value of 0 turns off this feature and causes the text size to be determined by the watermarkTextFontSize property.
watermarkTextColor (default = "Black")
Specifies the color of the watermark text. The color can be specified as hex (e.g. #336699), RGB (e.g. 127,55,95),
or one of the System.Color.KnownColor enum values (e.g. Maroon).
watermarkTextOpacityPercent (default = "30")
The opacity of the watermark text. This is a value from 0 to 100, with 0 being invisible and 100 being solid,
with no transparency.
watermarkTextLocation (default = "BottomCenter")
Gets or sets the location for the watermark text on the recipient image. This value maps to the
enumeration System.Drawing.ContentAlignment, and must be one of the following nine values:
TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight.
watermarkImagePath (default = "")
Gets or sets the full or relative path to a watermark image to be applied to the recipient image. The image
must be in a format that allows it to be instantiated in a System.Drawing.Bitmap object. Relative paths
are relative to the root of the web application. The directory separator character can be either a
forward or backward slash, and, for relative paths, the initial slash is optional. The following are
all valid: "/images/mywatermark.jpg", "images/mywatermark.jpg", "\images\mywatermark.jpg",
"images\mywatermark.jpg", "C:\images\mywatermark.jpg"
watermarkImageWidthPercent (default ="75")
Gets or sets the percent of the overall width of the recipient image that should be covered with the
watermark image. The size of the image is automatically scaled to achieve the desired width. For example,
a value of 50 means the watermark image is 50% as wide as the recipient image. Valid values are 0 - 100.
A value of 0 turns off this feature and causes the image to be rendered its actual size.
watermarkImageOpacityPercent (default = "100")
Gets or sets the opacity of the watermark image. Valid values are 0 - 100, with 0 being completely
transparent and 100 completely opaque.
watermarkImageLocation (default = "Center")
Gets or sets the location for the watermark image on the recipient image. This value maps to the
enumeration System.Drawing.ContentAlignment, and must be one of the following nine values:
TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight.
sendEmailOnError (default = "true"):
Specifies whether the Gallery Server Pro administrator (specified in EmailToName/EmailToAddress)
is sent a report when a web site error occurs. A valid SMTP server must be specified if this
is set to true (attribute SmtpServer).
emailFromName (default = "Gallery Server Admin"):
The name associated with the EmailFromAddress email address. Emails sent from Gallery Server
will appear to be sent from this person.
emailFromAddress (default = "yourname@yourisp.com"):
The email address associated with the EmailFromName attribute. Emails sent from Gallery Server
will appear to be sent from this email address.
emailToName (default = "Gallery Server Pro Administrator"):
The name associated with the EmailToAddress email address. Emails sent from Gallery Server
will be sent to this person. Note that the email address is set in the attribute EmailToAddress.
emailToAddress (default = "admin@yourisp.com"):
The email address associated with the EmailToName attribute. Emails sent from Gallery Server
will be sent to this email address. Note that the name associated with this address is set in
the attribute EmailToName.
smtpServer (default = ""):
Specifies the IP address or name of the SMTP server used to send emails. (Examples: 127.0.0.1,
Godzilla, mail.yourisp.com) This value will override the SMTP server setting that may be in the
system.net mailSettings section of the web.config file (either explicitly or inherited from a
parent web.config file). Leave this setting blank to use the value in web.config or if you are
not using the email functionality.
smtpServerPort (default = ""):
Specifies the SMTP server port number used to send emails. This value will override the SMTP
server port setting that may be in the system.net mailSettings section of the web.config file
(either explicitly or inherited from a parent web.config file). Leave this setting blank to
use the value in web.config or if you are not using the email functionality. Defaults to 25
if not specified here or in web.config.
autoStartMediaObject (default = "true"):
Indicates whether a video, audio or other dynamic object will automatically start playing in the user's browser.
defaultVideoPlayerWidth (default = "640"):
Indicates the default width, in pixels, of the browser object that plays a video file. Typically
this refers to the