-
Notifications
You must be signed in to change notification settings - Fork 617
/
Copy pathmeshcentral-config-schema.json
4161 lines (4161 loc) · 165 KB
/
meshcentral-config-schema.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
{
"id": "https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "MeshCentral configuration file schema",
"type": "object",
"required": [
"settings",
"domains"
],
"properties": {
"settings": {
"type": "object",
"properties": {
"cert": {
"type": "string",
"description": "Set this to the primary DNS name of this MeshCentral server."
},
"keepCerts": {
"type": "boolean",
"default": false,
"description": "Force MeshCentral to use the HTTPS and MPS certificates even if the name does not match the expected DNS value."
},
"mongoDb": {
"type": "string",
"default": null
},
"mongoDbName": {
"type": "string"
},
"mongoDbChangeStream": {
"type": "boolean",
"default": false
},
"mongoDbBulkOperations": {
"type": "boolean",
"default": false
},
"mariaDB": {
"type": "object",
"description": "Add this section to connect MeshCentral to a MariaDB database instance.",
"properties": {
"host": {
"type": "string",
"description": "MariaDB hostname"
},
"user": {
"type": "string",
"description": "MariaDB username"
},
"port": {
"type": "number",
"description": "MariaDB port number"
},
"password": {
"type": "string",
"description": "MariaDB password"
},
"connectionLimit": {
"type": "number",
"description": "MariaDB connection limit"
},
"database": {
"type": "string",
"default": "meshcentral",
"description": "Name of MariaDB database used"
},
"awsrds": {
"type": "boolean",
"default": false,
"description": "Set true to resolve LOCK TABLE permissions on AWS RDS."
},
"ssl": {
"type": "object",
"description": "SSL Options. Set to true (boolean) for default options.",
"properties": {
"caCertPath": {
"type": "string",
"description": "Absolute path to the CA certificate. Required for self-signed certificates"
},
"clientCertPath": {
"type": "string",
"description": "Absolute path to the client certificate. Required for two-way SSL Authentication"
},
"clientKeyPath": {
"type": "string",
"description": "Absolute path to the client key. Required for two-way SSL Authentication"
},
"dontCheckServerIdentity": {
"type": "boolean",
"description": "Set true to not check the server hostname during verification"
}
}
}
}
},
"sqlite3": {
"type": [ "boolean", "string", "object" ],
"default": false,
"description": "Set boolean true to use SQLite3 as a local MeshCentral database with default db filename 'meshcentral' or enter a string for a different db filename. Extension .sqlite is appended",
"properties":{
"name": {
"type": "string",
"default": "meshcentral",
"description": "Database filename. '.sqlite' is appended"
},
"journalMode": {
"type": "string",
"default": "delete",
"description": "DELETE, TRUNCATE, PERSIST, MEMORY, WAL. NONE not allowed. See: https://www.sqlite.org/pragma.html#pragma_journal_mode"
},
"journalSize": {
"type": "integer",
"default": 4096000,
"description": "Maximum size of the journal file in bytes. Can grow larger if needed, but will shrink to this size. -1 is unlimited growth. See: https://www.sqlite.org/pragma.html#pragma_journal_size_limit"
},
"autoVacuum": {
"type": "string",
"default": "incremental",
"description": "none, full, incremental. Removes unused pages and shrinks databasefile during maintenance. See: https://www.sqlite.org/pragma.html#pragma_auto_vacuum"
},
"incrementalVacuum": {
"type": "integer",
"default": 100,
"description": "Maximum amount of pages to free during maintenance. Default page size is 4k, so default frees up to 400k from the databasefile. See: https://www.sqlite.org/pragma.html#pragma_incremental_vacuum"
},
"startupVacuum": {
"type": "boolean",
"default": false,
"description": "Do a full VACUUM at startup. Shrinks the db file and optimizes it. This can take some time with a large database and can temporarily take up to double the database size on disk. See: https://www.sqlite.org/lang_vacuum.html"
}
}
},
"mySQL": {
"type": "object",
"description": "Add this section to connect MeshCentral to a MySQL database instance.",
"properties": {
"host": {
"type": "string",
"description": "MySQL hostname"
},
"port": {
"type": "number",
"description": "MySQL port number"
},
"user": {
"type": "string",
"description": "MySQL username"
},
"password": {
"type": "string",
"description": "MySQL password"
},
"database": {
"type": "string",
"default": "meshcentral",
"description": "Name of MySQL database used"
},
"awsrds": {
"type": "boolean",
"default": false,
"description": "Set true to resolve LOCK TABLE permissions on AWS RDS."
},
"ssl": {
"type": "object",
"description": "SSL Options. Set to true (boolean) for default options.",
"properties": {
"caCertPath": {
"type": "string",
"description": "Absolute path to the CA certificate. Required for self-signed certificates"
},
"clientCertPath": {
"type": "string",
"description": "Absolute path to the client certificate. Required for two-way SSL Authentication"
},
"clientKeyPath": {
"type": "string",
"description": "Absolute path to the client key. Required for two-way SSL Authentication"
},
"dontCheckServerIdentity": {
"type": "boolean",
"description": "Set true to not check the server hostname during verification"
}
}
}
}
},
"postgres": {
"type": "object",
"description": "Add this section to connect MeshCentral to a PostgreSQL database instance.",
"properties": {
"host": {
"type": "string",
"description": "PostgreSQL hostname"
},
"user": {
"type": "string",
"description": "PostgreSQL username"
},
"port": {
"type": "number",
"description": "PostgreSQL port number"
},
"password": {
"type": "string",
"description": "PostgreSQL password"
},
"database": {
"type": "string",
"default": "meshcentral",
"description": "Name of PostgreSQL database used"
}
}
},
"acebase": {
"type": "object",
"description": "Add this section to enable AceBase database support, this is a local database system much like NeDB.",
"properties": {
"sponsor": {
"type": "boolean",
"default": false,
"description": "Set true to remove the AceBase banner on startup."
}
}
},
"WANonly": {
"type": "boolean",
"default": false,
"description": "When enabled, only MeshCentral WAN features are enabled and agents will connect to the server using a well known DNS name."
},
"LANonly": {
"type": "boolean",
"default": false,
"description": "When enabled, only MeshCentral LAN features are enabled and agents will find the server using multicast LAN packets."
},
"maintenanceMode": {
"type": "boolean",
"default": false,
"description": "When enabled the server is in maintenance mode, only administrators can login. Use the maintenance command in server console to change."
},
"certificatePrivateKeyPassword": {
"type": "array",
"default": null,
"description": "List of passwords used to decrypt PKCK#8 .key files that are in the meshcentral-data folder."
},
"sessionTime": {
"type": "integer",
"default": 60,
"description": "Duration of a session cookie in minutes. Changing this affects how often the session needs to be automatically refreshed."
},
"sessionKey": {
"type": "string",
"default": null,
"description": "Password used to encrypt the MeshCentral web session cookies. If null, a random one is generated each time the server starts."
},
"sessionSameSite": {
"type": "string",
"default": "lax",
"enum": [
"strict",
"lax",
"none"
]
},
"dbEncryptKey": {
"type": "string",
"default": null,
"description": "This value is only valid when used with NeDB, sets the database encryption and decryption key."
},
"dbRecordsEncryptKey": {
"type": "string",
"default": null,
"description": "With any database, encrypt and decrypt sensitive information within records using this secret key."
},
"dbRecordsDecryptKey": {
"type": "string",
"default": null,
"description": "With any database, decrypt sensitive information within records using this secret key, don't use a key to encrypt records."
},
"dbExpire": {
"type": "object",
"properties": {
"events": {
"type": "integer",
"default": 1728000,
"description": "Amount of time in seconds that events are kept in the database."
},
"powerevents": {
"type": "integer",
"default": 864000,
"description": "Amount of time in seconds that device power events are kept in the database."
},
"statsevents": {
"type": "integer",
"default": 2592000,
"description": "Amount of time in seconds that server statistics are kept in the database."
}
}
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 443,
"description": "Ths port of the main HTTPS server."
},
"portBind": {
"type": "string",
"description": "When set, bind the HTTPS main port to a specific network address."
},
"aliasPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": null,
"description": "The actual main port as seen externally on the Internet, this setting is often used when a reverse-proxy is used."
},
"redirPort": {
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 80,
"description": "This is a HTTP web server port that mostly redirects users to the HTTPS port but does provide some other services, 0 will turn this port off."
},
"redirPortBind": {
"type": "string",
"description": "When set, bind the HTTP redirection port to a specific network address."
},
"redirAliasPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"description": "The actual redirection port as seen externally on the Internet, this setting is often used when a reverse-proxy is used."
},
"relayPort": {
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 0,
"description": "When set, a web relay web server is bound to this port and will allow user access to remote web sites."
},
"relayAliasPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": null,
"description": "The actual relay port as seen externally on the Internet, this setting is often used when a reverse-proxy is used."
},
"relayDNS": {
"type": "string",
"default": null,
"description": "When set, relayPort value is ignored. Set this to a DNS name the points to this server. When the server is accessed using the DNS name, the main web server port is used as a web relay port."
},
"agentPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"description": "When set, enabled a new HTTPS server port that only accepts agent connections."
},
"agentPortBind": {
"type": "string",
"description": "When set, binds the agent port to a specific network interface."
},
"agentAliasPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"description": "When set, indicates the actual publicly visible agent-only port. If not set, the AgentPort value is used."
},
"agentAliasDNS": {
"type": "string",
"format": "hostname",
"description": "When set, specified the DNS name used by agents to connect to the agent-only port."
},
"agentPortTls": {
"type": "boolean",
"default": true,
"description": "Indicates if the agent-only port must perform TLS, this should be set to false if TLS is performed in front of this server."
},
"agentLogDump": {
"type": "boolean",
"default": false,
"description": "Automatically downloads all agent error logs into meshcentral-data/agenterrorlogs.txt."
},
"agentCoreDump": {
"type": "boolean",
"default": false,
"description": "Automatically activates and transfers any agent crash dump files to the server in meshcentral-data/coredumps."
},
"agentCoreDumpUsers": {
"type": "array",
"description": "List of non-administrator users that have access to mesh agent crash dumps."
},
"agentSignLock": {
"type": "boolean",
"default": false,
"description": "When code signing an agent using authenticode, lock the agent to only allow connection to this server. (This is in testing, the default value will change to true in the future)."
},
"agentTimeStampServer": {
"type": [
"boolean",
"string"
],
"default": "http://timestamp.comodoca.com/authenticode",
"description": "The time stamping server to use when code signing Windows executables. When set to false, the executables are not time stamped."
},
"agentTimeStampProxy": {
"type": [
"boolean",
"string"
],
"description": "The HTTP proxy to use when contacting the time stamping server, if false, no proxy is used. By default, the npmproxy value is used."
},
"lockAgentDownload": {
"type": "boolean",
"default": false,
"description": "When enabled, MeshCentral will block all downloads of MeshAgent including install scripts, if the user is not logged in"
},
"ignoreAgentHashCheck": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "When true, the agent no longer checked the TLS certificate of the server. This should be used for debugging only. You can also set this to a comma separated list of IP addresses to ignore, for example: \"192.168.2.100,192.168.1.0/24\"."
},
"exactPorts": {
"type": "boolean",
"default": false,
"description": "When set to true, MeshCentral will only grab the required TCP listening ports or fail. It will not try to use the next available port of it's busy."
},
"allowLoginToken": {
"type": "boolean",
"default": false,
"description": "When set to true, MeshCentral will allow login tokens to be used in the URL as a replacement for user login. This is useful along with \"allowFraming\" option to embed MeshCentral features into another website"
},
"StrictTransportSecurity": {
"type": [
"boolean",
"string"
],
"default": null,
"description": "Controls the Strict-Transport-Security header, default is 1 year. Set to false to remove, true to force enable, or string to set a custom value. If set to null, MeshCentral will enable if a trusted certificate is set."
},
"allowFraming": {
"type": "boolean",
"default": false,
"description": "When enabled, the MeshCentral web site can be embedded within another website's iframe."
},
"cookieIpCheck": {
"type": [
"string",
"boolean"
],
"default": "lax",
"enum": [
"strict",
"lax",
"none"
]
},
"cookieEncoding": {
"type": "string",
"enum": [
"hex",
"base64"
],
"default": "base64",
"description": "Encoding format of cookies in the HTTP headers, this is typically Base64 but some reverse proxies will require HEX."
},
"webRTC": {
"type": "boolean",
"default": false,
"description": "When enabled, allows use of WebRTC to allow direct network traffic between the agent and browser."
},
"nice404": {
"type": "boolean",
"default": true,
"description": "By default, a nice looking 404 error page is displayed when needed. Set this to false to disable it."
},
"selfUpdate": {
"type": [
"string",
"boolean"
],
"default": false,
"description": "When set to true, the server will check for a new version and attempt to self-update automatically a bit after midnight local time every day. If set to a specific version such as \"1.1.21\" the server will immediately update to the specified version on startup if it's not already at this version."
},
"cleanNpmCacheOnUpdate": {
"type": "boolean",
"default": false,
"description": "When true, run \"npm cache clean --force\" to reclaim disk space."
},
"browserPing": {
"type": "integer",
"minimum": 1,
"description": "When specified, sends data to the browser at x seconds interval and expects a response from the browser."
},
"browserPong": {
"type": "integer",
"minimum": 1,
"description": "When specified, sends data to the browser at x seconds interval."
},
"agentsInRam": {
"type": "boolean",
"default": false,
"description": "Loads all agent binaries in RAM for faster agent updates."
},
"agentPing": {
"type": "integer",
"minimum": 1,
"description": "When specified, sends data to the agent at x seconds interval and expects a response from the agent."
},
"agentPong": {
"type": "integer",
"minimum": 1,
"description": "When specified, sends data to the agent at x seconds interval."
},
"amtManager": {
"type": "boolean",
"default": true,
"description": "When enabled, MeshCentral will automatically monitor and manage Intel AMT devices."
},
"agentIdleTimeout": {
"type": "integer",
"minimum": 1,
"default": 150,
"description": "How much time in seconds with no traffic from an agent before dropping the agent connection."
},
"webPageLengthRandomization": {
"type": "boolean",
"default": true,
"description": "Adds a random length string to generated web pages to mitigate a BREACH attack."
},
"compression": {
"type": "boolean",
"default": true,
"description": "Enables GZIP compression for web requests."
},
"wsCompression": {
"type": "boolean",
"default": false,
"description": "Enables server-side, websocket per-message deflate compression."
},
"agentWsCompression": {
"type": "boolean",
"default": true,
"description": "Enables agent-side, websocket per-message deflate compression. wscompression must also be true for this to work."
},
"noAgentUpdate": {
"type": "integer",
"default": 0,
"description": "Set to 1 to present the server from updating any agent."
},
"agentUpdateSystem": {
"type": "integer",
"default": 1,
"description": "When set to 2, all agents that need to be updated will use the meshcore.js update system. With the default value of 1, the native update system is used."
},
"temporaryAgentUpdate": {
"type": "boolean",
"default": true,
"description": "Set to false to not allow temporary agents to be updated."
},
"amtScanner": {
"type": "boolean",
"default": true,
"description": "Set to false to disable Intel AMT scanning on the local network, this is already disabled in WAN mode."
},
"meshScanner": {
"type": "boolean",
"default": true,
"description": "Set to false to disable agent multicast scanning on the local network, this is already disabled in WAN mode."
},
"meshErrorLogPath": {
"type": "string"
},
"npmPath": {
"type": "string"
},
"npmProxy": {
"type": "string",
"format": "uri"
},
"allowHighQualityDesktop": {
"type": "boolean",
"default": true,
"description": "When false, users will only be able to set remote desktop image quality to 60%, this can reduce server bandwidth usage."
},
"webPush": {
"type": "object",
"description": "When set with a valid email address, enables the MeshCentral web push notification feature. Allows administrators to send browser notifications to users even if they are not looking at the MeshCentral web site.",
"properties": {
"email": {
"type": "string",
"description": "Server administrator email given to the FireFox and Chrome push notification services."
}
},
"required": [
"email"
]
},
"RunOnServerStarted": {
"type": "boolean",
"default": null,
"description": "Execute this when the server startup is completed. The first parameter will be the server version."
},
"RunOnServerUpdated": {
"type": "boolean",
"default": null,
"description": "Execute this when the server has been updated. The first parameter will be the server version."
},
"RunOnServerError": {
"type": "boolean",
"default": null,
"description": "Execute this when the server has to restart due to an error. The first parameter will be the server version."
},
"publicPushNotifications": {
"type": "boolean",
"default": false,
"description": "When true, this server uses MeshCentral.com a push notification relay for Android notifications. Push notifications work even if the Android app is not open."
},
"desktopMultiplex": {
"type": "boolean",
"default": false,
"description": "When true, enabled a server modules that efficiently splits a remote desktop stream to multiple browsers. Also allows slow browsers to not slow down the session for fast ones, this comes at the cost of extra server memory and processing for all remote desktop sessions."
},
"ipBlockedUserRedirect": {
"type": "string",
"default": null,
"description": "If set, a user from a banned IP address will be redirected to this URL."
},
"userAllowedIP": {
"type": [
"string",
"array"
],
"default": null,
"description": "When set, only users from allowed IP address ranges can connect to the server. Example: \"192.168.2.100,192.168.1.0/24\" \"file:userAllowedIP.txt\""
},
"userBlockedIP": {
"type": [
"string",
"array"
],
"default": null,
"description": "When set, users from these denied IP address ranges will not be able to connect to the server. Example: \"192.168.2.100,192.168.1.0/24\" \"file:userBlockedIP.txt\""
},
"agentAllowedIP": {
"type": [
"string",
"array"
],
"default": null,
"description": "When set, only agents from allowed IP address ranges can connect to the server. Example: \"192.168.2.100,192.168.1.0/24\" \"file:agentAllowedIP.txt\""
},
"agentBlockedIP": {
"type": [
"string",
"array"
],
"default": null,
"description": "When set, agents from these denied IP address ranges will not be able to connect to the server. Example: \"192.168.2.100,192.168.1.0/24\" \"file:agentBlockedIP.txt\""
},
"authLog": {
"type": "string",
"default": null,
"description": "File path and name of the authentication log to be created. This log can be parsed by Fail2ban."
},
"InterUserMessaging": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"description": "Users in this list are allowed to send and receive inter-user messages. This can be used to implement bots or other software where MeshCentral is used as data transport. See \"interuser\" websocket command in the code."
},
"manageAllDeviceGroups": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"description": "Users in this list are allowed to see and manage all device groups within their domain."
},
"manageCrossDomain": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
},
"description": "Users in this list are allowed to manage all users in all domains."
},
"localDiscovery": {
"type": "object",
"description": "When this server is in LAN mode, you may discover this server using a multicast discovery tool. When discovery happens, the name and info fields are sent back to the discovery tool.",
"properties": {
"name": {
"type": "string"
},
"info": {
"type": "string"
},
"key": {
"type": "string",
"description": "When set, encrypts all LAN discovery traffic to agents and tools using this key. This is only useful in LAN/Hybrid mode when agents and tools user multicast to find the server."
}
},
"required": [
"name",
"info"
]
},
"tlsOffload": {
"type": [
"boolean",
"string"
],
"default": false,
"description": "When true, indicates that a TLS offloader is in front of the MeshCentral server. More typically, set this to the IP address of the reverse proxy or TLS offloader so that IP forwarding headers will be trusted. For example: \"127.0.0.1,192.168.1.100\"."
},
"useNodeDefaultTLSCiphers": {
"type": "boolean",
"default": false,
"description": "When true, get the default TLS ciphers from the node process, rather than using the recommended suites set up by meshcentral"
},
"tlsCiphers": {
"type": [
"string",
"array"
],
"default": null,
"description": "Allows user to override the TLS ciphers used by meshcentral by default. If a string, should be a ':' separated list of ciphers to accept. If an array, should be an array of strings representing the ciphers to accept."
},
"trustedProxy": {
"type": "string",
"default": null,
"description": "Trust forwarded headers from these IPs or domains. Providing the magic string \"CloudFlare\" will cause the server to download the IP address list of trusted CloudFlare proxies directly from CloudFlare on each server start. For example: \"127.0.0.1,proxy.example.com,CloudFlare\"."
},
"mpsPort": {
"type": "integer",
"minimum": 0,
"maximum": 65535,
"default": 4433,
"description": "The Management Presence Server (MPS), this is the server that received Intel AMT Client Initiated Remote Access (CIRA) connections."
},
"mpsPortBind": {
"type": "string",
"default": null
},
"mpsAliasPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": null
},
"mpsAliasHost": {
"type": "string",
"default": null
},
"mpsTlsOffload": {
"type": "boolean",
"default": false,
"description": "When set to true, indicate that TLS is being performed by a device in front of MeshCentral."
},
"mpsHighSecurity": {
"type": "boolean",
"default": false,
"description": "When set to true, the MPS server will only accept TLS 1.2 and 1.3 connections. Older Intel AMT devices will not be able to connect."
},
"prometheus": {
"type": [
"boolean",
"number"
],
"default": false,
"description": "When set to true, a prometheus metrics endpoint will be available \"0.0.0.0:9464/metrics\". If you specify a number instead, the prometheus metrics will listen on this port instead of the default 9464."
},
"no2FactorAuth": {
"type": "boolean",
"default": false
},
"debug": {
"type": "string",
"default": null,
"description": "You can set this value in the format 'web,agent,relay', where each value is separated by a comma. Each specified value will output logs to the MeshCentral console. Setting it to '*' will output all logs."
},
"log": {
"type": "string",
"default": null,
"description": "You can set this value in the format 'web,agent,relay', where each value is separated by a comma. Each specified value will output logs to a file named 'log.txt' located inside the 'meshcentral-data' folder. Setting it to '*' will output all logs."
},
"syslog": {
"type": "string",
"default": null
},
"syslogauth": {
"type": "string",
"default": null
},
"syslogjson": {
"type": "string",
"default": null
},
"syslogtcp": {
"type": "string",
"default": null,
"description": "Send syslog events over the network (RFC3164) to a target hostname:port. For example: localhost:514"
},
"webrtcConfig": {
"type": "object",
"description": "The STUN/TURN servers used for WebRTC, if not specified the Google and Cloudflare STUN servers are used when the server is not in LAN mode.",
"properties": {
"iceServers": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"urls": {
"type": "string",
"description": "STUN/TURN URLs, examples are stun:stun3.l.google.com:19302 or turn:openrelay.metered.ca:443"
}
},
"required": [
"urls"
]
}
}
},
"required": [
"iceServers"
]
},
"crowdsec": {
"type": "object",
"description": "Enabled the MeshCentral built-in Crowdsec bouncer. This section is passed directly to the bouncer, all of the settings are documented at https://www.npmjs.com/package/@crowdsec/express-bouncer",
"properties": {
"url": {
"type": "string",
"description": "The URL of your LAPI instance. Ex: http://localhost:8080"
},
"apiKey": {
"type": "string",
"description": "The bouncer key (generated via cscli)."
},
"fallbackRemediation": {
"type": "string",
"default": "ban",
"enum": [
"bypass",
"captcha",
"ban"
],
"description": "Action to perform if the CrowdSec agent can't be contacted."
}
},
"required": [
"url",
"apiKey"
]
},
"autoBackup": {
"type": [
"boolean",
"object"
],
"description": "Enabled by default or if set to true. Disabled if set to false. An object can be provided with additional properties to set autobackup options.",
"properties": {
"mongoDumpPath": {
"type": "string",
"default": "mongodump",
"description": "The file path of where \"mongodump\" is located. Default is \"mongodump\""
},
"mysqlDumpPath": {
"type": "string",
"default": "mysqldump",
"description": "The file path of where \"mysqldump\" is located. Default is \"mysqldump\""
},
"pgDumpPath": {
"type": "string",
"default": "pg_dump",
"description": "The file path of where \"pg_dump\" is located. Default is \"pg_dump\""
},
"backupIntervalHours": {
"type": "integer",
"default": 24,
"description": "How often should the autobackup run in hours from the second meshcentral starts up? Default is every 24 hours"
},
"backupHour": {
"type": "integer",
"default": 0,
"description": "At which hour the autobackup should run. This forces a daily backup, overrules a custom 'backupIntervalHours'."
},
"keepLastDaysBackup": {
"type": "integer",
"default": 10,
"description": "How many days of backups should the autobackup keep? Default is 10 Days worth"
},
"zipCompression" : {
"type": "integer",
"default": "5",
"description": "Set the zip compression level, 1=fast/less small file to 9=slow/smallest file."
},
"zipPassword": {
"type": "string",
"default": "",
"minLength": 1,
"description": "When specified, the ZIP backups will be password protected with the zipPassword and the password cannot be a blank value"
},
"backupPath": {
"type": "string",
"default": "meshcentral-backups",
"description": "The file path where backup files are kept. The default is \"meshcentral-backups\" which sits next to \"meshcentral-data\"."
},
"backupName": {
"type": "string",
"default": "meshcentral-autobackup-",
"description": "The filename of the backupfile. The default is \"meshcentral-autobackup-\", the filename is appended with the time of backup."
},
"backupWebFolders": {
"type": "boolean",
"default": false,
"description": "Add views, public and emails directories if overridden"
},
"backupOtherFolders": {
"type": "boolean",
"default": false,
"description": "Also add files and recordings folder to the backup"
},
"backupIgnoreFilesGlob": {
"type": "array",
"default": [],
"description": "Glob for ignoring files in the data directory. For example [\"**/*.log\"] !! If a string instead of an array is passed, it will be split by ',' so *{.txt,.log} won't work in that case !! Don't do string..."
},
"backupSkipFoldersGlob":{
"type": "array",
"default": [],
"description": "Glob for ignoring directories in the data directory. For example [\"**/signedagents\"]"
},
"googleDrive": {
"type": "object",
"description": "Enabled automated upload of the server backups to a Google Drive account, once enabled you need to go in \"My Server\" tab as administrator to associate the account.",
"properties": {
"folderName": {
"type": "string",
"default": "MeshCentral-Backups",
"description": "The name of the folder to create in the Google Drive account."
},
"maxFiles": {
"type": "integer",
"default": null,
"description": "The maximum number of files to keep in the Google Drive folder, older files will be removed if needed."
}
}
},
"webDAV": {
"type": "object",
"description": "Enabled automated upload of the server backups to a WebDAV account.",
"properties": {
"url": {
"type": "string",
"description": "WebDAV account URL."
},
"username": {
"type": "string",
"description": "WebDAV account username."
},
"password": {
"type": "string",
"description": "WebDAV account password."
},
"folderName": {
"type": "string",
"default": "MeshCentral-Backups",
"description": "The name of the folder to create in the WebDAV account."
},
"maxFiles": {
"type": "integer",
"default": null,
"description": "The maximum number of files to keep in the WebDAV folder, older files will be removed if needed."
}
}
},
"s3": {
"type": "object",
"description": "Enabled automated upload of the server backups to an S3 server.",
"required": [
"accessKey",
"secretKey",
"bucketName"
],
"properties": {
"endpoint": {
"type": "string",
"default": "s3.amazonaws.com",
"description": "S3 Endpoint address e.g. myS3.myserver.com"
},
"accessKey": {
"type": "string",
"description": "S3 accessKey, Required"