{{{
#!html
<h1>Serverconfig.ini and Webconfig.ini Documentation and Tuning</h1>
}}}
----

'''Revision History'''

||'''Revision'''||'''Date'''||'''Author'''||'''Comment'''||
||0.1||May 10, 2010||Trevor Wekel||Initial pass at documentation||

[[PageOutline(1-3,Table of Contents,inline)]]

= Overview =
This document describes the parameters and provides parameter tuning tips for serverconfig.ini and webconfig.ini. 

== Common Validation Information ==
=== String Properties ===
|| '''Property Type''' || '''Range of String Length'''  || '''Reserved Characters''' ||
|| File Name || 0 < Length <= 128 || \/:*?"<>| ||
|| Folder Name || 0 < Length <= 128 || \/:*?"<>| ||
|| Log Parameters || 0 < Length <= 1024 || ||
|| Password || 0 < Length <= 64 || \t\r\n\v\f ||
|| Path || 0 < Length <= 255 || *?"<>| ||
=== Numeric Properties ===
|| '''Property Type''' || '''Range of String Length'''  ||
|| Port Number ||  0 < Value <= 65535 ||



= Serverconfig.ini =#Server
== Overview ==
Serverconfig.ini controls various aspects of the !MapGuide Server process.  It is typically located in C:\Program Files\OSGeo\!MapGuide\Server\bin or /usr/local/mapguideopensource/server/bin.

