forked from mattermost/mattermost-webapp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
admin_definition.jsx
1899 lines (1886 loc) · 124 KB
/
admin_definition.jsx
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
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import React from 'react';
import {FormattedMessage} from 'react-intl';
import {Constants} from 'utils/constants';
import {ldapTest, invalidateAllCaches, reloadConfig, testS3Connection} from 'actions/admin_actions';
import SystemAnalytics from 'components/analytics/system_analytics';
import TeamAnalytics from 'components/analytics/team_analytics';
import {trackEvent} from 'actions/diagnostics_actions.jsx';
import Audits from './audits';
import CustomUrlSchemesSetting from './custom_url_schemes_setting.jsx';
import LicenseSettings from './license_settings';
import PermissionSchemesSettings from './permission_schemes_settings';
import PermissionSystemSchemeSettings from './permission_schemes_settings/permission_system_scheme_settings';
import PermissionTeamSchemeSettings from './permission_schemes_settings/permission_team_scheme_settings';
import SystemUsers from './system_users';
import ServerLogs from './server_logs';
import * as DefinitionConstants from './admin_definition_constants';
const FILE_STORAGE_DRIVER_LOCAL = 'local';
const FILE_STORAGE_DRIVER_S3 = 'amazons3';
const MEBIBYTE = Math.pow(1024, 2);
// admin_definitions data structure define the autogenerated admin_console
// section. It defines the structure of the menu based on sections, subsections
// and pages. Each page contains an schema which defines a component to use for
// render the entire section or the name of the section (name and
// name_default), the section in the config file (id), and a list of options to
// configure (settings).
//
// All text fiels contains a transation key, and the <field>_default string are the
// default text when the translation is still not avaiable (the english version
// of the text).
//
// We can define different types of settings configuration widgets:
//
// Widget:
// - type: which define the widget type.
// - label (and label_default): which define the main text of the setting.
// - isDisabled: a function which receive current config, the state of the page and the license.
// - isHidden: a function which receive current config, the state of the page and the license.
//
// Custom Widget (extends from Widget):
// - component: The component used to render the widget
//
// JobsTable Widget (extends from Widget):
// - job_type: The kind of job from Constants.JobTypes
// - render_job: Function to convert a job object into a react component.
//
// Banner Widget (extends from Widget):
// - banner_type: The type of banner (options: info or warning)
//
// Setting Widget (extends from Widget):
// - key: The key to store the configuration in the config file.
// - help_text (and help_text_default): Long description of the field.
// - help_text_markdown: True if the translation text contains markdown.
// - help_text_values: Values to fill the translation (if needed).
//
// Bool Widget (extends from Setting Widget)
//
// Number Widget (extends from Setting Widget)
//
// Color Widget (extends from Setting Widget)
//
// Text Widget (extends from Setting Widget)
// - placeholder (and placeholder_default): Placeholder text to show in the input.
//
// Button Widget (extends from Setting Widget)
// - action: A redux action to execute on click.
// - error_message (and error_message_default): Error to show if action doesn't work.
// - success_message (and success_message_default): Success message to show if action doesn't work.
//
// Language Widget (extends from Setting Widget)
// - multiple: If you can select multiple languages.
// - no_result (and no_result_default): Text to show on not results found (only for multiple = true).
// - not_present (and not_present_default): Text to show when the default language is not present (only for multiple = true).
//
// Dropdown Widget (extends from Setting Widget)
// - options: List of options of the dropdown (each options has value, display_name and display_name_default fields).
export const needsUtils = {
not: (func) => (config, state, license) => !func(config, state, license),
and: (...funcs) => (config, state, license) => {
for (const func of funcs) {
if (!func(config, state, license)) {
return false;
}
}
return true;
},
or: (...funcs) => (config, state, license) => {
for (const func of funcs) {
if (func(config, state, license)) {
return true;
}
}
return false;
},
stateValueMatch: (key, regex) => (config, state) => state[key].match(regex),
stateValueEqual: (key, value) => (config, state) => state[key] === value,
stateValueTrue: (key) => (config, state) => Boolean(state[key]),
stateValueFalse: (key) => (config, state) => !state[key],
hasLicense: (config, state, license) => license.IsLicensed,
};
export default {
reporting: {
system_analytics: {
schema: {
id: 'SystemAnalytics',
component: SystemAnalytics,
},
},
team_analytics: {
schema: {
id: 'TeamAnalytics',
component: TeamAnalytics,
},
},
system_users: {
schema: {
id: 'SystemUsers',
component: SystemUsers,
},
},
server_logs: {
schema: {
id: 'ServerLogs',
component: ServerLogs,
},
},
},
settings: {
general: {
configuration: {
schema: {
id: 'ServiceSettings',
name: 'admin.general.configuration',
name_default: 'Configuration',
settings: [
{
type: Constants.SettingsTypes.TYPE_BANNER,
label: 'admin.rate.noteDescription',
label_default: 'Changing properties in this section will require a server restart before taking effect.',
banner_type: 'info',
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'ServiceSettings.SiteURL',
label: 'admin.service.siteURL',
label_default: 'Site URL:',
help_text: 'admin.service.siteURLDescription',
help_text_default: 'The URL that users will use to access Mattermost. Standard ports, such as 80 and 443, can be omitted, but non-standard ports are required. For example: https://example.com:8065. This setting is required.\n \nMattermost may be hosted at a subpath. For example: https://example.com:8065/company/mattermost. A restart is required before the server will work correctly.',
help_text_markdown: true,
placeholder: 'admin.service.siteURLExample',
placeholder_default: 'E.g.: "https://example.com:8065"',
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'ServiceSettings.ListenAddress',
label: 'admin.service.listenAddress',
label_default: 'Listen Address:',
placeholder: 'admin.service.listenExample',
placeholder_default: 'E.g.: ":8065"',
help_text: 'admin.service.listenDescription',
help_text_default: 'The address and port to which to bind and listen. Specifying ":8065" will bind to all network interfaces. Specifying "127.0.0.1:8065" will only bind to the network interface having that IP address. If you choose a port of a lower level (called "system ports" or "well-known ports", in the range of 0-1023), you must have permissions to bind to that port. On Linux you can use: "sudo setcap cap_net_bind_service=+ep ./bin/mattermost" to allow Mattermost to bind to well-known ports.',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'ServiceSettings.Forward80To443',
label: 'admin.service.forward80To443',
label_default: 'Forward port 80 to 443:',
help_text: 'admin.service.forward80To443Description',
help_text_default: 'Forwards all insecure traffic from port 80 to secure port 443. Not recommended when using a proxy server.',
disabled_help_text: 'admin.service.forward80To443Description.disabled',
disabled_help_text_default: 'Forwards all insecure traffic from port 80 to secure port 443. Not recommended when using a proxy server.\n \nThis setting cannot be enabled until your server is [listening](#ListenAddress) on port 443.',
disabled_help_text_markdown: true,
isDisabled: needsUtils.not(needsUtils.stateValueMatch('ServiceSettings.ListenAddress', /:443$/)),
},
{
type: Constants.SettingsTypes.TYPE_DROPDOWN,
key: 'ServiceSettings.ConnectionSecurity',
label: 'admin.connectionSecurityTitle',
label_default: 'Connection Security:',
help_text: DefinitionConstants.CONNECTION_SECURITY_HELP_TEXT_WEBSERVER,
options: [
{
value: '',
display_name: 'admin.connectionSecurityNone',
display_name_default: 'None',
},
{
value: 'TLS',
display_name: 'admin.connectionSecurityTls',
display_name_default: 'TLS (Recommended)',
},
],
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'ServiceSettings.TLSCertFile',
label: 'admin.service.tlsCertFile',
label_default: 'TLS Certificate File:',
help_text: 'admin.service.tlsCertFileDescription',
help_text_default: 'The certificate file to use.',
isDisabled: needsUtils.stateValueTrue('ServiceSettings.UseLetsEncrypt'),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'ServiceSettings.TLSKeyFile',
label: 'admin.service.tlsKeyFile',
label_default: 'TLS Key File:',
help_text: 'admin.service.tlsKeyFileDescription',
help_text_default: 'The private key file to use.',
isDisabled: needsUtils.stateValueTrue('ServiceSettings.UseLetsEncrypt'),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'ServiceSettings.UseLetsEncrypt',
label: 'admin.service.useLetsEncrypt',
label_default: 'Use Let\'s Encrypt:',
help_text: 'admin.service.useLetsEncryptDescription',
help_text_default: 'Enable the automatic retrieval of certificates from Let\'s Encrypt. The certificate will be retrieved when a client attempts to connect from a new domain. This will work with multiple domains.',
disabled_help_text: 'admin.service.useLetsEncryptDescription.disabled',
disabled_help_text_default: 'Enable the automatic retrieval of certificates from Let\'s Encrypt. The certificate will be retrieved when a client attempts to connect from a new domain. This will work with multiple domains.\n \nThis setting cannot be enabled unless the [Forward port 80 to 443](#Forward80To443) setting is set to true.',
disabled_help_text_markdown: true,
isDisabled: needsUtils.stateValueFalse('ServiceSettings.Forward80To443'),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'ServiceSettings.LetsEncryptCertificateCacheFile',
label: 'admin.service.letsEncryptCertificateCacheFile',
label_default: 'Let\'s Encrypt Certificate Cache File:',
help_text: 'admin.service.letsEncryptCertificateCacheFileDescription',
help_text_default: 'Certificates retrieved and other data about the Let\'s Encrypt service will be stored in this file.',
isDisabled: needsUtils.stateValueFalse('ServiceSettings.UseLetsEncrypt'),
},
{
type: Constants.SettingsTypes.TYPE_NUMBER,
key: 'ServiceSettings.ReadTimeout',
label: 'admin.service.readTimeout',
label_default: 'Read Timeout:',
help_text: 'admin.service.readTimeoutDescription',
help_text_default: 'Maximum time allowed from when the connection is accepted to when the request body is fully read.',
},
{
type: Constants.SettingsTypes.TYPE_NUMBER,
key: 'ServiceSettings.WriteTimeout',
label: 'admin.service.writeTimeout',
label_default: 'Write Timeout:',
help_text: 'admin.service.writeTimeoutDescription',
help_text_default: 'If using HTTP (insecure), this is the maximum time allowed from the end of reading the request headers until the response is written. If using HTTPS, it is the total time from when the connection is accepted until the response is written.',
},
{
type: Constants.SettingsTypes.TYPE_DROPDOWN,
key: 'ServiceSettings.WebserverMode',
label: 'admin.webserverModeTitle',
label_default: 'Webserver Mode:',
help_text: DefinitionConstants.WEBSERVER_MODE_HELP_TEXT,
options: [
{
value: 'gzip',
display_name: 'admin.webserverModeGzip',
display_name_default: 'gzip',
},
{
value: 'uncompressed',
display_name: 'admin.webserverModeUncompressed',
display_name_default: 'Uncompressed',
},
{
value: 'disabled',
display_name: 'admin.webserverModeDisabled',
display_name_default: 'Disabled',
},
],
},
{
type: Constants.SettingsTypes.TYPE_BUTTON,
action: reloadConfig,
key: 'ReloadConfigButton',
label: 'admin.reload.button',
label_default: 'Reload Configuration From Disk',
help_text: 'admin.reload.reloadDescription',
help_text_default: 'Deployments using multiple databases can switch from one master database to another without restarting the Mattermost server by updating "config.json" to the new desired configuration and using the {featureName} feature to load the new settings while the server is running. The administrator should then use the {recycleDatabaseConnections} feature to recycle the database connections based on the new settings.',
help_text_values: {
featureName: (
<b>
<FormattedMessage
id='admin.reload.reloadDescription.featureName'
defaultMessage='Reload Configuration from Disk'
/>
</b>
),
recycleDatabaseConnections: (
<a href='../advanced/database'>
<b>
<FormattedMessage
id='admin.reload.reloadDescription.recycleDatabaseConnections'
defaultMessage='Database > Recycle Database Connections'
/>
</b>
</a>
),
},
error_message: 'admin.reload.reloadFail',
error_message_default: 'Reload unsuccessful: {error}',
},
{
type: Constants.SettingsTypes.TYPE_BUTTON,
key: 'PurgeButton',
action: invalidateAllCaches,
label: 'admin.purge.button',
label_default: 'Purge All Caches',
help_text: 'admin.purge.purgeDescription',
help_text_default: 'This will purge all the in-memory caches for things like sessions, accounts, channels, etc. Deployments using High Availability will attempt to purge all the servers in the cluster. Purging the caches may adversely impact performance.',
error_message: 'admin.purge.purgeFail',
error_message_default: 'Purging unsuccessful: {error}',
},
],
},
},
localization: {
schema: {
id: 'LocalizationSettings',
name: 'admin.general.localization',
name_default: 'Localization',
settings: [
{
type: Constants.SettingsTypes.TYPE_LANGUAGE,
key: 'LocalizationSettings.DefaultServerLocale',
label: 'admin.general.localization.serverLocaleTitle',
label_default: 'Default Server Language:',
help_text: 'admin.general.localization.serverLocaleDescription',
help_text_default: 'Default language for system messages and logs. Changing this will require a server restart before taking effect.',
},
{
type: Constants.SettingsTypes.TYPE_LANGUAGE,
key: 'LocalizationSettings.DefaultClientLocale',
label: 'admin.general.localization.clientLocaleTitle',
label_default: 'Default Client Language:',
help_text: 'admin.general.localization.clientLocaleDescription',
help_text_default: 'Default language for newly created users and pages where the user hasn\'t logged in.',
},
{
type: Constants.SettingsTypes.TYPE_LANGUAGE,
key: 'LocalizationSettings.AvailableLocales',
label: 'admin.general.localization.availableLocalesTitle',
label_default: 'Available Languages:',
help_text: 'admin.general.localization.availableLocalesDescription',
help_text_markdown: true,
help_text_default: 'Set which languages are available for users in Account Settings (leave this field blank to have all supported languages available). If you\'re manually adding new languages, the **Default Client Language** must be added before saving this setting.\n \nWould like to help with translations? Join the [Mattermost Translation Server](!https://translate.mattermost.com/) to contribute.',
multiple: true,
no_result: 'admin.general.localization.availableLocalesNoResults',
no_result_default: 'No results found',
not_present: 'admin.general.localization.availableLocalesNotPresent',
not_present_default: 'The default client language must be included in the available list',
},
],
},
},
privacy: {
schema: {
id: 'PrivacySettings',
name: 'admin.general.privacy',
name_default: 'Privacy',
settings: [
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'PrivacySettings.ShowEmailAddress',
label: 'admin.privacy.showEmailTitle',
label_default: 'Show Email Address:',
help_text: 'admin.privacy.showEmailDescription',
help_text_default: 'When false, hides the email address of members from everyone except System Administrators.',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'PrivacySettings.ShowFullName',
label: 'admin.privacy.showFullNameTitle',
label_default: 'Show Full Name:',
help_text: 'admin.privacy.showFullNameDescription',
help_text_default: 'When false, hides the full name of members from everyone except System Administrators. Username is shown in place of full name.',
},
],
},
},
compliance: {
schema: {
id: 'ComplianceSettings',
name: 'admin.compliance.title',
name_default: 'Compliance Settings',
settings: [
{
type: Constants.SettingsTypes.TYPE_BANNER,
label: 'admin.compliance.newComplianceExportBanner',
label_markdown: true,
label_default: 'This feature is replaced by a new [Compliance Export](../../admin_console/compliance/message_export) feature, and will be removed in a future release. We recommend migrating to the new system.',
isHidden: needsUtils.not(needsUtils.hasLicense),
banner_type: 'info',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'ComplianceSettings.Enable',
label: 'admin.compliance.enableTitle',
label_default: 'Enable Compliance Reporting:',
help_text: 'admin.compliance.enableDesc',
help_text_default: 'When true, Mattermost allows compliance reporting from the **Compliance and Auditing** tab. See [documentation](!https://docs.mattermost.com/administration/compliance.html) to learn more.',
help_text_markdown: true,
isHidden: needsUtils.not(needsUtils.hasLicense),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'ComplianceSettings.Directory',
label: 'admin.compliance.directoryTitle',
label_default: 'Compliance Report Directory:',
help_text: 'admin.compliance.directoryDescription',
help_text_default: 'Directory to which compliance reports are written. If blank, will be set to ./data/.',
placeholder: 'admin.sql.maxOpenExample',
placeholder_default: 'E.g.: "10"',
isDisabled: needsUtils.stateValueFalse('ComplianceSettings.Enable'),
isHidden: needsUtils.not(needsUtils.hasLicense),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'ComplianceSettings.EnableDaily',
label: 'admin.compliance.enableDailyTitle',
label_default: 'Enable Daily Report:',
help_text: 'admin.compliance.enableDailyDesc',
help_text_default: 'When true, Mattermost will generate a daily compliance report.',
isDisabled: needsUtils.stateValueFalse('ComplianceSettings.Enable'),
isHidden: needsUtils.not(needsUtils.hasLicense),
},
],
},
},
logging: {
schema: {
id: 'LogSettings',
name: 'admin.general.log',
name_default: 'Logging',
settings: [
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LogSettings.EnableConsole',
label: 'admin.log.consoleTitle',
label_default: 'Output logs to console: ',
help_text: 'admin.log.consoleDescription',
help_text_default: 'Typically set to false in production. Developers may set this field to true to output log messages to console based on the console level option. If true, server writes messages to the standard output stream (stdout). Changing this setting requires a server restart before taking effect.',
},
{
type: Constants.SettingsTypes.TYPE_DROPDOWN,
key: 'LogSettings.ConsoleLevel',
label: 'admin.log.levelTitle',
label_default: 'Console Log Level:',
help_text: 'admin.log.levelDescription',
help_text_default: 'This setting determines the level of detail at which log events are written to the console. ERROR: Outputs only error messages. INFO: Outputs error messages and information around startup and initialization. DEBUG: Prints high detail for developers working on debugging issues.',
options: DefinitionConstants.LOG_LEVEL_OPTIONS,
isDisabled: needsUtils.stateValueFalse('LogSettings.EnableConsole'),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LogSettings.ConsoleJson',
label: 'admin.log.consoleJsonTitle',
label_default: 'Output console logs as JSON:',
help_text: 'admin.log.jsonDescription',
help_text_default: 'When true, logged events are written in a machine readable JSON format. Otherwise they are printed as plain text. Changing this setting requires a server restart before taking effect.',
isDisabled: needsUtils.stateValueFalse('LogSettings.EnableConsole'),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LogSettings.EnableFile',
label: 'admin.log.fileTitle',
label_default: 'Output logs to file: ',
help_text: 'admin.log.fileDescription',
help_text_default: 'Typically set to true in production. When true, logged events are written to the mattermost.log file in the directory specified in the File Log Directory field. The logs are rotated at 10,000 lines and archived to a file in the same directory, and given a name with a datestamp and serial number. For example, mattermost.2017-03-31.001. Changing this setting requires a server restart before taking effect.',
},
{
type: Constants.SettingsTypes.TYPE_DROPDOWN,
key: 'LogSettings.FileLevel',
label: 'admin.log.fileLevelTitle',
label_default: 'File Log Level:',
help_text: 'admin.log.fileLevelDescription',
help_text_default: 'This setting determines the level of detail at which log events are written to the log file. ERROR: Outputs only error messages. INFO: Outputs error messages and information around startup and initialization. DEBUG: Prints high detail for developers working on debugging issues.',
options: DefinitionConstants.LOG_LEVEL_OPTIONS,
isDisabled: needsUtils.stateValueFalse('LogSettings.EnableFile'),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LogSettings.FileJson',
label: 'admin.log.fileJsonTitle',
label_default: 'Output file logs as JSON:',
help_text: 'admin.log.jsonDescription',
help_text_default: 'When true, logged events are written in a machine readable JSON format. Otherwise they are printed as plain text. Changing this setting requires a server restart before taking effect.',
isDisabled: needsUtils.stateValueFalse('LogSettings.EnableFile'),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LogSettings.FileLocation',
label: 'admin.log.locationTitle',
label_default: 'File Log Directory:',
help_text: 'admin.log.locationDescription',
help_text_default: 'The location of the log files. If blank, they are stored in the ./logs directory. The path that you set must exist and Mattermost must have write permissions in it. Changing this setting requires a server restart before taking effect.',
placeholder: 'admin.log.locationPlaceholder',
placeholder_default: 'Enter your file location',
isDisabled: needsUtils.stateValueFalse('LogSettings.EnableFile'),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LogSettings.EnableWebhookDebugging',
label: 'admin.log.enableWebhookDebugging',
label_default: 'Enable Webhook Debugging:',
help_text: 'admin.log.enableWebhookDebuggingDescription',
help_text_default: 'When true, sends webhook debug messages to the server logs. To also output the request body of incoming webhooks, set {boldedLogLevel} to "DEBUG".',
help_text_values: {
boldedLogLevel: (
<strong>
<FormattedMessage
id='admin.log.logLevel'
defaultMessage='Log Level'
/>
</strong>
),
},
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LogSettings.EnableDiagnostics',
label: 'admin.log.enableDiagnostics',
label_default: 'Enable Diagnostics and Error Reporting:',
help_text: 'admin.log.enableDiagnosticsDescription',
help_text_default: 'Enable this feature to improve the quality and performance of Mattermost by sending error reporting and diagnostic information to Mattermost, Inc. Read our [privacy policy](!https://about.mattermost.com/default-privacy-policy/) to learn more.',
help_text_markdown: true,
onConfigSave: (displayVal, previousVal) => {
if (previousVal && previousVal !== displayVal) {
trackEvent('ui', 'diagnostics_disabled');
}
return displayVal;
},
},
],
},
},
},
permissions: {
schemes: {
schema: {
id: 'PermissionSchemes',
component: PermissionSchemesSettings,
},
},
systemScheme: {
schema: {
id: 'PermissionSystemScheme',
component: PermissionSystemSchemeSettings,
},
},
teamScheme: {
schema: {
id: 'PermissionSystemScheme',
component: PermissionTeamSchemeSettings,
},
},
},
authentication: {
email: {
schema: {
id: 'EmailSettings',
name: 'admin.authentication.email',
name_default: 'Email Authentication',
settings: [
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'EmailSettings.EnableSignUpWithEmail',
label: 'admin.email.allowSignupTitle',
label_default: 'Enable account creation with email:',
help_text: 'admin.email.allowSignupDescription',
help_text_default: 'When true, Mattermost allows account creation using email and password. This value should be false only when you want to limit sign up to a single sign-on service like AD/LDAP, SAML or GitLab.',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'EmailSettings.EnableSignInWithEmail',
label: 'admin.email.allowEmailSignInTitle',
label_default: 'Enable sign-in with email:',
help_text: 'admin.email.allowEmailSignInDescription',
help_text_default: 'When true, Mattermost allows users to sign in using their email and password.',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'EmailSettings.EnableSignInWithUsername',
label: 'admin.email.allowUsernameSignInTitle',
label_default: 'Enable sign-in with username:',
help_text: 'admin.email.allowUsernameSignInDescription',
help_text_default: 'When true, users with email login can sign in using their username and password. This setting does not affect AD/LDAP login.',
},
],
},
},
ldap: {
schema: {
id: 'LdapSettings',
name: 'admin.authentication.ldap',
name_default: 'AD/LDAP',
settings: [
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LdapSettings.Enable',
label: 'admin.ldap.enableTitle',
label_default: 'Enable sign-in with AD/LDAP:',
help_text: 'admin.ldap.enableDesc',
help_text_default: 'When true, Mattermost allows login using AD/LDAP',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LdapSettings.EnableSync',
label: 'admin.ldap.enableSyncTitle',
label_default: 'Enable Synchronization with AD/LDAP:',
help_text: 'admin.ldap.enableSyncDesc',
help_text_default: 'When true, Mattermost periodically synchronizes users from AD/LDAP. When false, user attributes are updated from AD/LDAP during user login only.',
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.LdapServer',
label: 'admin.ldap.serverTitle',
label_default: 'AD/LDAP Server:',
help_text: 'admin.ldap.serverDesc',
help_text_default: 'The domain or IP address of AD/LDAP server.',
placeholder: 'admin.ldap.serverEx',
placeholder_default: 'E.g.: "10.0.0.23"',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_NUMBER,
key: 'LdapSettings.LdapPort',
label: 'admin.ldap.portTitle',
label_default: 'AD/LDAP Port:',
help_text: 'admin.ldap.portDesc',
help_text_default: 'The port Mattermost will use to connect to the AD/LDAP server. Default is 389.',
placeholder: 'admin.ldap.portEx',
placeholder_default: 'E.g.: "389"',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_DROPDOWN,
key: 'LdapSettings.ConnectionSecurity',
label: 'admin.connectionSecurityTitle',
label_default: 'Connection Security:',
help_text: DefinitionConstants.CONNECTION_SECURITY_HELP_TEXT_LDAP,
options: [
{
value: '',
display_name: 'admin.connectionSecurityNone',
display_name_default: 'None',
},
{
value: 'TLS',
display_name: 'admin.connectionSecurityTls',
display_name_default: 'TLS (Recommended)',
},
{
value: 'STARTTLS',
display_name: 'admin.connectionSecurityStart',
display_name_default: 'STARTTLS',
},
],
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'LdapSettings.SkipCertificateVerification',
label: 'admin.ldap.skipCertificateVerification',
label_default: 'Skip Certificate Verification:',
help_text: 'admin.ldap.skipCertificateVerificationDesc',
help_text_default: 'Skips the certificate verification step for TLS or STARTTLS connections. Not recommended for production environments where TLS is required. For testing only.',
isDisabled: needsUtils.stateValueFalse('LdapSettings.ConnectionSecurity'),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.BaseDN',
label: 'admin.ldap.baseTitle',
label_default: 'BaseDN:',
help_text: 'admin.ldap.baseDesc',
help_text_default: 'The Base DN is the Distinguished Name of the location where Mattermost should start its search for users in the AD/LDAP tree.',
placeholder: 'admin.ldap.baseEx',
placeholder_default: 'E.g.: "ou=Unit Name,dc=corp,dc=example,dc=com"',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.BindUsername',
label: 'admin.ldap.bindUserTitle',
label_default: 'Bind Username:',
help_text: 'admin.ldap.bindUserDesc',
help_text_default: 'The username used to perform the AD/LDAP search. This should typically be an account created specifically for use with Mattermost. It should have access limited to read the portion of the AD/LDAP tree specified in the BaseDN field.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.BindPassword',
label: 'admin.ldap.bindPwdTitle',
label_default: 'Bind Password:',
help_text: 'admin.ldap.bindPwdDesc',
help_text_default: 'Password of the user given in "Bind Username".',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.UserFilter',
label: 'admin.ldap.userFilterTitle',
label_default: 'User Filter:',
help_text: 'admin.ldap.userFilterDisc',
help_text_default: '(Optional) Enter an AD/LDAP Filter to use when searching for user objects. Only the users selected by the query will be able to access Mattermost. For Active Directory, the query to filter out disabled users is (&(objectCategory=Person)(!(UserAccountControl:1.2.840.113556.1.4.803:=2))).',
placeholder: 'admin.ldap.userFilterEx',
placeholder_default: 'Ex. "(objectClass=user)"',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.FirstNameAttribute',
label: 'admin.ldap.firstnameAttrTitle',
label_default: 'First Name Attribute:',
placeholder: 'admin.ldap.firstnameAttrEx',
placeholder_default: 'E.g.: "givenName"',
help_text: 'admin.ldap.firstnameAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the first name of users in Mattermost. When set, users cannot edit their first name, since it is synchronized with the LDAP server. When left blank, users can set their first name in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.LastNameAttribute',
label: 'admin.ldap.lastnameAttrTitle',
label_default: 'Last Name Attribute:',
placeholder: 'admin.ldap.lastnameAttrEx',
placeholder_default: 'E.g.: "sn"',
help_text: 'admin.ldap.lastnameAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the last name of users in Mattermost. When set, users cannot edit their last name, since it is synchronized with the LDAP server. When left blank, users can set their last name in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.NicknameAttribute',
label: 'admin.ldap.nicknameAttrTitle',
label_default: 'Nickname Attribute:',
placeholder: 'admin.ldap.nicknameAttrEx',
placeholder_default: 'E.g.: "nickname"',
help_text: 'admin.ldap.nicknameAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the nickname of users in Mattermost. When set, users cannot edit their nickname, since it is synchronized with the LDAP server. When left blank, users can set their nickname in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.PositionAttribute',
label: 'admin.ldap.positionAttrTitle',
label_default: 'Position Attribute:',
placeholder: 'admin.ldap.positionAttrEx',
placeholder_default: 'E.g.: "title"',
help_text: 'admin.ldap.positionAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the position field in Mattermost. When set, users cannot edit their position, since it is synchronized with the LDAP server. When left blank, users can set their position in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.EmailAttribute',
label: 'admin.ldap.emailAttrTitle',
label_default: 'Email Attribute:',
placeholder: 'admin.ldap.emailAttrEx',
placeholder_default: 'E.g.: "mail" or "userPrincipalName"',
help_text: 'admin.ldap.emailAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server used to populate the email address field in Mattermost.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.UsernameAttribute',
label: 'admin.ldap.usernameAttrTitle',
label_default: 'Username Attribute:',
placeholder: 'admin.ldap.usernameAttrEx',
placeholder_default: 'E.g.: "sAMAccountName"',
help_text: 'admin.ldap.usernameAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server used to populate the username field in Mattermost. This may be the same as the Login ID Attribute.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.IdAttribute',
label: 'admin.ldap.idAttrTitle',
label_default: 'ID Attribute: ',
placeholder: 'admin.ldap.idAttrEx',
placeholder_default: 'E.g.: "objectGUID"',
help_text: 'admin.ldap.idAttrDesc',
help_text_markdown: true,
help_text_default: 'The attribute in the AD/LDAP server used as a unique identifier in Mattermost. It should be an AD/LDAP attribute with a value that does not change. If a user\'s ID Attribute changes, it will create a new Mattermost account unassociated with their old one.\n \nIf you need to change this field after users have already logged in, use the [mattermost ldap idmigrate](!https://about.mattermost.com/default-mattermost-ldap-idmigrate) CLI tool.',
isDisabled: needsUtils.and(
needsUtils.stateValueEqual('LdapSettings.Enable', false),
needsUtils.stateValueEqual('LdapSettings.EnableSync', false),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.LoginIdAttribute',
label: 'admin.ldap.loginAttrTitle',
label_default: 'Login ID Attribute: ',
placeholder: 'admin.ldap.loginIdAttrEx',
placeholder_default: 'E.g.: "sAMAccountName"',
help_text: 'admin.ldap.loginAttrDesc',
help_text_markdown: true,
help_text_default: 'The attribute in the AD/LDAP server used to log in to Mattermost. Normally this attribute is the same as the "Username Attribute" field above.\n \nIf your team typically uses domain/username to log in to other services with AD/LDAP, you may enter domain/username in this field to maintain consistency between sites.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_TEXT,
key: 'LdapSettings.LoginFieldName',
label: 'admin.ldap.loginNameTitle',
label_default: 'Sign-in Field Default Text:',
placeholder: 'admin.ldap.loginNameEx',
placeholder_default: 'E.g.: "AD/LDAP Username"',
help_text: 'admin.ldap.loginNameDesc',
help_text_default: 'The placeholder text that appears in the login field on the login page. Defaults to "AD/LDAP Username".',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_NUMBER,
key: 'LdapSettings.SyncIntervalMinutes',
label: 'admin.ldap.syncIntervalTitle',
label_default: 'Synchronization Interval (minutes):',
help_text: 'admin.ldap.syncIntervalHelpText',
help_text_default: 'AD/LDAP Synchronization updates Mattermost user information to reflect updates on the AD/LDAP server. For example, when a user\'s name changes on the AD/LDAP server, the change updates in Mattermost when synchronization is performed. Accounts removed from or disabled in the AD/LDAP server have their Mattermost accounts set to "Inactive" and have their account sessions revoked. Mattermost performs synchronization on the interval entered. For example, if 60 is entered, Mattermost synchronizes every 60 minutes.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_NUMBER,
key: 'LdapSettings.MaxPageSize',
label: 'admin.ldap.maxPageSizeTitle',
label_default: 'Maximum Page Size:',
placeholder: 'admin.ldap.maxPageSizeEx',
placeholder_default: 'E.g.: "2000"',
help_text: 'admin.ldap.maxPageSizeHelpText',
help_text_default: 'The maximum number of users the Mattermost server will request from the AD/LDAP server at one time. 0 is unlimited.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_NUMBER,
key: 'LdapSettings.QueryTimeout',
label: 'admin.ldap.queryTitle',
label_default: 'Query Timeout (seconds):',
placeholder: 'admin.ldap.queryEx',
placeholder_default: 'E.g.: "60"',
help_text: 'admin.ldap.queryDesc',
help_text_default: 'The timeout value for queries to the AD/LDAP server. Increase if you are getting timeout errors caused by a slow AD/LDAP server.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_BUTTON,
action: ldapTest,
key: 'LdapSettings.LdapTest',
label: 'admin.ldap.ldap_test_button',
label_default: 'AD/LDAP Test',
help_text: 'admin.ldap.testHelpText',
help_text_markdown: true,
help_text_default: 'Tests if the Mattemost server can connect to the AD/LDAP server specified. Please review "System Console > Logs" and [documentation](!https://mattermost.com/default-ldap-docs) to troubleshoot errors.',
error_message: 'admin.ldap.testFailure',
error_message_default: 'AD/LDAP Test Failure: {error}',
success_message: 'admin.ldap.testSuccess',
success_message_default: 'AD/LDAP Test Successful',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
),
},
{
type: Constants.SettingsTypes.TYPE_JOBSTABLE,
job_type: Constants.JobTypes.LDAP_SYNC,
label: 'admin.ldap.sync_button',
label_default: 'AD/LDAP Synchronize Now',
help_text: 'admin.ldap.syncNowHelpText',
help_text_markdown: true,
help_text_default: 'Initiates an AD/LDAP synchronization immediately. See the table below for status of each synchronization. Please review "System Console > Logs" and [documentation](!https://mattermost.com/default-ldap-docs) to troubleshoot errors.',
isDisabled: needsUtils.stateValueFalse('LdapSettings.EnableSync'),
render_job: (job) => {
let mattermostUsers = '0';
let ldapUsers = '0';
let deleteCount = '0';
let updateCount = '0';
if (job && job.data) {
if (job.data.mattermost_users_count && job.data.mattermost_users_count.length > 0) {
mattermostUsers = job.data.mattermost_users_count;
}
if (job.data.ldap_users_count && job.data.ldap_users_count.length > 0) {
ldapUsers = job.data.ldap_users_count;
}
if (job.data.delete_count && job.data.delete_count.length > 0) {
deleteCount = job.data.delete_count;
}
if (job.data.update_count && job.data.update_count.length > 0) {
updateCount = job.data.update_count;
}
}
return (
<FormattedMessage
id='admin.ldap.jobExtraInfo'
defaultMessage='Scanned {ldapUsers} LDAP users, updated {updateCount}, deactivated {deleteCount}'
values={{
mattermostUsers,
ldapUsers,
deleteCount,
updateCount,
}}
/>
);
},
},
],
},
},
mfa: {
schema: {
id: 'ServiceSettings',
name: 'admin.mfa.title',
name_default: 'Multi-factor Authentication',
settings: [
{
type: Constants.SettingsTypes.TYPE_BANNER,
label: 'admin.mfa.bannerDesc',
label_default: '[Multi-factor authentication](!https://docs.mattermost.com/deployment/auth.html) is available for accounts with AD/LDAP or email login. If other login methods are used, MFA should be configured with the authentication provider.',
label_markdown: true,
banner_type: 'info',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'ServiceSettings.EnableMultifactorAuthentication',
label: 'admin.service.mfaTitle',
label_default: 'Enable Multi-factor Authentication:',
help_text: 'admin.service.mfaDesc',
help_text_default: 'When true, users with AD/LDAP or email login can add multi-factor authentication to their account using Google Authenticator.',
},
{
type: Constants.SettingsTypes.TYPE_BOOL,
key: 'ServiceSettings.EnforceMultifactorAuthentication',