-
Notifications
You must be signed in to change notification settings - Fork 12
/
appsettings-schema.Umbraco.Cms.json
1959 lines (1959 loc) · 75.2 KB
/
appsettings-schema.Umbraco.Cms.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UmbracoCmsSchema",
"type": "object",
"properties": {
"Umbraco": {
"$ref": "#/definitions/UmbracoDefinition"
}
},
"definitions": {
"UmbracoDefinition": {
"type": "object",
"description": "Configuration container for all Umbraco products.",
"properties": {
"CMS": {
"$ref": "#/definitions/UmbracoCmsDefinition"
}
}
},
"UmbracoCmsDefinition": {
"type": "object",
"description": "Configuration of Umbraco CMS.",
"properties": {
"Content": {
"$ref": "#/definitions/ContentSettings"
},
"DeliveryApi": {
"$ref": "#/definitions/DeliveryApiSettings"
},
"Debug": {
"$ref": "#/definitions/CoreDebugSettings"
},
"ExceptionFilter": {
"$ref": "#/definitions/ExceptionFilterSettings"
},
"ModelsBuilder": {
"$ref": "#/definitions/ModelsBuilderSettings"
},
"Global": {
"$ref": "#/definitions/GlobalSettings"
},
"HealthChecks": {
"$ref": "#/definitions/HealthChecksSettings"
},
"Hosting": {
"$ref": "#/definitions/HostingSettings"
},
"Imaging": {
"$ref": "#/definitions/ImagingSettings"
},
"Examine": {
"$ref": "#/definitions/IndexCreatorSettings"
},
"Indexing": {
"$ref": "#/definitions/IndexingSettings"
},
"KeepAlive": {
"$ref": "#/definitions/KeepAliveSettings"
},
"Logging": {
"$ref": "#/definitions/LoggingSettings"
},
"NuCache": {
"$ref": "#/definitions/NuCacheSettings"
},
"RequestHandler": {
"$ref": "#/definitions/RequestHandlerSettings"
},
"Runtime": {
"$ref": "#/definitions/RuntimeSettings"
},
"Security": {
"$ref": "#/definitions/SecuritySettings"
},
"Tours": {
"$ref": "#/definitions/TourSettings"
},
"TypeFinder": {
"$ref": "#/definitions/TypeFinderSettings"
},
"WebRouting": {
"$ref": "#/definitions/WebRoutingSettings"
},
"Plugins": {
"$ref": "#/definitions/UmbracoPluginSettings"
},
"Unattended": {
"$ref": "#/definitions/UnattendedSettings"
},
"RichTextEditor": {
"$ref": "#/definitions/RichTextEditorSettings"
},
"RuntimeMinification": {
"$ref": "#/definitions/RuntimeMinificationSettings"
},
"BasicAuth": {
"$ref": "#/definitions/BasicAuthSettings"
},
"PackageMigration": {
"$ref": "#/definitions/PackageMigrationSettings"
},
"LegacyPasswordMigration": {
"$ref": "#/definitions/LegacyPasswordMigrationSettings"
},
"ContentDashboard": {
"$ref": "#/definitions/ContentDashboardSettings"
},
"HelpPage": {
"$ref": "#/definitions/HelpPageSettings"
},
"DefaultDataCreation": {
"$ref": "#/definitions/InstallDefaultDataSettings"
},
"DataTypes": {
"$ref": "#/definitions/DataTypesSettings"
},
"Marketplace": {
"$ref": "#/definitions/MarketplaceSettings"
},
"Webhook": {
"$ref": "#/definitions/WebhookSettings"
}
}
},
"ContentSettings": {
"type": "object",
"description": "Typed configuration options for content settings.\n ",
"properties": {
"Notifications": {
"description": "Gets or sets a value for the content notification settings.\n ",
"oneOf": [
{
"$ref": "#/definitions/ContentNotificationSettings"
}
]
},
"Imaging": {
"description": "Gets or sets a value for the content imaging settings.\n ",
"oneOf": [
{
"$ref": "#/definitions/ContentImagingSettings"
}
]
},
"ResolveUrlsFromTextString": {
"type": "boolean",
"description": "Gets or sets a value indicating whether URLs should be resolved from text strings.\n ",
"default": false
},
"Error404Collection": {
"type": "array",
"description": "Gets or sets a value for the collection of error pages.\n ",
"items": {
"$ref": "#/definitions/ContentErrorPage"
}
},
"PreviewBadge": {
"type": "string",
"description": "Gets or sets a value for the preview badge mark-up.\n ",
"default": "\n <div id=\"umbracoPreviewBadge\" class=\"umbraco-preview-badge\">\n <span class=\"umbraco-preview-badge__header\">Preview mode</span>\n <a href=\"{0}/preview/?id={2}\" class=\"umbraco-preview-badge__a open\" title=\"Open preview in BackOffice\">\n …\n </a>\n <a href=\"{0}/preview/end?redir={1}\" class=\"umbraco-preview-badge__a end\" title=\"End preview mode\">\n <svg viewBox=\"0 0 100 100\" xmlns=\"http://www.w3.org/2000/svg\"><title>Click to end preview mode</title><path fill=\"#fff\" d=\"M5273.1 2400.1v-2c0-2.8-5-4-9.7-4s-9.7 1.3-9.7 4v2a7 7 0 002 4.9l5 4.9c.3.3.4.6.4 1v6.4c0 .4.2.7.6.8l2.9.9c.5.1 1-.2 1-.8v-7.2c0-.4.2-.7.4-1l5.1-5a7 7 0 002-4.9zm-9.7-.1c-4.8 0-7.4-1.3-7.5-1.8.1-.5 2.7-1.8 7.5-1.8s7.3 1.3 7.5 1.8c-.2.5-2.7 1.8-7.5 1.8z\"/><path fill=\"#fff\" d=\"M5268.4 2410.3c-.6 0-1 .4-1 1s.4 1 1 1h4.3c.6 0 1-.4 1-1s-.4-1-1-1h-4.3zM5272.7 2413.7h-4.3c-.6 0-1 .4-1 1s.4 1 1 1h4.3c.6 0 1-.4 1-1s-.4-1-1-1zM5272.7 2417h-4.3c-.6 0-1 .4-1 1s.4 1 1 1h4.3c.6 0 1-.4 1-1 0-.5-.4-1-1-1z\"/><path fill=\"#fff\" d=\"M78.2 13l-8.7 11.7a32.5 32.5 0 11-51.9 25.8c0-10.3 4.7-19.7 12.9-25.8L21.8 13a47 47 0 1056.4 0z\"/><path fill=\"#fff\" d=\"M42.7 2.5h14.6v49.4H42.7z\"/></svg>\n </a>\n </div>\n <style type=\"text/css\">\n .umbraco-preview-badge {{\n position: fixed;\n bottom: 0;\n display: inline-flex;\n background: rgba(27, 38, 79, 0.9);\n color: #fff;\n font-size: 12px;\n z-index: 99999999;\n justify-content: center;\n align-items: center;\n box-shadow: 0 5px 10px rgba(0, 0, 0, .2), 0 1px 2px rgba(0, 0, 0, .2);\n line-height: 1;\n pointer-events:none;\n left: 50%;\n transform: translate(-50%, 40px);\n animation: umbraco-preview-badge--effect 10s 1.2s ease both;\n border-radius: 3px 3px 0 0;\n }}\n @keyframes umbraco-preview-badge--effect {{\n 0% {{\n transform: translate(-50%, 40px);\n animation-timing-function: ease-out;\n }}\n 1.5% {{\n transform: translate(-50%, -20px);\n animation-timing-function: ease-in;\n }}\n 5.0% {{\n transform: translate(-50%, -8px);\n animation-timing-function: ease-in;\n }}\n 7.5% {{\n transform: translate(-50%, -4px);\n animation-timing-function: ease-in;\n }}\n 9.2% {{\n transform: translate(-50%, -2px);\n animation-timing-function: ease-in;\n }}\n 3.5%,\n 6.5%,\n 8.5% {{\n transform: translate(-50%, 0);\n animation-timing-function: ease-out;\n }}\n 9.7% {{\n transform: translate(-50%, 0);\n animation-timing-function: ease-out;\n }}\n 10.0% {{\n transform: translate(-50%, 0);\n }}\n\n\n 60% {{\n transform: translate(-50%, 0);\n animation-timing-function: ease-out;\n }}\n 61.5% {{\n transform: translate(-50%, -20px);\n animation-timing-function: ease-in;\n }}\n 65.0% {{\n transform: translate(-50%, -8px);\n animation-timing-function: ease-in;\n }}\n 67.5% {{\n transform: translate(-50%, -4px);\n animation-timing-function: ease-in;\n }}\n 69.2% {{\n transform: translate(-50%, -2px);\n animation-timing-function: ease-in;\n }}\n 63.5%,\n 66.5%,\n 68.5% {{\n transform: translate(-50%, 0);\n animation-timing-function: ease-out;\n }}\n 69.7% {{\n transform: translate(-50%, 0);\n animation-timing-function: ease-out;\n }}\n 70.0% {{\n transform: translate(-50%, 0);\n }}\n 100.0% {{\n transform: translate(-50%, 0);\n }}\n }}\n .umbraco-preview-badge__header {{\n padding: 1em;\n font-weight: bold;\n pointer-events:none;\n }}\n .umbraco-preview-badge__a {{\n width: 3em;\n padding: 1em;\n display: flex;\n flex-shrink: 0;\n align-items: center;\n align-self: stretch;\n color:white;\n text-decoration:none;\n font-weight: bold;\n border-left: 1px solid hsla(0,0%,100%,.25);\n pointer-events:all;\n }}\n .umbraco-preview-badge__a svg {{\n width: 1em;\n height:1em;\n }}\n .umbraco-preview-badge__a:hover {{\n background: #202d5e;\n }}\n .umbraco-preview-badge__end svg {{\n fill: #fff;\n width:1em;\n }}\n </style>\n <script type=\"text/javascript\" data-umbraco-path=\"{0}\" src=\"{0}/js/umbraco.websitepreview.min.js\"></script>"
},
"MacroErrors": {
"description": "Gets or sets a value for the macro error behaviour.\n ",
"default": "Inline",
"oneOf": [
{
"$ref": "#/definitions/MacroErrorBehaviour"
}
]
},
"ShowDeprecatedPropertyEditors": {
"type": "boolean",
"description": "Gets or sets a value indicating whether deprecated property editors should be shown.\n ",
"default": false
},
"LoginBackgroundImage": {
"type": "string",
"description": "Gets or sets a value for the path to the login screen background image.\n ",
"default": "assets/img/login.jpg"
},
"LoginLogoImage": {
"type": "string",
"description": "Gets or sets a value for the path to the login screen logo image\nshown on top of the background image set in LoginBackgroundImage.\n ",
"default": "assets/img/application/umbraco_logo_blue.svg"
},
"LoginLogoImageAlternative": {
"type": "string",
"description": "Gets or sets a value for the path to the login screen logo image when shown on top\nof a light background (e.g. in mobile resolutions).\n ",
"default": "assets/img/application/umbraco_logo_blue.svg"
},
"HideBackOfficeLogo": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to hide the backoffice umbraco logo or not.\n ",
"default": false
},
"DisableDeleteWhenReferenced": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to disable the deletion of items referenced by other items.\n ",
"default": false
},
"DisableUnpublishWhenReferenced": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to disable the unpublishing of items referenced by other items.\n ",
"default": false
},
"ContentVersionCleanupPolicy": {
"description": "Gets or sets the model representing the global content version cleanup policy\n ",
"oneOf": [
{
"$ref": "#/definitions/ContentVersionCleanupPolicySettings"
}
]
},
"AllowEditInvariantFromNonDefault": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to allow editing invariant properties from a non-default language variation.",
"default": false
},
"AllowedUploadedFileExtensions": {
"type": "array",
"description": "Gets or sets a value for the collection of file extensions that are allowed for upload.\n ",
"items": {
"type": "string"
}
},
"DisallowedUploadedFileExtensions": {
"type": "array",
"description": "Gets or sets a value for the collection of file extensions that are disallowed for upload.\n ",
"default": "ashx,aspx,ascx,config,cshtml,vbhtml,asmx,air,axd,xamlx",
"items": {
"type": "string"
}
},
"AllowedMediaHosts": {
"type": "array",
"description": "Gets or sets the allowed external host for media. If empty only relative paths are allowed.",
"items": {
"type": "string"
}
},
"ShowDomainWarnings": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to show domain warnings.",
"default": true
}
}
},
"ContentNotificationSettings": {
"type": "object",
"description": "Typed configuration options for content notification settings.\n ",
"properties": {
"Email": {
"type": [
"null",
"string"
],
"description": "Gets or sets a value for the email address for notifications.\n "
},
"DisableHtmlEmail": {
"type": "boolean",
"description": "Gets or sets a value indicating whether HTML email notifications should be disabled.\n ",
"default": false
}
}
},
"ContentImagingSettings": {
"type": "object",
"description": "Typed configuration options for content imaging settings.\n ",
"properties": {
"ImageFileTypes": {
"type": "array",
"description": "Gets or sets a value for the collection of accepted image file extensions.\n ",
"default": "jpeg,jpg,gif,bmp,png,tiff,tif,webp",
"items": {
"type": "string"
}
},
"AutoFillImageProperties": {
"type": "array",
"description": "Gets or sets a value for the imaging autofill following media file upload fields.\n ",
"items": {
"$ref": "#/definitions/ImagingAutoFillUploadField"
}
}
}
},
"ImagingAutoFillUploadField": {
"type": "object",
"description": "Typed configuration options for image autofill upload settings.\n ",
"required": [
"Alias",
"WidthFieldAlias",
"HeightFieldAlias",
"LengthFieldAlias",
"ExtensionFieldAlias"
],
"properties": {
"Alias": {
"type": "string",
"description": "Gets or sets a value for the alias of the image upload property.\n ",
"minLength": 1
},
"WidthFieldAlias": {
"type": "string",
"description": "Gets or sets a value for the width field alias of the image upload property.\n ",
"minLength": 1
},
"HeightFieldAlias": {
"type": "string",
"description": "Gets or sets a value for the height field alias of the image upload property.\n ",
"minLength": 1
},
"LengthFieldAlias": {
"type": "string",
"description": "Gets or sets a value for the length field alias of the image upload property.\n ",
"minLength": 1
},
"ExtensionFieldAlias": {
"type": "string",
"description": "Gets or sets a value for the extension field alias of the image upload property.\n ",
"minLength": 1
}
}
},
"ContentErrorPage": {
"type": "object",
"description": "Typed configuration for a content error page.\n ",
"required": [
"Culture"
],
"properties": {
"ContentId": {
"type": "integer",
"description": "Gets or sets a value for the content Id.\n ",
"format": "int32"
},
"ContentKey": {
"type": "string",
"description": "Gets or sets a value for the content key.\n ",
"format": "guid"
},
"Culture": {
"type": "string",
"description": "Gets or sets a value for the content culture.\n ",
"minLength": 1
}
}
},
"MacroErrorBehaviour": {
"type": "string",
"description": "",
"x-enumNames": [
"Inline",
"Silent",
"Throw",
"Content"
],
"enum": [
"Inline",
"Silent",
"Throw",
"Content"
]
},
"ContentVersionCleanupPolicySettings": {
"type": "object",
"description": "Model representing the global content version cleanup policy\n ",
"properties": {
"EnableCleanup": {
"type": "boolean",
"description": "Gets or sets a value indicating whether or not the cleanup job should be executed.\n ",
"default": false
},
"KeepAllVersionsNewerThanDays": {
"type": "integer",
"description": "Gets or sets the number of days where all historical content versions are kept.\n ",
"format": "int32",
"default": 7
},
"KeepLatestVersionPerDayForDays": {
"type": "integer",
"description": "Gets or sets the number of days where the latest historical content version for that day are kept.\n ",
"format": "int32",
"default": 90
}
}
},
"DeliveryApiSettings": {
"type": "object",
"description": "Typed configuration options for Delivery API settings.\n ",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Delivery API should be enabled.\n ",
"default": false
},
"PublicAccess": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Delivery API (if enabled) should be\npublicly available or should require an API key for access.\n ",
"default": true
},
"ApiKey": {
"type": [
"null",
"string"
],
"description": "Gets or sets the API key used for authorizing API access (if the API is not publicly available) and preview access.\n "
},
"DisallowedContentTypeAliases": {
"type": "array",
"description": "Gets or sets the aliases of the content types that may never be exposed through the Delivery API. Content of these\ntypes will never be returned from any Delivery API endpoint, nor added to the query index.\n ",
"items": {
"type": "string"
}
},
"RichTextOutputAsJson": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Delivery API should output rich text values as JSON instead of HTML.\n ",
"default": false
},
"Media": {
"description": "Gets or sets the settings for the Media APIs of the Delivery API.\n ",
"oneOf": [
{
"$ref": "#/definitions/MediaSettings"
}
]
},
"MemberAuthorization": {
"description": "Gets or sets the member authorization settings for the Delivery API.\n ",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/MemberAuthorizationSettings"
}
]
},
"OutputCache": {
"description": "Gets or sets the settings for the Delivery API output cache.\n ",
"oneOf": [
{
"$ref": "#/definitions/OutputCacheSettings"
}
]
}
}
},
"MediaSettings": {
"type": "object",
"description": "Typed configuration options for the Media APIs of the Delivery API.\n ",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Media APIs of the Delivery API should be enabled.\n ",
"default": false
},
"PublicAccess": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Media APIs of the Delivery API (if enabled) should be\npublicly available or should require an API key for access.\n ",
"default": true
}
}
},
"MemberAuthorizationSettings": {
"type": "object",
"description": "Typed configuration options for member authorization settings for the Delivery API.\n ",
"properties": {
"AuthorizationCodeFlow": {
"description": "Gets or sets the Authorization Code Flow configuration for the Delivery API.\n ",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/AuthorizationCodeFlowSettings"
}
]
}
}
},
"AuthorizationCodeFlowSettings": {
"type": "object",
"description": "Typed configuration options for the Authorization Code Flow settings for the Delivery API.\n ",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether Authorization Code Flow should be enabled for the Delivery API.\n ",
"default": false
},
"LoginRedirectUrls": {
"type": "array",
"description": "Gets or sets the URLs allowed to use as redirect targets after a successful login (session authorization).\n ",
"items": {
"type": "string",
"format": "uri"
}
},
"LogoutRedirectUrls": {
"type": "array",
"description": "Gets or sets the URLs allowed to use as redirect targets after a successful logout (session termination).\n ",
"items": {
"type": "string",
"format": "uri"
}
}
}
},
"OutputCacheSettings": {
"type": "object",
"description": "Typed configuration options for output caching of the Delivery API.\n ",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Delivery API output should be cached.\n ",
"default": false
},
"ContentDuration": {
"type": "string",
"description": "Gets or sets a value indicating how long the Content Delivery API output should be cached.\n ",
"format": "duration",
"default": "00:01:00"
},
"MediaDuration": {
"type": "string",
"description": "Gets or sets a value indicating how long the Media Delivery API output should be cached.\n ",
"format": "duration",
"default": "00:01:00"
}
}
},
"CoreDebugSettings": {
"type": "object",
"description": "Typed configuration options for core debug settings.\n ",
"properties": {
"LogIncompletedScopes": {
"type": "boolean",
"description": "Gets or sets a value indicating whether incompleted scopes should be logged.\n ",
"default": false
},
"DumpOnTimeoutThreadAbort": {
"type": "boolean",
"description": "Gets or sets a value indicating whether memory dumps on thread abort should be taken.\n ",
"default": false
}
}
},
"ExceptionFilterSettings": {
"type": "object",
"description": "Typed configuration options for exception filter settings.\n ",
"properties": {
"Disabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the exception filter is disabled.\n ",
"default": false
}
}
},
"ModelsBuilderSettings": {
"type": "object",
"description": "Typed configuration options for models builder settings.\n ",
"properties": {
"ModelsMode": {
"description": "Gets or sets a value for the models mode.\n ",
"default": "InMemoryAuto",
"oneOf": [
{
"$ref": "#/definitions/ModelsMode"
}
]
},
"ModelsNamespace": {
"type": "string",
"description": "Gets or sets a value for models namespace.\n ",
"default": "Umbraco.Cms.Web.Common.PublishedModels"
},
"FlagOutOfDateModels": {
"type": "boolean",
"description": "Gets or sets a value indicating whether we should flag out-of-date models.\n "
},
"ModelsDirectory": {
"type": "string",
"description": "Gets or sets a value for the models directory.\n ",
"default": "~/umbraco/models"
},
"AcceptUnsafeModelsDirectory": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to accept an unsafe value for ModelsDirectory.\n ",
"default": false
},
"DebugLevel": {
"type": "integer",
"description": "Gets or sets a value indicating the debug log level.\n ",
"format": "int32",
"default": 0
}
}
},
"ModelsMode": {
"type": "string",
"description": "Defines the models generation modes.\n ",
"x-enumNames": [
"Nothing",
"InMemoryAuto",
"SourceCodeManual",
"SourceCodeAuto"
],
"enum": [
"Nothing",
"InMemoryAuto",
"SourceCodeManual",
"SourceCodeAuto"
]
},
"GlobalSettings": {
"type": "object",
"description": "Typed configuration options for global settings.\n ",
"properties": {
"ReservedUrls": {
"type": "string",
"description": "Gets or sets a value for the reserved URLs (must end with a comma).\n ",
"default": "~/.well-known,"
},
"ReservedPaths": {
"type": "string",
"description": "Gets or sets a value for the reserved paths (must end with a comma).\n ",
"default": "~/app_plugins/,~/install/,~/mini-profiler-resources/,~/umbraco/,"
},
"TimeOut": {
"type": "string",
"description": "Gets or sets a value for the back-office login timeout.\n ",
"format": "duration",
"default": "00:20:00"
},
"DefaultUILanguage": {
"type": "string",
"description": "Gets or sets a value for the default UI language.\n ",
"default": "en-US"
},
"HideTopLevelNodeFromPath": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to hide the top level node from the path.\n ",
"default": true
},
"UseHttps": {
"type": "boolean",
"description": "Gets or sets a value indicating whether HTTPS should be used.\n ",
"default": false
},
"VersionCheckPeriod": {
"type": "integer",
"description": "Gets or sets a value for the version check period in days.\n ",
"format": "int32",
"default": 7
},
"IconsPath": {
"type": "string",
"description": "Gets or sets a value for the Umbraco icons path.\n ",
"default": "umbraco/assets/icons"
},
"UmbracoCssPath": {
"type": "string",
"description": "Gets or sets a value for the Umbraco CSS path.\n ",
"default": "~/css"
},
"UmbracoScriptsPath": {
"type": "string",
"description": "Gets or sets a value for the Umbraco scripts path.\n ",
"default": "~/scripts"
},
"UmbracoMediaPath": {
"type": "string",
"description": "Gets or sets a value for the Umbraco media request path.\n ",
"default": "~/media"
},
"UmbracoMediaPhysicalRootPath": {
"type": "string",
"description": "Gets or sets a value for the physical Umbraco media root path (falls back to UmbracoMediaPath when\nempty).\n "
},
"InstallMissingDatabase": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to install the database when it is missing.\n ",
"default": false
},
"DisableElectionForSingleServer": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to disable the election for a single server.\n ",
"default": false
},
"DatabaseFactoryServerVersion": {
"type": "string",
"description": "Gets or sets a value for the database factory server version.\n "
},
"MainDomLock": {
"type": "string",
"description": "Gets or sets a value for the main dom lock.\n "
},
"MainDomKeyDiscriminator": {
"type": "string",
"description": "Gets or sets a value to discriminate MainDom boundaries.\n\n Generally the default should suffice but useful for advanced scenarios e.g. azure deployment slot based zero\n downtime deployments.\n\n "
},
"MainDomReleaseSignalPollingInterval": {
"type": "integer",
"description": "Gets or sets the duration (in milliseconds) for which the MainDomLock release signal polling task should sleep.\n ",
"format": "int32",
"default": 2000
},
"Id": {
"type": "string",
"description": "Gets or sets the telemetry ID.\n "
},
"NoNodesViewPath": {
"type": "string",
"description": "Gets or sets a value for the path to the no content view.\n ",
"default": "~/umbraco/UmbracoWebsite/NoNodes.cshtml"
},
"DatabaseServerRegistrar": {
"description": "Gets or sets a value for the database server registrar settings.\n ",
"oneOf": [
{
"$ref": "#/definitions/DatabaseServerRegistrarSettings"
}
]
},
"DatabaseServerMessenger": {
"description": "Gets or sets a value for the database server messenger settings.\n ",
"oneOf": [
{
"$ref": "#/definitions/DatabaseServerMessengerSettings"
}
]
},
"Smtp": {
"description": "Gets or sets a value for the SMTP settings.\n ",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/SmtpSettings"
}
]
},
"SanitizeTinyMce": {
"type": "boolean",
"description": "Gets or sets a value indicating whether TinyMCE scripting sanitization should be applied.\n ",
"default": false
},
"DistributedLockingReadLockDefaultTimeout": {
"type": "string",
"description": "Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed read lock.\n ",
"format": "duration",
"default": "00:01:00"
},
"DistributedLockingWriteLockDefaultTimeout": {
"type": "string",
"description": "Gets or sets a value representing the maximum time to wait whilst attempting to obtain a distributed write lock.\n ",
"format": "duration",
"default": "00:00:05"
},
"DistributedLockingMechanism": {
"type": "string",
"description": "Gets or sets a value representing the DistributedLockingMechanism to use."
},
"ForceCombineUrlPathLeftToRight": {
"type": "boolean",
"description": "Force url paths to be left to right, even when the culture has right to left text",
"default": true,
"x-example": "For the following hierarchy\n- Root (/ar)\n - 1 (/ar/1)\n - 2 (/ar/1/2)\n - 3 (/ar/1/2/3)\n - 3 (/ar/1/2/3/4)\nWhen forced\n- https://www.umbraco.com/ar/1/2/3/4\nwhen not\n- https://www.umbraco.com/ar/4/3/2/1"
},
"ShowMaintenancePageWhenInUpgradeState": {
"type": "boolean",
"default": true
}
}
},
"DatabaseServerRegistrarSettings": {
"type": "object",
"description": "Typed configuration options for database server registrar settings.\n ",
"properties": {
"WaitTimeBetweenCalls": {
"type": "string",
"description": "Gets or sets a value for the amount of time to wait between calls to the database on the background thread.\n ",
"format": "duration",
"default": "00:01:00"
},
"StaleServerTimeout": {
"type": "string",
"description": "Gets or sets a value for the time span to wait before considering a server stale, after it has last been accessed.\n ",
"format": "duration",
"default": "00:02:00"
}
}
},
"DatabaseServerMessengerSettings": {
"type": "object",
"description": "Typed configuration options for database server messaging settings.\n ",
"properties": {
"MaxProcessingInstructionCount": {
"type": "integer",
"description": "Gets or sets a value for the maximum number of instructions that can be processed at startup; otherwise the server\ncold-boots (rebuilds its caches).\n ",
"format": "int32",
"default": 1000
},
"TimeToRetainInstructions": {
"type": "string",
"description": "Gets or sets a value for the time to keep instructions in the database; records older than this number will be\npruned.\n ",
"format": "duration",
"default": "2.00:00:00"
},
"TimeBetweenSyncOperations": {
"type": "string",
"description": "Gets or sets a value for the time to wait between each sync operations.\n ",
"format": "duration",
"default": "00:00:05"
},
"TimeBetweenPruneOperations": {
"type": "string",
"description": "Gets or sets a value for the time to wait between each prune operations.\n ",
"format": "duration",
"default": "00:01:00"
}
}
},
"SmtpSettings": {
"type": "object",
"description": "Typed configuration options for SMTP settings.\n ",
"required": [
"From"
],
"properties": {
"From": {
"type": "string",
"description": "Gets or sets a value for the SMTP from address to use for messages.\n ",
"format": "email",
"minLength": 1
},
"Host": {
"type": [
"null",
"string"
],
"description": "Gets or sets a value for the SMTP host.\n "
},
"Port": {
"type": "integer",
"description": "Gets or sets a value for the SMTP port.\n ",
"format": "int32"
},
"SecureSocketOptions": {
"description": "Gets or sets a value for the secure socket options.\n ",
"default": "Auto",
"oneOf": [
{
"$ref": "#/definitions/SecureSocketOptions"
}
]
},
"PickupDirectoryLocation": {
"type": [
"null",
"string"
],
"description": "Gets or sets a value for the SMTP pick-up directory.\n "
},
"DeliveryMethod": {
"description": "Gets or sets a value for the SMTP delivery method.\n ",
"default": "Network",
"oneOf": [
{
"$ref": "#/definitions/SmtpDeliveryMethod"
}
]
},
"Username": {
"type": [
"null",
"string"
],
"description": "Gets or sets a value for the SMTP user name.\n "
},
"Password": {
"type": [
"null",
"string"
],
"description": "Gets or sets a value for the SMTP password.\n "
}
}
},
"SecureSocketOptions": {
"type": "string",
"description": "Matches MailKit.Security.SecureSocketOptions and defined locally to avoid having to take\na dependency on this external library into Umbraco.Core.\n ",
"x-enumNames": [
"None",
"Auto",
"SslOnConnect",
"StartTls",
"StartTlsWhenAvailable"
],
"enum": [
"None",
"Auto",
"SslOnConnect",
"StartTls",
"StartTlsWhenAvailable"
]
},
"SmtpDeliveryMethod": {
"type": "string",
"description": "",
"x-enumNames": [
"Network",
"SpecifiedPickupDirectory",
"PickupDirectoryFromIis"
],
"enum": [
"Network",
"SpecifiedPickupDirectory",
"PickupDirectoryFromIis"
]
},
"HealthChecksSettings": {
"type": "object",
"description": "Typed configuration options for healthchecks settings.\n ",
"properties": {
"DisabledChecks": {
"type": "array",
"description": "Gets or sets a value for the collection of healthchecks that are disabled.\n ",
"items": {
"$ref": "#/definitions/DisabledHealthCheckSettings"
}
},
"Notification": {
"description": "Gets or sets a value for the healthcheck notification settings.\n ",
"oneOf": [
{
"$ref": "#/definitions/HealthChecksNotificationSettings"
}
]
}
}
},
"DisabledHealthCheckSettings": {
"type": "object",
"description": "Typed configuration options for disabled healthcheck settings.\n ",
"properties": {
"Id": {
"type": "string",
"description": "Gets or sets a value for the healthcheck Id to disable.\n ",
"format": "guid"
},
"DisabledOn": {
"type": "string",
"description": "Gets or sets a value for the date the healthcheck was disabled.\n ",
"format": "date-time"
},
"DisabledBy": {
"type": "integer",
"description": "Gets or sets a value for Id of the user that disabled the healthcheck.\n ",
"format": "int32"
}
}
},
"HealthChecksNotificationSettings": {
"type": "object",
"description": "Typed configuration options for healthcheck notification settings.\n ",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether health check notifications are enabled.\n ",
"default": false
},
"FirstRunTime": {
"type": "string",
"description": "Gets or sets a value for the first run time of a healthcheck notification in crontab format.\n "
},
"Period": {
"type": "string",
"description": "Gets or sets a value for the period of the healthcheck notification.\n ",
"format": "duration",
"default": "1.00:00:00"
},
"NotificationMethods": {
"type": "object",
"description": "Gets or sets a value for the collection of health check notification methods.\n ",
"additionalProperties": {
"$ref": "#/definitions/HealthChecksNotificationMethodSettings"
}
},
"DisabledChecks": {
"type": "array",
"description": "Gets or sets a value for the collection of health checks that are disabled for notifications.\n ",
"items": {
"$ref": "#/definitions/DisabledHealthCheckSettings"
}
}
}
},