Skip to content

Commit 91f6207

Browse files
authored
Update globalsettings.md
Added value type as well
1 parent 1a056ad commit 91f6207

File tree

1 file changed

+58
-29
lines changed

1 file changed

+58
-29
lines changed

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

Lines changed: 58 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -65,107 +65,123 @@ In the root level section, that is those without a seperate sub section like SMT
6565

6666
### Reserved urls
6767

68-
Key: `ReservedUrls` (default: `~/.well-known,`)
68+
Key: `ReservedUrls`
69+
Type: `string` (default: `~/.well-known,`)
6970

7071
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.
7172

7273
### Reserved paths
7374

74-
Key: `ReservedPaths` (default: `~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,`)
75+
Key: `ReservedPaths`
76+
Type: `string` (default: `~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,`)
7577

7678
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.
7779

7880
{% 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 %}
7981

8082
### Timeout
8183

82-
Key: `TimeOut` (default: `00:20:00`)
84+
Key: `TimeOut`
85+
Type: `string` (default: `00:20:00`)
8386

8487
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.
8588

8689
{% 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 %}
8790

8891
### Default UI language
8992

90-
Key: `DefaultUILanguage` (default: `en-US`)
93+
Key: `DefaultUILanguage`
94+
Type: `string` (default: `en-US`)
9195

9296
The default language to use in the backoffice if a user isn't explicitly assigned one.
9397

9498
### Hide top level nodes from path
9599

96-
Key: `HideTopLevelNodeFromPath`
100+
Key: `HideTopLevelNodeFromPath`
101+
Type: `bool` (default: `true`)
97102

98103
If you are running multiple sites, you don't want the top level node in your URL and can disable it with this setting.
99104

100105
### Use https
101106

102-
Key: `UseHttps` (default: `false`)
107+
Key: `UseHttps`
108+
Type: `bool` (default: `false`)
103109

104110
Makes sure that all of the requests in the backoffice are called over HTTPS instead of HTTP when set to true.
105111

106112
### Version check period
107113

108-
Key: `VersionCheckPeriod` (default: `7`)
114+
Key: `VersionCheckPeriod`
115+
Type: `int` (default: `7`)
109116

110117
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.
111118

112119
### Icons path
113120

114-
Key: `IconsPath` (default: `umbraco/assets/icons`)
121+
Key: `IconsPath`
122+
Type: `string` (default: `umbraco/assets/icons`)
115123

116124
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.
117125

118126
### Umbraco CSS path
119127

120-
Key: `UmbracoCssPath` (default: `~/css`)
128+
Key: `UmbracoCssPath`
129+
Type: `string` (default: `~/css`)
121130

122131
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/)
123132

124133
### Umbraco scripts path
125134

126-
Key: `UmbracoScriptsPath` (default: `~/scripts`)
135+
Key: `UmbracoScriptsPath`
136+
Type: `string` (default: `~/scripts`)
127137

128138
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/)
129139

130140
### Umbraco media path
131141

132-
Key: `UmbracoMediaPath` (default: `~/media`)
142+
Key: `UmbracoMediaPath`
143+
Type: `string` (default: `~/media`)
133144

134145
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/)
135146

136147
### Umbraco media physical root path
137148

138-
Key: `UmbracoMediaPhysicalRootPath` (default: `~/media`)
149+
Key: `UmbracoMediaPhysicalRootPath`
150+
Type: `string` (default: `~/media`)
139151

140152
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/)
141153

142154
### Install missing database
143155

144-
Key: `InstallMissingDatabase` (default: `false`)
156+
Key: `InstallMissingDatabase`
157+
Type: `bool` (default: `false`)
145158

146159
This is not a setting that commonly needs to be configured.
147160

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

150163
### Disable election for single server
151164

152-
Key: `DisableElectionForSingleServer` (default: `false`)
165+
Key: `DisableElectionForSingleServer`
166+
Type: `bool` (default: `false`)
153167

154168
This is not a setting that commonly needs to be configured.
155169

156170
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.
157171

158172
### Database factory version
159173

160-
Key: `DatabaseFactoryServerVersion` (default: `false`)
174+
Key: `DatabaseFactoryServerVersion`
175+
Type: `bool` (default: `false`)
161176

162177
This is not a setting that commonly needs to be configured.
163178

164179
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"`
165180

166181
### Main dom lock
167182

168-
Key: `MainDomLock`
183+
Key: `MainDomLock`
184+
Type: `string`
169185

170186
Specifies the implementation of IMainDomLock to be used.
171187

