Key/Value Pairs in CMS 9.x local-appsettings.config
The configuration key/value pairs for the CMS are found in the local-appsettings.config file and should only be used for specific use-case scenarios as recommended by Ingeniux Support.
Note: Configure local-appsettings.config to match the local domain used in users.xml. If you do not use a domain prefix within users.xml, set the value to an empty string.
Prerequisite:
- Administrative rights on the content management server.
To configure local-appsettings.config:
- In a file browser, navigate to [Drive]:\[path-to-cms-root-folder].
- Open local-appsettings.config in a text editor.
- Refer to the table below for key names, default values, example values, and key/value pair descriptions.
- When you complete your changes, save the local-appsettings.config file and recycle the CMS application pool for the settings to take effect.
|
Key Name |
Default Value |
Example Value |
Description |
|---|---|---|---|
|
userdomain |
Empty string |
ingeniux |
This value is used to set a default domain for CMS environments authenticating against a domain. If the Domain Controller option is selected during the Select User Provider Type step of the CMS installation process, the domain specified during setup populates the userdomain value field. See step 10 in Creating CMS Site Instances for details. |
|
tempImageTimeOut |
30 |
25 |
This value represents the maximum number of seconds to write a temporary image file to disk after a user edits an image in the CMS before a timeout occurs. If a timeout occurs when writing an image file to disk, the operation stops. |
|
redirectToHttpAboutLogin |
true |
false | This setting is for https only. If true, redirect to http; otherwise, it stays as https. |
|
includeErrorStackTrace |
false |
true |
If true, the stack trace for errors in the CMS displays via a pop-up alert in the UI. The CMS always logs the stack trace, regardless of whether or not the includeErrorStacktrace value is true or false. This setting is used for internal development only. |
| ravenIndexDocumentDifferenceLimit | 2000 | 1900 |
The system checks and compares the configured value to 10 percent of the total document size in RavenDB's ContentStore. The system chooses the smaller of the two numbers and uses this number to determine if the index is out-of-sync. If this number is larger, the system resets the index. If the RavenDB Index resets, a warning-level entry is written to the CMS logs. Example CMS Log Entry: The CSAPI logs always show a check occurring and warn if the document difference limit condition is met to trigger a re-indexing event. In CMS 9 SR7+, the re-indexing event only occurs if the performRavenIndexSanityCheckOnStartup configuration value is set to true (see table row). |
| webpages:Version | 3.0.0.0 | 2.0.0.0 | MVC4 setting |
| PreserveLoginUrl | true | false | MVC4 setting |
| ClientValidationEnabled | true | false | MVC4 setting |
| UnobtrusiveJavaScriptEnabled | true | false | MVC4 setting |
| performRavenIndexSanityCheckOnStartup | false | true | This value determines if RavenDB indexes reset if the document difference limit is met. If set to true and the ravenIndexDocumentDifferenceLimit condition is met, a re-indexing event occurs. |
| syncIndexDefinitionsOnContentStoreInit | false | true |
As of CMS 9 SR7+, RavenDB index definitions are only checked and updated during the CMS upgrade process. If an external application that uses the RavenDB ContentStore creates a custom index for the CMS, this index regenerates during an upgrade event. If true, all index definitions for RavenDB are pushed when the application pool is restarted. |
| Raven/Encryption/FIPS | true | false | Raven Client Settings |
| DisableRavenClientCache | false | true | Customers who monitor their CMS server environments may notice high memory usage for the CMS application pool. If true, this setting reduces the memory footprint for the CMS application pool. |