-
-
Notifications
You must be signed in to change notification settings - Fork 387
/
vmq_server.schema
1732 lines (1587 loc) · 103 KB
/
vmq_server.schema
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
%% -*- mode: erlang -*-
%% ex: ft=erlang
%% @doc Allow anonymous users to connect, default is 'off'. !!NOTE!!
%% Enabling this completely disables authentication of the clients and
%% should only be used for testing/development purposes or in case
%% clients are authenticated by some other means.
{mapping, "allow_anonymous", "vmq_server.allow_anonymous", [
{default, off},
{datatype, flag}
]}.
%% @doc Allow new client connections even when a VerneMQ cluster is inconsistent.
{mapping, "allow_register_during_netsplit", "vmq_server.allow_register_during_netsplit", [
{default, off},
{datatype, flag}
]}.
%% @doc Allow message publishs even when a VerneMQ cluster is inconsistent.
{mapping, "allow_publish_during_netsplit", "vmq_server.allow_publish_during_netsplit", [
{default, off},
{datatype, flag}
]}.
%% @doc Allow new subscriptions even when a VerneMQ cluster is inconsistent.
{mapping, "allow_subscribe_during_netsplit", "vmq_server.allow_subscribe_during_netsplit", [
{default, off},
{datatype, flag}
]}.
%% @doc Allow clients to unsubscribe when a VerneMQ cluster is inconsistent.
{mapping, "allow_unsubscribe_during_netsplit", "vmq_server.allow_unsubscribe_during_netsplit", [
{default, off},
{datatype, flag}
]}.
%% @doc Allows a client to logon multiple times using the same client
%% id (non-standard behaviour!). This feature is DEPRECATED and will
%% be removed in VerneMQ 2.0.
{mapping, "allow_multiple_sessions", "vmq_server.allow_multiple_sessions", [
{default, off},
{datatype, flag}
]}.
{translation, "vmq_server.allow_multiple_sessions",
fun(Conf) ->
case cuttlefish:conf_get("allow_multiple_sessions", Conf) of
true ->
cuttlefish:warn("allow_multiple_sessions is deprecated and will be removed in VerneMQ 2.0"),
true;
false -> false
end
end}.
%% @doc Client registrations can be either happen in a coordinated or
%% uncoordinated fashion. Uncoordinated registrations are faster and
%% will cause other clients with the same client-id to be eventually
%% disconnected, while coordinated ensures that any other client with
%% the same client-id will be immediately disconnected.
{mapping, "coordinate_registrations", "vmq_server.coordinate_registrations",
[{default, on},
{datatype, flag}]}.
%% @doc If allow_multiple_sessions is enabled 'queue_deliver_mode' will specify
%% how the messages are delivered to multiple sessions. Default is 'fanout' which
%% specifies to deliver every message to all connected sessions. 'balance' specifies
%% that the messages will be randomly balanced to the connected sessions.
%% (non-standard behaviour!).
{mapping, "queue_deliver_mode", "vmq_server.queue_deliver_mode", [
{default, fanout},
{datatype, atom},
hidden
]}.
{translation, "vmq_server.queue_deliver_mode",
fun(Conf) ->
case cuttlefish:conf_get("queue_deliver_mode", Conf) of
fanout -> fanout;
balance -> balance;
_ -> cuttlefish:invalid("queue_deliver_mode must be either 'fanout' or 'balance'!")
end
end}.
%% @doc queue_type enables to change the default queue delivery behaviour from
%% 'fifo' to 'lifo'. In order to make this work the underlying message store
%% must deliver the messages in proper order.
{mapping, "queue_type", "vmq_server.queue_type", [
{default, fifo},
{datatype, atom},
hidden
]}.
{translation, "vmq_server.queue_type",
fun(Conf) ->
case cuttlefish:conf_get("queue_type", Conf) of
fifo -> fifo;
lifo -> lifo;
_ -> cuttlefish:invalid("queue_type must be either 'fifo' or 'lifo'!")
end
end}.
%% @doc Due to the eventual consistent nature of the subscriber store it is
%% possible that during queue migration messages still arive on the old cluster
%% node. This parameter allows to compensate this by keeping the queue around
%% for some time after it was migrated to the other cluster node.
{mapping, "max_drain_time", "vmq_server.max_drain_time", [
{default, 500},
{datatype, integer},
hidden
]}.
%% @doc Specifies the number of messages that are delviered to the remote
%% node per drain step. A large value will provide a faster migration of a queue,
%% but increases the waste of bandwidth in case the migration fails.
{mapping, "max_msgs_per_drain_step", "vmq_server.max_msgs_per_drain_step", [
{default, 100},
{datatype, integer},
hidden
]}.
%% @doc Specifies the number of queue supervisors. The number of
%% queues per supervisor should never become too large as this can
%% lead to overload situations on massive disconnects of clients (as
%% each supervisor needs to handle all the disconnect messages of its
%% child queues). A reasonable max number of child queues per
%% supervisor is probably in the range of 2k-6k, but varies depending
%% on the hardware used.
{mapping, "queue_sup_sup_children", "vmq_server.queue_sup_sup_children", [
{default, 50},
{datatype, integer},
hidden
]}.
%% @doc Allows to select a new default reg_view.
%% A view is a pre-defined way to route messages. Multiple views can be
%% loaded and used, but one has to be selected as a default. The default routing is
%% vmq_reg_trie, i.e. routing via the built-in trie data structure.
{mapping, "default_reg_view", "vmq_server.default_reg_view", [
{default, vmq_reg_trie},
{datatype, atom},
hidden
]}.
%% @doc the views that are started during startup
{mapping, "reg_views", "vmq_server.reg_views", [
{default, "[vmq_reg_trie]"},
{datatype, string},
hidden
]}.
{translation, "vmq_server.reg_views",
fun(Conf) ->
S = cuttlefish:conf_get("reg_views", Conf),
{ok, T, _} = erl_scan:string(S ++ "."),
{ok, Term} = erl_parse:parse_term(T),
Term
end}.
%% @doc Set the time in seconds VerneMQ waits before a retry, in case a (QoS=1 or QoS=2) message
%% delivery gets no answer.
{mapping, "retry_interval", "vmq_server.retry_interval", [
{default, 20},
{commented, 20},
{datatype, integer}
]}.
%% @doc Set the maximum size for client IDs. MQTT v3.1 specifies a
%% limit of 23 characters
{mapping, "max_client_id_size", "vmq_server.max_client_id_size", [
{default, 100},
{commented, 100},
{datatype, integer}
]}.
%% @doc This option allows persistent clients ( = clean session set to
%% false) to be removed if they do not reconnect within 'persistent_client_expiration'.
%% This is a non-standard option. As far as the MQTT specification is concerned,
%% persistent clients persist forever.
%% The expiration period should be an integer followed by one of 'd', 'w', 'm', 'y' for
%% day, week, month, and year.
{mapping, "persistent_client_expiration", "vmq_server.persistent_client_expiration", [
{default, "never"},
{commented, "1w"},
{datatype, string}
]}.
{translation, "vmq_server.persistent_client_expiration",
fun(Conf) ->
S = cuttlefish:conf_get("persistent_client_expiration", Conf),
case S of
"never" -> 0;
_ ->
case vmq_schema:string_to_secs(S) of
error ->
cuttlefish:invalid(S ++ " must be an integer followed by one of 'h', 'd', 'w', 'm', 'y' for hour, day, week, month, and year, or the string 'never'");
Val -> Val
end
end
end}.
%% @doc The maximum delay for a last will message. This setting
%% applies only to MQTTv5 sessions and overrides the value provided by
%% the client.
%% The delay should be an integer followed by one of 's', 'h' 'd',
%% 'w', 'm', 'y' for day, week, month, and year.
{mapping, "max_last_will_delay", "vmq_server.max_last_will_delay", [
{default, "0s"},
{commented, "0s"},
{datatype, string}
]}.
{translation, "vmq_server.max_last_will_delay",
fun(Conf) ->
S = cuttlefish:conf_get("max_last_will_delay", Conf),
case vmq_schema:string_to_secs(S) of
error ->
cuttlefish:invalid(S ++ " must be an integer followed by one of 's', 'h', 'd', 'w', 'm', 'y' for second, minute, hour, day, week, month, and year");
Val -> Val
end
end}.
%% @doc The maximum number of QoS 1 or 2 messages that can be in the process of being
%% transmitted simultaneously. This includes messages currently going through handshakes
%% and messages that are being retried. Defaults to 20. Set to 0 for no maximum. If set
%% to 1, this will guarantee in-order delivery of messages.
{mapping, "max_inflight_messages", "vmq_server.max_inflight_messages", [
{default, 20},
{datatype, integer}
]}.
%% @doc The maximum number of messages to hold in the queue above
%% those messages that are currently in flight. Defaults to 1000. This affects
%% messages of any QoS. Set to -1 for no maximum (not recommended).
%% This option allows to control how a specific client session can deal
%% with message bursts. As a general rule of thumb set
%% this number a bit higher than the expected message rate a single consumer is
%% required to process. Note that setting this value to 0 will totally block
%% delivery from any queue.
{mapping, "max_online_messages", "vmq_server.max_online_messages", [
{default, 1000},
{datatype, integer}
]}.
%% @doc The maximum number of QoS 1 or 2 messages to hold in the offline queue.
%% Defaults to 1000. Set to -1 for no maximum (not recommended). Set to 0
%% if no messages should be stored offline.
{mapping, "max_offline_messages", "vmq_server.max_offline_messages", [
{default, 1000},
{datatype, integer}
]}.
%% @doc specify in case multiple sessions are allowed how the queue should
%% deliver the messages. In case of 'fanout' all the attached sessions
%% will receive the message, in case of 'balance' an attached session is
%% choosen randomly.
{mapping, "queue_deliver_mode", "vmq_server.queue_deliver_mode", [{default, fanout},
{datatype, atom},
hidden]}.
%% @doc specify how the queue should process the messages,
%% either the 'fifo' or 'lifo' way.
{mapping, "queue_type", "vmq_server.queue_type", [{default, fifo},
{datatype, atom},
hidden]}.
%% @doc specifies the maximum incoming publish rate per session. Depending
%% on the underlying network buffers this rate isn't enforced.
%% defaults to 0, which means no rate limits apply
{mapping, "max_message_rate", "vmq_server.max_message_rate", [
{default, 0},
{datatype, integer},
hidden
]}.
%% @doc This option sets the maximum MQTT size that VerneMQ will
%% allow. Messages that exceed this size will not be accepted by
%% VerneMQ. The default value is 0, which means that all valid MQTT
%% messages are accepted. MQTT imposes a maximum payload size of
%% 268435455 bytes.
{mapping, "max_message_size", "vmq_server.max_message_size", [
{default, 0},
{datatype, integer}
]}.
%% @doc deprecated - use `max_message_size` instead.
{mapping, "message_size_limit", "vmq_server.message_size_limit", [
{default, 0},
{datatype, integer},
hidden
]}.
{translation, "vmq_server.message_size_limit",
fun(Conf) ->
Size = cuttlefish:conf_get("message_size_limit", Conf),
case Size of
0 ->
Size;
_ ->
cuttlefish:warn("message_size_limit is deprecated and has no effect, use max_message_size instead"),
Size
end
end}.
%% @doc If a message is published with a QoS lower than the QoS of the subscription it is
%% delivered to, VerneMQ can upgrade the outgoing QoS. This is a non-standard option.
{mapping, "upgrade_outgoing_qos", "vmq_server.upgrade_outgoing_qos", [
{default, off},
{datatype, flag}
]}.
%% @doc specifies how many size in bytes are buffered in case the remote node
%% is not available.
{mapping, "outgoing_clustering_buffer_size", "vmq_server.outgoing_clustering_buffer_size", [
{default, 10000},
{datatype, integer},
hidden
]}.
%% @doc specifies the timeout for enqueing something in a queue on a remote node.
{mapping, "remote_enqueue_timeout", "vmq_server.remote_enqueue_timeout", [
{default, 5000},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
%% @doc specifies the modules that should be evaluated when setting up the cowboy routes
{mapping, "http_modules", "vmq_server.http_modules", [
{default, "[vmq_metrics_http,vmq_http_mgmt_api, vmq_status_http, vmq_health_http]"},
{datatype, string},
hidden
]}.
{translation, "vmq_server.http_modules",
fun(Conf) ->
S = cuttlefish:conf_get("http_modules", Conf),
{ok, T, _} = erl_scan:string(S ++ "."),
{ok, Term} = erl_parse:parse_term(T),
Term
end}.
%% @doc listener.tcp.buffer_sizes is an list of three integers
%% (sndbuf,recbuf,buffer) specifying respectively the kernel TCP send
%% buffer, the kernel TCP receive buffer and the user-level buffer
%% size in the erlang driver.
%%
%% It is recommended to have val(user-level buffer) >= val(receive
%% buffer) to avoid performance issues because of unnecessary copying.
%%
%% If not set, the operating system defaults are used.
%%
%% This option can be set on the protocol level by:
%%
%% - listener.tcp.buffer_sizes
%% - listener.ssl.buffer_sizes
%%
%% or on the listener level by:
%%
%% - listener.tcp.my_tcp_listener.buffer_sizes
%% - listener.ssl.my_ssl_listener.buffer_sizes
{mapping, "listener.tcp.buffer_sizes", "vmq_server.listeners",
[{commented, "4096,16384,32768"},
{datatype, string},
{validators, ["buffer_size_validator"]}
]}.
{mapping, "listener.tcp.$name.buffer_sizes", "vmq_server.listeners",
[{datatype, string},
hidden,
{validators, ["buffer_size_validator"]}
]}.
{mapping, "listener.ssl.buffer_sizes", "vmq_server.listeners",
[{datatype, string},
hidden,
{validators, ["buffer_size_validator"]}
]}.
{mapping, "listener.ssl.$name.buffer_sizes", "vmq_server.listeners",
[{datatype, string},
hidden,
{validators, ["buffer_size_validator"]}
]}.
{validator, "buffer_size_validator", "value must be three comma-separated, positive integers",
fun(Val) when is_list(Val) ->
case vmq_schema:parse_list_to_term(Val) of
{ok, [A,B,C]} when is_integer(A), is_integer(B), is_integer(C),
A >= 0, B >= 0, C >= 0 ->
true;
_ ->
false
end;
(Val) ->
false
end}.
%% @doc listener.max_connections is an integer or 'infinity' defining
%% the maximum number of concurrent connections. This option can be overridden
%% on the protocol level by:
%%
%% - listener.tcp.max_connections
%% - listener.ssl.max_connections
%% - listener.ws.max_connections
%% - listener.wss.max_connections
%%
%% or on the listener level by:
%%
%% - listener.tcp.my_tcp_listener.max_connections
%% - listener.ssl.my_ssl_listener.max_connections
%% - listener.ws.my_ws_listener.max_connections
%% - listener.wss.my_wss_listener.max_connections
{mapping, "listener.max_connections", "vmq_server.listeners", [
{default, {{max_connections}} },
{datatype, [integer, {atom, infinity}]}
]}.
{mapping, "listener.tcp.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.tcp.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.ssl.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.ssl.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.ws.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.ws.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.wss.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.wss.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.vmq.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.vmq.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.vmqs.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.vmqs.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.http.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.http.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.https.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
{mapping, "listener.https.$name.max_connections", "vmq_server.listeners", [
{default, -1},
{datatype, [integer, {atom, infinity}]},
hidden
]}.
%% @doc Set the nr of acceptors waiting to concurrently accept new connections.
%% This can be specified either on the protocol level:
%%
%% - listener.tcp.nr_of_acceptors
%% - listener.ssl.nr_of_acceptors
%% - listener.ws.nr_of_acceptors
%% - listener.wss.nr_of_acceptors
%%
%% or on the listener level:
%%
%% - listener.tcp.my_tcp_listener.nr_of_acceptors
%% - listener.ssl.my_ssl_listener.nr_of_acceptors
%% - listener.ws.my_ws_listener.nr_of_acceptors
%% - listener.wss.my_wss_listener.nr_of_acceptors
{mapping, "listener.nr_of_acceptors", "vmq_server.listeners", [
{default, {{ max_nr_of_acceptors}} },
{datatype, integer}
]}.
{mapping, "listener.tcp.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
hidden
]}.
{mapping, "listener.tcp.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.ssl.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
hidden
]}.
{mapping, "listener.ssl.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.ws.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
hidden
]}.
{mapping, "listener.ws.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.wss.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
hidden
]}.
{mapping, "listener.wss.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, -1},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.vmq.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
hidden
]}.
{mapping, "listener.vmq.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.vmqs.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
hidden
]}.
{mapping, "listener.vmqs.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.http.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
hidden
]}.
{mapping, "listener.http.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
{include_default, "default"},
hidden
]}.
{mapping, "listener.https.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
hidden
]}.
{mapping, "listener.https.$name.nr_of_acceptors", "vmq_server.listeners", [
{default, 10},
{datatype, integer},
{include_default, "default"},
hidden
]}.
%% @doc listener.tcp.<name> is an IP address and TCP port that
%% the broker will bind to. You can define multiple listeners e.g:
%% - listener.tcp.default = 127.0.0.1:1883
%% - listener.tcp.internal = 127.0.0.1:10883
%% - listener.tcp.my_other_listener = 127.0.0.1:10884
%% This also works for SSL listeners and WebSocket handlers:
%% - listener.ssl.default = 127.0.0.1:8883
%% - listener.ws.default = 127.0.0.1:800
%% - listener.wss.default = 127.0.0.1:880
{mapping, "listener.tcp.$name", "vmq_server.listeners", [
{default, { "{{mqtt_default_ip}}", {{mqtt_default_port}} }},
{datatype, ip},
{include_default, "default"}
]}.
{mapping, "listener.ws.$name", "vmq_server.listeners", [
{default, { "{{mqtt_default_ws_ip}}", {{mqtt_default_ws_port}} }},
{datatype, ip},
hidden
]}.
{mapping, "listener.wss.$name", "vmq_server.listeners", [
{default, { "{{mqtt_default_ws_ip}}", {{mqtt_default_ws_port}} }},
{datatype, ip},
hidden
]}.
{mapping, "listener.ssl.$name", "vmq_server.listeners", [
{default, { "{{mqtt_default_ip}}", {{mqtt_default_port}} }},
{datatype, ip},
hidden
]}.
%% @doc listener.tcp.proxy_protocol specifies if the listener accepts
%% connections opened by a proxy server that supports the PROXY protocol. This
%% enables to retrieve peer information such as source IP/Port but also for the
%% PROXY Version 2 protocol TLS client certificate details if the proxy was used
%% to terminate TLS (and also supports the PROXY protocol).
{mapping, "listener.tcp.proxy_protocol", "vmq_server.listeners", [
{default, off},
{datatype, flag},
hidden
]}.
{mapping, "listener.tcp.$name.proxy_protocol", "vmq_server.listeners", [
{datatype, flag},
hidden
]}.
{mapping, "listener.ws.proxy_protocol", "vmq_server.listeners", [
{default, off},
{datatype, flag},
hidden
]}.
{mapping, "listener.ws.$name.proxy_protocol", "vmq_server.listeners", [
{datatype, flag},
hidden
]}.
{mapping, "listener.http.proxy_protocol", "vmq_server.listeners", [
{default, off},
{datatype, flag},
hidden
]}.
{mapping, "listener.http.$name.proxy_protocol", "vmq_server.listeners", [
{datatype, flag},
hidden
]}.
%% @doc If 'listener.tcp.proxy_protocol' is enabled, you may enable
%% 'listener.tcp.proxy_protocol_use_cn_as_username' to use the CN
%% (sni_hostname) passed via the PROXY protocol instead of the MQTT
%% username. The option can be specified either for all tcp or
%% websocket listeners:
%%
%% - listener.tcp.proxy_protocol_use_cn_as_username
%% - listener.ws.proxy_protocol_use_cn_as_username
%%
%% or for a specific listener:
%%
%% - listener.tcp.my_tcp_listener.use_cn_as_username
%% - listener.ws.my_ws_listener.use_cn_as_username
{mapping, "listener.tcp.proxy_protocol_use_cn_as_username", "vmq_server.listeners", [
{default, on},
{datatype, flag},
hidden
]}.
{mapping, "listener.tcp.$name.proxy_protocol_use_cn_as_username", "vmq_server.listeners", [
{datatype, flag},
hidden
]}.
{mapping, "listener.ws.proxy_protocol_use_cn_as_username", "vmq_server.listeners", [
{default, on},
{datatype, flag},
hidden
]}.
{mapping, "listener.ws.$name.proxy_protocol_use_cn_as_username", "vmq_server.listeners", [
{datatype, flag},
hidden
]}.
{mapping, "listener.http.proxy_protocol_use_cn_as_username", "vmq_server.listeners", [
{default, on},
{datatype, flag},
hidden
]}.
{mapping, "listener.http.$name.proxy_protocol_use_cn_as_username", "vmq_server.listeners", [
{datatype, flag},
hidden
]}.
%% @doc 'listener.tcp.allowed_protocol_versions' configures which
%% protocol versions are allowed for an MQTT listener. The allowed
%% protocol versions can be specified the tcp, websocket or ssl level:
%%
%% - listener.tcp.allowed_protocol_versions
%% - listener.ws.allowed_protocol_versions
%% - listener.wss.allowed_protocol_versions
%% - listener.ssl.allowed_protocol_versions
%%
%% or for a specific listener:
%%
%% - listener.tcp.my_tcp_listener.allowed_protocol_versions
%% - listener.ws.my_ws_listener.allowed_protocol_versions
%% - listener.wss.my_ws_listener.allowed_protocol_versions
%% - listener.ssl.my_ws_listener.allowed_protocol_versions
%%
%% Allowed values are 3 (MQTT 3.1), 4 (MQTT 3.1.1), 5 (MQTT 5.0), 131
%% (MQTT 3.1 bridge).
{mapping, "listener.tcp.allowed_protocol_versions", "vmq_server.listeners",
[
{default, "3,4,131"},
{datatype, string},
{commented, "3,4"}
]}.
{mapping, "listener.tcp.$name.allowed_protocol_versions", "vmq_server.listeners",
[
{datatype, string},
hidden
]}.
{mapping, "listener.ws.allowed_protocol_versions", "vmq_server.listeners",
[
{default, "3,4,131"},
{datatype, string},
hidden
]}.
{mapping, "listener.ws.$name.allowed_protocol_versions", "vmq_server.listeners",
[
{datatype, string},
hidden
]}.
{mapping, "listener.wss.allowed_protocol_versions", "vmq_server.listeners",
[
{default, "3,4,131"},
{datatype, string},
hidden
]}.
{mapping, "listener.wss.$name.allowed_protocol_versions", "vmq_server.listeners",
[
{datatype, string},
hidden
]}.
{mapping, "listener.ssl.allowed_protocol_versions", "vmq_server.listeners",
[
{default, "3,4,131"},
{datatype, string},
hidden
]}.
{mapping, "listener.ssl.$name.allowed_protocol_versions", "vmq_server.listeners",
[
{datatype, string},
hidden
]}.
%% @doc listener.vmq.clustering is the IP address and TCP port that
%% the broker will bind to accept connections from other cluster
%% nodes e.g:
%% - listener.vmq.clustering = 0.0.0.0:18883
%% This also works for SSL listeners:
%% - listener.vmqs.clustering = 0.0.0.0:18884
{mapping, "listener.vmq.$name", "vmq_server.listeners", [
{default, { "{{cluster_default_ip}}", {{cluster_default_port}} }},
{datatype, ip},
{include_default, "clustering"}
]}.
{mapping, "listener.vmqs.$name", "vmq_server.listeners", [
{default, { "{{cluster_default_ip}}", {{cluster_default_port}} }},
{datatype, ip},
hidden
]}.
%% @doc listener.http.default is the IP address and TCP port that
%% the broker will bind to accept HTTP connections
%% - listener.http.default = 0.0.0.0:8888
%% This also works for SSL listeners:
%% - listener.https.default= 0.0.0.0:8889
{mapping, "listener.http.$name", "vmq_server.listeners", [
{default, { "{{http_default_ip}}", {{http_default_port}} }},
{datatype, ip},
{include_default, "default"}
]}.
{mapping, "listener.http.$name.config_mod", "vmq_server.listeners", [
{default, vmq_http_config},
{datatype, atom},
hidden
]}.
{mapping, "listener.http.$name.config_fun", "vmq_server.listeners", [
{default, config},
{datatype, atom},
hidden
]}.
{mapping, "listener.https.$name", "vmq_server.listeners", [
{default, { "{{http_default_ip}}", {{http_default_port}} }},
{datatype, ip},
hidden
]}.
{mapping, "listener.https.$name.config_mod", "vmq_server.listeners", [
{default, vmq_http_config},
{datatype, atom},
hidden
]}.
{mapping, "listener.https.$name.config_fun", "vmq_server.listeners", [
{default, config},
{datatype, atom},
hidden
]}.
%% @doc Set the mountpoint on the protocol level or on the listener level
%%
%% - listener.tcp.mountpoint
%% - listener.ssl.mountpoint
%% - listener.ws.mountpoint
%% - listener.wss.mountpoint
%%
%% listener level:
%%
%% - listener.tcp.my_tcp_listener.mountpoint
%% - listener.ssl.my_ssl_listener.mountpoint
%% - listener.ws.my_ws_listener.mountpoint
%% - listener.wss.my_wss_listener.mountpoint
{mapping, "listener.mountpoint", "vmq_server.listeners", [{default, "off"},
{datatype, string},
hidden
]}.
{mapping, "listener.tcp.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.tcp.$name.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.ws.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.ws.$name.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.wss.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.wss.$name.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.ssl.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.ssl.$name.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.vmq.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.vmq.$name.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.vmqs.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
{mapping, "listener.vmqs.$name.mountpoint", "vmq_server.listeners", [
{datatype, string},
hidden
]}.
%% @doc The cafile is used to define the path to a file containing
%% the PEM encoded CA certificates that are trusted. Set the cafile
%% on the protocol level or on the listener level:
%%
%% - listener.ssl.cafile
%% - listener.wss.cafile
%%
%% or on the listener level:
%%
%% - listener.ssl.my_ssl_listener.cafile
%% - listener.wss.my_wss_listener.cafile
{mapping, "listener.ssl.cafile", "vmq_server.listeners", [
{default, ""},
{datatype, file},
{commented, "{{platform_etc_dir}}/cacerts.pem"},
{validators, ["file-exists", "file-is-readable"]}
]}.
{mapping, "listener.ssl.$name.cafile", "vmq_server.listeners", [
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
hidden
]}.
{mapping, "listener.wss.cafile", "vmq_server.listeners", [
{default, ""},
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
hidden
]}.
{mapping, "listener.wss.$name.cafile", "vmq_server.listeners", [
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
hidden
]}.
{mapping, "listener.vmqs.cafile", "vmq_server.listeners", [
{default, ""},
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
hidden
]}.
{mapping, "listener.vmqs.$name.cafile", "vmq_server.listeners", [
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
hidden
]}.
{mapping, "listener.https.cafile", "vmq_server.listeners", [
{default, ""},
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
{commented, "{{platform_etc_dir}}/cacerts.pem"}
]}.
{mapping, "listener.https.$name.cafile", "vmq_server.listeners", [
{datatype, file},
{validators, ["file-exists", "file-is-readable"]},
hidden
]}.
%% @doc When dealing with an intermediate CA, it might be required to
%% increase the peer verification depth to have a client certificate
%% correctly validated. The default value (1) means that only certificates
%% signed by the root CA will be accepted, whereas an higher value allows
%% for a deeper verification chain. Please refer to http://erlang.org/doc/man/ssl.html