@@ -181,7 +197,8 @@ The default implementation unless configured otherwise is `FileSystemMainDomLock
181197

182198
### Main dom key discriminator
183199

184-
Key: `MainDomKeyDiscriminator`
200+
Key: `MainDomKeyDiscriminator`
201+
Type: `string`
185202

186203
For advanced use cases e.g. deployment slot swapping on Azure app services.
187204

@@ -199,21 +216,24 @@ It's worth noting that during the swap operation there is a period where both in
199216

200217
### Main dom release signal polling interval
201218

202-
Key: `MainDomReleaseSignalPollingInterval`
219+
Key: `MainDomReleaseSignalPollingInterval`
220+
Type: `string`
203221

204222
Gets or sets the duration (in milliseconds) for which the MainDomLock release signal polling task should sleep. The default value is 2000ms.
205223

206224
### Id
207225

208-
Key: `Id`
226+
Key: `Id`
227+
Type: `string`
209228

210229
This setting doesn't need to be configured.
211230

212231
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.
213232

214233
### No nodes view path
215234

216-
Key: `NoNodesViewPath` (default: `~/umbraco/UmbracoWebsite/NoNodes.cshtml`)
235+
Key: `NoNodesViewPath`
236+
Type: `string` (default: `~/umbraco/UmbracoWebsite/NoNodes.cshtml`)
217237

218238
This setting specifies what view to render when there is no content on the site.
219239

@@ -267,13 +287,15 @@ It's unlikely that you will have to change these settings unless you're using a
267287

268288
### Wait time between calls
269289

270-
Key: `DatabaseServerRegistrar.WaitTimeBetweenCalls` (default: `00:01:00`)
290+
Key: `DatabaseServerRegistrar.WaitTimeBetweenCalls`
291+
Type: `string` (default: `00:01:00`)
271292

272293
Sets a value for the amount of time to wait between calls to the database on the background thread.
273294

274295
### Stale server timeout
275296

276-
Key: `DatabaseServerRegistrar.StaleServerTimeout` (default: `00:02:00`)
297+
Key: `DatabaseServerRegistrar.StaleServerTimeout`
298+
Type: `string` (default: `00:02:00`)
277299

278300
Sets a value for the time span to wait before considering a server stale, after it has last been accessed.
279301

@@ -283,31 +305,36 @@ It's unlikely that you will have change these settings, unless you're using a lo
283305

284306
### Max processing instruction
285307

286-
Key: `DatabaseServerMessenger.MaxProcessingInstructionCount` (default: `1000`)
308+
Key: `DatabaseServerMessenger.MaxProcessingInstructionCount`
309+
Type: `string` (default: `1000`)
287310

288311
Sets a value for the maximum number of instructions that can be processed at startup; otherwise the server cold-boots (rebuilds its caches).
289312

290313
### Time to retain instructions
291314

292-
Key: `DatabaseServerMessenger.TimeToRetainInstructions` (default: `2.00:00:00`)
315+
Key: `DatabaseServerMessenger.TimeToRetainInstructions`
316+
Type: `string` (default: `2.00:00:00`)
293317

294318
Sets a value for the time to keep instructions in the database; records older than this number will be pruned.
295319

296320
### Time between sync operations
297321

298-
Key: `DatabaseServerMessenger.TimeBetweenSyncOperations` (default: `00:00:05`)
322+
Key: `DatabaseServerMessenger.TimeBetweenSyncOperations`
323+
Type: `string` (default: `00:00:05`)
299324

300325
Sets a value for the time to wait between each sync operation.
301326

302327
### Time between prune operations
303328

304-
Key: `DatabaseServerMessenger.TimeBetweenPruneOperations` (default: `00:01:00`)
329+
Key: `DatabaseServerMessenger.TimeBetweenPruneOperations`
330+
Type: `string` (default: `00:01:00`)
305331

306332
Sets a value for the time to wait between each prune operation.
307333

308334
### Distributed Locking Mechanism
309335

310-
Key: `DistributedLockingMechanism`
336+
Key: `DistributedLockingMechanism`
337+
Type: `string`
311338

312339
This is not a setting that commonly needs to be configured.
313340

@@ -320,15 +347,17 @@ Valid values:
320347

321348
### Distributed Read Lock DefaultTimeout
322349

323-
Key: `DistributedLockingReadLockDefaultTimeout` (default: `00:01:00`)
350+
Key: `DistributedLockingReadLockDefaultTimeout`
351+
Type: `string` (default: `00:01:00`)
324352

325353
Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed read lock.
326354

327355
The default value is 60 seconds.
328356

329357
### Distributed Write Lock DefaultTimeout
330358

331-
Key: `DistributedLockingWriteLockDefaultTimeout` (default: `00:00:05`)
359+
Key: `DistributedLockingWriteLockDefaultTimeout`
360+
Type: `string` (default: `00:00:05`)
332361

333362
Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed write lock.
334363

0 commit comments

Comments
 (0)