Skip to content

Commit 1a056ad

Browse files
authored
Added key and default value information to most sections
1 parent 0a015fc commit 1a056ad

File tree

1 file changed

+59
-1
lines changed

1 file changed

+59
-1
lines changed

14/umbraco-cms/reference/configuration/globalsettings.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,82 +59,114 @@ The following snippet contains all the available options, with default values, a
5959
}
6060
```
6161

62-
## Root level settings
62+
## Root level settings
6363

6464
In the root level section, that is those without a seperate sub section like SMTP, you can configure
6565

6666
### Reserved urls
6767

68+
Key: `ReservedUrls` (default: `~/.well-known,`)
69+
6870
A comma-seperated list of files to be left alone by Umbraco, these files will be served, and the Umbraco request pipeline will not be triggered.
6971

7072
### Reserved paths
7173

74+
Key: `ReservedPaths` (default: `~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,`)
75+
7276
A comma-separated list of all the folders in your directory to be left alone by Umbraco. If you have folders with custom files, add them to this setting to make sure Umbraco leaves them alone.
7377

7478
{% hint style="warning" %} Adding additional values to the Reserves URLs and Reserved Paths will overwrite default/current values. This causes performance issues as well. {% endhint %}
7579

7680
### Timeout
7781

82+
Key: `TimeOut` (default: `00:20:00`)
83+
7884
Configure the session timeout to determine how much time without a request being made can pass before the user is required to log in again. The session timeout format needs to be set as `HH:MM:SS`. Any activity within the backoffice will reset the timer.
7985

8086
{% hint style="info" %} Long session timeouts raise data exposure and unauthorized access risks. Thus, it's vital to establish a reasonable timeout to mitigate security risks. {% endhint %}
8187

8288
### Default UI language
8389

90+
Key: `DefaultUILanguage` (default: `en-US`)
91+
8492
The default language to use in the backoffice if a user isn't explicitly assigned one.
8593

8694
### Hide top level nodes from path
8795

96+
Key: `HideTopLevelNodeFromPath`
97+
8898
If you are running multiple sites, you don't want the top level node in your URL and can disable it with this setting.
8999

90100
### Use https
91101

102+
Key: `UseHttps` (default: `false`)
103+
92104
Makes sure that all of the requests in the backoffice are called over HTTPS instead of HTTP when set to true.
93105

94106
### Version check period
95107

108+
Key: `VersionCheckPeriod` (default: `7`)
109+
96110
When this value is set above 0, the backoffice will check for a new version of Umbraco every 'x' number of days where 'x' is the value defined for this setting. Set this value to 0 to never check for a new version.
97111

98112
### Icons path
99113

114+
Key: `IconsPath` (default: `umbraco/assets/icons`)
115+
100116
By adding this value you can specify a new/different folder for storing your icon resources. It's important to be aware of NetCore's limitations regarding serving static file content. By default, static content will only be served from the `wwwroot` folder.
101117

102118
### Umbraco CSS path
103119

120+
Key: `UmbracoCssPath` (default: `~/css`)
121+
104122
By adding this you can specify a new/different folder for storing your CSS files, and still be able to edit them within Umbraco. It's also important to be aware of NetCores limitations regarding serving static file content here as well, by default, static content will only be served from the wwwroot folder. For more info see [Extending filesystem](../../extending/filesystemproviders/)
105123

106124
### Umbraco scripts path
107125

126+
Key: `UmbracoScriptsPath` (default: `~/scripts`)
127+
108128
By adding this you can specify a new/different folder for storing your script/js files, and still be able to edit them within Umbraco. It's also important to be aware of NetCores limitations regarding serving static file content here as well, by default, static content will only be served from the wwwroot folder. For more info see [Extending filesystem](../../extending/filesystemproviders/)
109129

110130
### Umbraco media path
111131

132+
Key: `UmbracoMediaPath` (default: `~/media`)
133+
112134
By adding this you can specify a new/different folder for storing your media files, and still be able to edit them within Umbraco. It's also important to be aware of NetCores limitations regarding serving static file content here as well, by default, static content will only be served from the wwwroot folder. For more info see [Extending filesystem](../../extending/filesystemproviders/)
113135

114136
### Umbraco media physical root path
115137

138+
Key: `UmbracoMediaPhysicalRootPath` (default: `~/media`)
139+
116140
By adding this you can specify a new/different folder for storing your media files elsewhere on the server. Unlike `UmbracoMediaPath`, this does not change the relative path that media is served from (e.g. /media) but allows for files to be stored **outside** of the wwwroot folder. Both relative paths (../../Shared/Media) and absolute server paths (X:/Shared/Media) are supported. For more info see [Extending filesystem](../../extending/filesystemproviders/)
117141

118142
### Install missing database
119143

144+
Key: `InstallMissingDatabase` (default: `false`)
145+
120146
This is not a setting that commonly needs to be configured.
121147

122148
If enabled Umbraco will try to automatically install the database when it's missing. This is primarily used in conjuction with unattended installs.
123149

124150
### Disable election for single server
125151

152+
Key: `DisableElectionForSingleServer` (default: `false`)
153+
126154
This is not a setting that commonly needs to be configured.
127155

128156
This value is primarily used on Umbraco Cloud for a small startup performance optimization. When this is true, the website instance will automatically be configured to not support load balancing and the website instance will be configured to be the 'primary' server for scheduling so no [primary election](../../fundamentals/setup/server-setup/load-balancing/file-system-replication.md) occurs. This will save 1 database call during startup.
129157

130158
### Database factory version
131159

160+
Key: `DatabaseFactoryServerVersion` (default: `false`)
161+
132162
This is not a setting that commonly needs to be configured.
133163

134164
This setting is used to specify which sql server version that the database is running, this setting is only required if you use SqlServer 2008, if this is the case set the setting to `"SqlServer.V2008"`
135165

136166
### Main dom lock
137167

168+
Key: `MainDomLock`
169+
138170
Specifies the implementation of IMainDomLock to be used.
139171

140172
`IMainDomLock` is used to synchronize access to resources like the Lucene indexes.
@@ -149,6 +181,8 @@ The default implementation unless configured otherwise is `FileSystemMainDomLock
149181

