Key/Value Pairs in CMS local-appsettings.config

Product: CMS

Version: All, CMS 10, 10.x, CMS 9, 9.x

Published: September 8, 2016

Last updated: 3/4/2021

Comments:
0 Comments

Purpose

The following configuration key/value pairs are found in the local-appsettings.config file and should only be used for specific use-case scenarios as directed by Ingeniux Support.

Requirements

  • CMS 9.x or 10.x site.
  • Administrative rights on the Content Management Server.

Step-by-Step

  1. In a file browser, navigate to your CMS site's root folder.
  2. Open local-appsettings.config in a text editor.
  3. Refer to the table below for key names, value types, default values, and key/value pair descriptions.
  4. When changes are done, 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 value for the purpose of authentication for CMS environments authenticating against a domain. If the Domain Controller option is selected during the User Provider Type step of the CMS installation process, the domain specified during setup populates the userdomain value field.

tempImageTimeOut

30

25

The maximum number of seconds to write a temporary image file to disk after a user edits an image from within the CMS, before a timeout occurs. If a timeout occurs when writing an image file to disk, the operation stops.

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 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:[WARN] [2019-04-17 13:56:36.3122] - Raven System Index detected incomplete. Resetting. Index count: 420196, Doc Count: 415099

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 next row).

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.

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.


Comments

There are no comments yet.