== [!GeneralProperties] Section ==#ServerGeneralProperties
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !ConnectionTimeout || ||  < Value <= 86400 || Time duration in seconds for when an idle connection is dropped ||
|| !ConnectionTimerInterval || || 0 < Value <= 2147483647 || Time interval in seconds for when the server checks for idle connections ||
|| !DefaultMessageLocale|| || Length = 2 || ISO 639-1 name for the message locale ||
|| !DisplayName|| ||0 <= Length <= 255 [[BR]]Reserved Characters: \/:*?"<>| || Display name of the server ||
|| !FdoPath|| || ||Path where FDO is installed ||
|| !LicenseServerPath || || ||The path to the License server (not used by !MapGuide Open Source) ||
|| [#ServerLocale Locale]|| ||0 <= Length <= 255 || The server's locale. ||
|| !LogsDelimiter|| || || Delimiter that separates the data fields in the log files ||
|| [#ServerLogsDetail LogsDetail]|| || ||  Level of logging detail per service
|| !LogsPath || || || Path where log files are stored ||
|| !MachineIp || || 0 < Length <= 255 || IP address of the server ||
|| !MaxLogFileSize || || 0 < Value <= 2000000 || Max size allowed for the log files in kilobytes (KB) ||
|| !MaxLogFileSizeEnabled || || || 0 = max size disabled, 1 = max size enabled ||
|| Renderer || || || Image renderer to use (GD or AGG) ||
|| !ResourcesPath || || || Path where the localization resource files are stored ||
|| !SerialNumber || || 0 <= Length <= 12 || The !MapGuide Server serial number (not used by !MapGuide Open Source) ||
|| !TcpIpMtu || ||  0 < Value <= 65535 || TCP/IP maximum transmission unit ||
|| !TempPath || || || Path where the temporary files are stored ||
|| !WfsDocumentPath || || || Document path location for WFS documents ||
|| !WmsDocumentPath || || || Document path location for WMS documents ||
=== Locale Parameter ===#ServerLocale
The server's locale.  If left blank it will default to the operating system locale [[BR]] Format: lang[_country_region.code_page] [[BR]] Example (Windows): English_United States.1252 [[BR]] Example (Linux): en_US.iso88591
=== !LogsDetail Parameter ===#ServerLogsDetail
Level of logging detail per service.
 * 0 - Errors without parameters (default)
 * 1 - Warnings and Errors with parameters
 * 2 - Trace, Warnings, and Errors
 * 3 - Internal Trace, Trace, Warnings, and Errors
Service keys: !ResourceService, !DrawingService, !FeatureService, !MappingService, !RenderingService, !TileService, !KmlService, !ServerAdminService, !SiteService
[[BR]]
Example: MappingService:3,FeatureService:1

== [!AdministrativeConnectionProperties] Section ==#ServerAdministrativeConnection
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Email || ||  0 <= Length <= 255 || Server administrator's email address ||
|| !MaxConnections || || 0 < Value <= 1024 || Max # of open administration connections ||
|| Port || || ||Port to use for administration operations.[[BR]]WARNING: If you change the port # here you must also[[BR]]change the corresponding port # in webconfig.ini  ||
|| !QueueSize || || 0 < Value <= 1024 || Max # of administration operations to queue ||
|| !ThreadPoolSize || || 0 < Value <= 1024 ||  # of threads available for processing administration operations||

== [!ClientConnectionProperties] Section ==#ServerClientConnection
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !MaxConnections || || 0 < Value <= 1024 || Max # of open client connections ||
|| Port || || ||Port to use for client operations.[[BR]]WARNING: If you change the port # here you must also[[BR]]change the corresponding port # in webconfig.ini  ||
|| !QueueSize || || 0 < Value <= 1024 || Max # of client operations to queue ||
|| !ThreadPoolSize || || 0 < Value <= 1024 ||  # of threads available for processing client operations||

== [!SiteConnectionProperties] Section ==#ServerSiteConnection
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !IpAddress || || 0 < Length <= 255 || IP address of site server ||
|| !MaxConnections || || 0 < Value <= 1024 || Max # of open site connections ||
|| Port || || ||Port to use for site operations.[[BR]]WARNING: If you change the port # here you must also[[BR]]change the corresponding port # in webconfig.ini  ||
|| !QueueSize || || 0 < Value <= 1024 || Max # of site operations to queue ||
|| !ThreadPoolSize || || 0 < Value <= 1024 ||  # of threads available for processing site operations||

== [!HostProperties] Section ==#ServerHostProperties
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !DrawingService || || || 0 = service unavailable, 1 = service available ||
|| !FeatureService || || || 0 = service unavailable, 1 = service available ||
|| !KmlService || || || 0 = service unavailable, 1 = service available ||
|| !MappingService || || || 0 = service unavailable, 1 = service available ||
|| !RenderingService || || || 0 = service unavailable, 1 = service available ||
|| !ResourceService || || || 0 = service unavailable, 1 = service available ||
|| !SiteService || || || 0 = service unavailable, 1 = service available ||
|| !TileService || || || 0 = service unavailable, 1 = service available ||

== [!DrawingServiceProperties] Section ==#ServerDrawingService

== [!FeatureServiceProperties] Section ==#ServerFeatureService
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !CacheSize || || 0 < Value <= 5000 || Max # of internal data objects to cache (schemas, classes, etc...) ||
|| !CacheTimeLimit || || 0 < Value <= 2147483647 || Time duration in seconds for how long to cache the internal data objects ||
|| !CacheTimerInterval || || 0 < Value <= 2147483647 || Time interval in seconds for when the server checks for expired cache entries ||
|| !DataCacheSize || || 0 < Value <= 2147483647 || Max # of features to fetch ||
|| !DataConnectionPoolEnabled || || 0 = disabled, 1 = enabled || FDO connection pooling ||
|| !DataConnectionPoolExcludedProviders || || 0 <= Length <= 1024 [[BR]]Value = provider name(s) separated by ","[[BR]]Example: OSGeo.SDF,OSGeo.SHP|| The list of providers to exclude from connection pooling. ||
|| !DataConnectionPoolSize || || 1 < Value <= 1024 || Default # of FDO connections to cache per provider ||
|| !DataConnectionPoolSizeCustom || || 0 <= Length <= 1024 [[BR]] Example: OSGeo.SDF:10,OSGeo.SHP:10 || Custom # of FDO connections to cache for specified provider ||
|| !DataConnectionTimeout || || 0 < Value <= 2147483647 || Time duration in seconds for when an idle FDO connection is dropped ||
|| !DataConnectionTimerInterval || || 0 < Value <= 2147483647 || Time interval in seconds for when the server checks for idle FDO connections ||
|| !JoinQueryBatchSize || || 1 < Value <= 10000 || Join query batch size ||
|| !DataTransactionTimeout || || 0 < Value <= 1800 || Time duration in seconds for when an idle FDO transaction is dropped ||
|| !DataTransactionTimerInterval || || 0 < Value <= 1800 || Time interval in seconds for when the server checks for idle FDO transactions ||

== [!MappingServiceProperties] Section ==#ServerMappingService
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !LegendFont || || 0 < Length <= 255 || Font to use when rendering legend elements ||

== [!RenderingServiceProperties] Section ==#ServerRenderingService
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !TileExtentOffset || || 0.0 <= Value <= 1.0 || Max request extent offset to use when requesting features for a tile, specified as a factor of the tile size ||
|| !RasterGridSize || || 0 < Value <= 2147483647 || Size of raster re-projection grid in pixels ||
|| !MinRasterGridSize || || 0 < Value <= 2147483647 || Minimum size of raster re-projection grid in pixels. This should be less than !RasterGridSize. ||
|| !RasterGridSizeOverrideRatio || || 0.0 <= Value <= 1.0 || If the !RasterGridSize is larger than the image's height or width multiplied by the !RasterGridSizeOverrideRatio, then the !RasterGridSize is overridden with this value.[[BR]]Set to 0 or 1 to disable the override. ||
|| !RasterGridSizeForPlot || || || Size of raster re-projection grid in pixels for plot ||
|| !MinRasterGridSizeForPlot || || || Minimum size of raster re-projection grid in pixels for plot. This must be less than !RasterGridSizeForPlot. ||
|| !RasterGridSizeOverrideRatioForPlot || || || If the !RasterGridSizeForPlot is larger than the image's height or width multiplied by the !RasterGridSizeOverrideRatioForPlot, then the !RasterGridSizeForPlot is overridden with this value.[[BR]]Set to 0 or 1 to disable the override. ||
|| !RenderSelectionBatchSize || || || The batch size to use when rendering a selection ||                    
|| !ClampPoints || || 0 = false and 1 = true || Specifies whether point coordinates are clamped to integer values before passing them to the AGG renderer (experimental) ||
|| !GeneralizeData || || 0 = false and 1 = true || Specifies whether feature geometry is generalized before being rendered (experimental) ||

== [!ResourceServiceProperties] Section ==#ServerResourceService
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !LibraryRepositoryPath || ||  || Path where the Library repository is stored ||
|| !LibraryResourceDataFilePath || ||  || Path where the Library resource data files are stored ||
|| !PackagesPath || ||  || Path where the resource packages can be found ||
|| !RepositoryCheckpointsTimerInterval || || 0 < Value <= 2147483647 || Time duration in seconds for when the server performs checkpoints for all the repositories  ||
|| !ResourceChangeTimerInterval || || 0 < Value <= 2147483647 || Time duration in seconds for when the server dispatches resource change notifications  ||
|| !ResourceDataFileTrashFolderName || ||  || Folder where the repository trash files are stored ||
|| !ResourcePermissionCacheSize || || 0 <= Value <= 2147483647 || Max # of resources with permission information to be cached ||
|| !ResourceSchemaFilePath || ||  || Path where the resource schema files are stored ||
|| !SessionRepositoryPath || ||  || Path where the Session repository is stored  ||
|| !SessionResourceDataFilePath || ||  || Path where the Session resource data files are stored  ||
|| !SiteRepositoryPath || ||  || Path where the Site repository is stored  ||

== [!SiteServiceProperties] Section ==#ServerSiteService
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !SessionTimeout || || 0 < Value <= 86400 || Time duration in seconds for when an idle session is expired ||
|| !SessionTimerInterval || || 0 < Value <= 2147483647 || ime interval in seconds for when the server checks for idle sessions  ||

== [!TileServiceProperties] Section ==#ServerTileService
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| !RenderOnly || || 0 = false and 1 = true ||  Renders the tile only ||
|| !TileCachePath || || || Root path of the image tile cache ||
|| !TileColumnsPerFolder || || 0 < Value <= 1000 || Number of columns of tiles per folder ||
|| !TileRowsPerFolder || || 0 < Value <= 1000 || Number of rows of tiles per folder ||
|| !DefaultTileSizeX || || 50 < value <= 10000 || Width of generated tiles in pixels ||
|| !DefaultTileSizeY || || 50 < value <= 10000 || Height of generated tiles in pixels ||
|| !ImageFormat || || PNG, PNG8, GIF or JPG || Image format for generated tiles ||

== [!AccessLogProperties] Section ==#ServerAccessLog
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Enabled || ||  || 0 = log disabled, 1 = log enabled ||
|| Filename || ||  || Name of the log file  ||
|| Parameters || ||  || Log parameters, eg. CLIENT,CLIENTIP,USER,OPID ||

== [!AdminLogProperties] Section ==#ServerAdminLog
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Enabled || ||  || 0 = log disabled, 1 = log enabled ||
|| Filename || ||  || Name of the log file  ||
|| Parameters || ||  || Log parameters, eg. CLIENT,CLIENTIP,USER,OPID ||

== [!AuthenticationLogProperties] Section ==#ServerAuthenticationLog
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Enabled || ||  || 0 = log disabled, 1 = log enabled ||
|| Filename || ||  || Name of the log file  ||
|| Parameters || ||  || Log parameters, eg. CLIENT,CLIENTIP,USER ||

== [!ErrorLogProperties] Section ==#ServerErrorLog
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Enabled || ||  || 0 = log disabled, 1 = log enabled ||
|| Filename || ||  || Name of the log file  ||
|| Parameters || ||  || Log parameters, eg. CLIENT,CLIENTIP,USER,OPID ||

== [!SessionLogProperties] Section ==#ServerSessionLog
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Enabled || ||  || 0 = log disabled, 1 = log enabled ||
|| Filename || ||  || Name of the log file  ||
|| Parameters || ||  || Log parameters, eg. CLIENT,CLIENTIP,USER,STARTTIME,ENDTIME,OPSFAILED,OPSRECEIVED,AVERAGEOPTIME ||

== [!TraceLogProperties] Section ==#ServerTraceLog
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| Enabled || ||  || 0 = log disabled, 1 = log enabled ||
|| Filename || ||  || Name of the log file  ||
|| Parameters || ||  || Log parameters, eg. INFO ||

== [!FontAliases] Section ==#ServerFontAliases
This section is used to map a font family name to another.  The left side is a name that might be specified by the user and the right side is what font to actually use.
{{{
[FontAliases]
Font name #1 in layer definition = font name #1 on disk
Font name #2 in layer definition = font name #2 on disk
}}}

== [!UnmanagedDataMappings] Section ==#ServerUnmanagedDataMappings
This section is used to map a mapping name to an unmanaged data folder.
{{{
[UnmanagedDataMappings]
Mapped name in feature source = Data folder on disk
}}}

= Webconfig.ini =#Web
== Overview ==
Webconfig.ini controls various aspects of the !MapGuide !WebExtensions and !MapAgent. It is typically located in C:\Program Files\OSGeo\!MapGuide\Web\www or /usr/local/mapguideopensource/webserverextensions/www.
== [!GeneralProperties] Section ==#WebGeneralProperties
|| '''Property Name''' || '''Supported In''' || '''Restrictions''' || '''Description''' ||
|| DefaultMessageLocale || || if a 5 character locale is specified the first 2 characters must be lower case and the last 2 characters must be upper case. || ISO 639-1 name for the message locale[[BR]] Example: en or en-US ||
|| ResourcesPath || ||  || Path where the localization resource files are stored ||
|| TcpIpMtu || || 0 < Value <= 65535  || The TCP/IP maximum transmission unit ||
|| [#FailoverRetryTime FailoverRetryTime] ||2.2(+) ||  || Time in seconds for when to retry connecting to a !MapGuide server that has gone offline.  ||
=== !FailoverRetryTime ===#FailoverRetryTime
For a single Web Tier and !MapGuide server pair use 1.  For a load balanced configuration with multiple !MapGuide 
servers use 60.  Values other than 1 will cause a delay when re-establishing a connection with the Web Tier after restarting a !MapGuide server.

== [!AdministrativeConnectionProperties] Section ==#WebAdministrativeConnection
== [!ClientConnectionProperties] Section ==#WebClientConnection
== [!SiteConnectionProperties] Section ==#WebSiteConnection
== [!AgentProperties] Section ==#WebAgentProperties
== [!OgcProperties] Section ==#WebOgcProperties
== [!WebApplicationProperties] Section ==#WebApplicationProperties