150182
### Main dom key discriminator
151183

184+
Key: `MainDomKeyDiscriminator`
185+
152186
For advanced use cases e.g. deployment slot swapping on Azure app services.
153187

154188
When using SqlMainDomLock a MainDomKey is used to identify an instance of a running application.
@@ -165,16 +199,22 @@ It's worth noting that during the swap operation there is a period where both in
165199

166200
### Main dom release signal polling interval
167201

202+
Key: `MainDomReleaseSignalPollingInterval`
203+
168204
Gets or sets the duration (in milliseconds) for which the MainDomLock release signal polling task should sleep. The default value is 2000ms.
169205

170206
### Id
171207

208+
Key: `Id`
209+
172210
This setting doesn't need to be configured.
173211

174212
This setting contains a unique ID used to identify your project, and is populated the first time your site runs, you shouldn't change this setting.
175213

176214
### No nodes view path
177215

216+
Key: `NoNodesViewPath` (default: `~/umbraco/UmbracoWebsite/NoNodes.cshtml`)
217+
178218
This setting specifies what view to render when there is no content on the site.
179219

180220
## SMTP settings
@@ -227,10 +267,14 @@ It's unlikely that you will have to change these settings unless you're using a
227267

228268
### Wait time between calls
229269

270+
Key: `DatabaseServerRegistrar.WaitTimeBetweenCalls` (default: `00:01:00`)
271+
230272
Sets a value for the amount of time to wait between calls to the database on the background thread.
231273

232274
### Stale server timeout
233275

276+
Key: `DatabaseServerRegistrar.StaleServerTimeout` (default: `00:02:00`)
277+
234278
Sets a value for the time span to wait before considering a server stale, after it has last been accessed.
235279

236280
## Database server messenger
@@ -239,22 +283,32 @@ It's unlikely that you will have change these settings, unless you're using a lo
239283

240284
### Max processing instruction
241285

286+
Key: `DatabaseServerMessenger.MaxProcessingInstructionCount` (default: `1000`)
287+
242288
Sets a value for the maximum number of instructions that can be processed at startup; otherwise the server cold-boots (rebuilds its caches).
243289

244290
### Time to retain instructions
245291

292+
Key: `DatabaseServerMessenger.TimeToRetainInstructions` (default: `2.00:00:00`)
293+
246294
Sets a value for the time to keep instructions in the database; records older than this number will be pruned.
247295

248296
### Time between sync operations
249297

298+
Key: `DatabaseServerMessenger.TimeBetweenSyncOperations` (default: `00:00:05`)
299+
250300
Sets a value for the time to wait between each sync operation.
251301

252302
### Time between prune operations
253303

304+
Key: `DatabaseServerMessenger.TimeBetweenPruneOperations` (default: `00:01:00`)
305+
254306
Sets a value for the time to wait between each prune operation.
255307

256308
### Distributed Locking Mechanism
257309

310+
Key: `DistributedLockingMechanism`
311+
258312
This is not a setting that commonly needs to be configured.
259313

260314
Gets or sets a value representing the DistributedLockingMechanism to use.
@@ -266,12 +320,16 @@ Valid values:
266320

267321
### Distributed Read Lock DefaultTimeout
268322

323+
Key: `DistributedLockingReadLockDefaultTimeout` (default: `00:01:00`)
324+
269325
Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed read lock.
270326

271327
The default value is 60 seconds.
272328

273329
### Distributed Write Lock DefaultTimeout
274330

331+
Key: `DistributedLockingWriteLockDefaultTimeout` (default: `00:00:05`)
332+
275333
Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed write lock.
276334

277335
The default value is 5 seconds.

0 commit comments

Comments
 (0)