Skip to content

Commit 786df6a

Browse files
michaelklishinmichaelklishin
committed
Merge branch 'stable' into rabbitmq-server-batch-betas
2 parents 3aef38c + a2640d1 commit 786df6a

File tree

1 file changed

+60
-51
lines changed

1 file changed

+60
-51
lines changed

‎docs/rabbitmq.config.example

Lines changed: 60 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
%% ----------------------------------------------------------------------------
33
%% RabbitMQ Sample Configuration File.
44
%%
5-
%% See http://www.rabbitmq.com/configure.html for details.
5+
%% Related doc guide: http://www.rabbitmq.com/configure.html. See
6+
%% http://rabbitmq.com/documentation.html for documentation ToC.
67
%% ----------------------------------------------------------------------------
78
[
89
{rabbit,
910
[%%
10-
%% Network Connectivity
11+
%% Networking
1112
%% ====================
1213
%%
14+
%% Related doc guide: http://www.rabbitmq.com/networking.html.
1315

1416
%% By default, RabbitMQ will listen on all interfaces, using
1517
%% the standard (reserved) AMQP port.
@@ -22,19 +24,19 @@
2224
%% {tcp_listeners, [{"127.0.0.1", 5672},
2325
%% {"::1", 5672}]},
2426

25-
%% SSL listeners are configured in the same fashion as TCP listeners,
27+
%% TLS listeners are configured in the same fashion as TCP listeners,
2628
%% including the option to control the choice of interface.
2729
%%
2830
%% {ssl_listeners, [5671]},
2931

3032
%% Number of Erlang processes that will accept connections for the TCP
31-
%% and SSL listeners.
33+
%% and TLS listeners.
3234
%%
3335
%% {num_tcp_acceptors, 10},
3436
%% {num_ssl_acceptors, 1},
3537

3638
%% Maximum time for AMQP 0-8/0-9/0-9-1 handshake (after socket connection
37-
%% and SSL handshake), in milliseconds.
39+
%% and TLS handshake), in milliseconds.
3840
%%
3941
%% {handshake_timeout, 10000},
4042

@@ -55,9 +57,10 @@
5557
%% {reverse_dns_lookups, false},
5658

5759
%%
58-
%% Security / AAA
59-
%% ==============
60+
%% Security, Access Control
61+
%% ========================
6062
%%
63+
%% Related doc guide: http://www.rabbitmq.com/access-control.html.
6164

6265
%% The default "guest" user is only permitted to access the server
6366
%% via a loopback interface (e.g. localhost).
@@ -67,8 +70,10 @@
6770
%% guest user from anywhere on the network.
6871
%% {loopback_users, []},
6972

70-
%% Configuring SSL.
71-
%% See http://www.rabbitmq.com/ssl.html for full documentation.
73+
74+
%% TLS configuration.
75+
%%
76+
%% Related doc guide: http://www.rabbitmq.com/ssl.html.
7277
%%
7378
%% {ssl_options, [{cacertfile, "/path/to/testca/cacert.pem"},
7479
%% {certfile, "/path/to/server/cert.pem"},
@@ -81,7 +86,7 @@
8186
%% 'AMQPLAIN'. Additional mechanisms can be added via
8287
%% plugins.
8388
%%
84-
%% See http://www.rabbitmq.com/authentication.html for more details.
89+
%% Related doc guide: http://www.rabbitmq.com/authentication.html.
8590
%%
8691
%% {auth_mechanisms, ['PLAIN', 'AMQPLAIN']},
8792

@@ -94,10 +99,10 @@
9499
%% rabbitmq_auth_backend_ldap plugins.
95100
%%
96101
%% NB: These options require that the relevant plugin is enabled.
97-
%% See http://www.rabbitmq.com/plugins.html for further details.
102+
%% Related doc guide: http://www.rabbitmq.com/plugins.html for further details.
98103

99104
%% The RabbitMQ-auth-mechanism-ssl plugin makes it possible to
100-
%% authenticate a user based on the client's SSL certificate.
105+
%% authenticate a user based on the client's TLS certificate.
101106
%%
102107
%% To use auth-mechanism-ssl, add to or replace the auth_mechanisms
103108
%% list with the entry 'EXTERNAL'.
@@ -122,11 +127,11 @@
122127
%% https://github.com/rabbitmq/rabbitmq-auth-mechanism-ssl for further
123128
%% details.
124129
%%
125-
%% To use the SSL cert's CN instead of its DN as the username
130+
%% To use the TLS cert's CN instead of its DN as the username
126131
%%
127132
%% {ssl_cert_login_from, distinguished_name},
128133

129-
%% SSL handshake timeout, in milliseconds.
134+
%% TLS handshake timeout, in milliseconds.
130135
%%
131136
%% {ssl_handshake_timeout, 5000},
132137

@@ -142,7 +147,7 @@
142147
%% {password_hashing_module, rabbit_password_hashing_sha256},
143148

144149
%% Configuration entry encryption.
145-
%% See http://www.rabbitmq.com/configure.html#configuration-encryption
150+
%% Related doc guide: http://www.rabbitmq.com/configure.html#configuration-encryption
146151
%%
147152
%% To specify the passphrase in the configuration file:
148153
%%
@@ -179,8 +184,7 @@
179184

180185
%% Tags for default user
181186
%%
182-
%% For more details about tags, see the documentation for the
183-
%% Management Plugin at http://www.rabbitmq.com/management.html.
187+
%% Related doc guide: http://www.rabbitmq.com/management.html.
184188
%%
185189
%% {default_user_tags, [administrator]},
186190

@@ -192,7 +196,11 @@
192196
%% Sets the default AMQP 0-9-1 heartbeat timeout in seconds.
193197
%% Values lower than 6 can produce false positives and are not
194198
%% recommended.
195-
%% See http://www.rabbitmq.com/heartbeats.html.
199+
%%
200+
%% Related doc guides:
201+
%%
202+
%% * http://www.rabbitmq.com/heartbeats.html
203+
%% * http://www.rabbitmq.com/networking.html
196204
%%
197205
%% {heartbeat, 60},
198206

@@ -212,7 +220,7 @@
212220

213221
%% TCP socket options.
214222
%%
215-
%% See http://www.rabbitmq.com/networking.html.
223+
%% Related doc guide: http://www.rabbitmq.com/networking.html.
216224
%%
217225
%% {tcp_listen_options, [{backlog, 128},
218226
%% {nodelay, true},
@@ -222,7 +230,7 @@
222230
%% Resource Limits & Flow Control
223231
%% ==============================
224232
%%
225-
%% See http://www.rabbitmq.com/memory.html for full details.
233+
%% Related doc guide: http://www.rabbitmq.com/memory.html, http://www.rabbitmq.com/memory-use.html.
226234

227235
%% Memory-based Flow Control threshold.
228236
%%
@@ -266,7 +274,7 @@
266274
%% Introduced in 3.6.11. `allocated` is the default as of 3.6.13.
267275
%% See https://github.com/rabbitmq/rabbitmq-server/issues/1223 and rabbitmq/rabbitmq-common#224 for background.
268276
%% {vm_memory_calculation_strategy, allocated},
269-
277+
270278
%% Interval (in milliseconds) at which we perform the check of the memory
271279
%% levels against the watermarks.
272280
%%
@@ -303,12 +311,13 @@
303311
%% * <<"min-masters">>
304312
%% * <<"client-local">>
305313
%% * <<"random">>
306-
%% See https://www.rabbitmq.com/ha.html#queue-master-location
314+
%%
315+
%% Related doc guide: https://www.rabbitmq.com/ha.html#queue-master-location
307316
%%
308317
%% {queue_master_locator, <<"client-local">>},
309318

310319
%% Batch size (number of messages) used during eager queue mirror synchronisation.
311-
%% See https://www.rabbitmq.com/ha.html#batch-sync. When average message size is relatively large
320+
%% Related doc guide: https://www.rabbitmq.com/ha.html#batch-sync. When average message size is relatively large
312321
%% (say, 10s of kilobytes or greater), reducing this value will decrease peak amount
313322
%% of RAM used by newly joining nodes that need eager synchronisation.
314323
%%
@@ -326,13 +335,13 @@
326335
%% {server_properties, []},
327336

328337
%% How to respond to cluster partitions.
329-
%% See http://www.rabbitmq.com/partitions.html
338+
%% Related doc guide: http://www.rabbitmq.com/partitions.html
330339
%%
331340
%% {cluster_partition_handling, ignore},
332341

333342
%% Make clustering happen *automatically* at startup - only applied
334343
%% to nodes that have just been reset or started for the first time.
335-
%% See http://www.rabbitmq.com/clustering.html#auto-config
344+
%% Related doc guide: http://www.rabbitmq.com/clustering.html#auto-config
336345
%%
337346
%% {cluster_nodes, {['[email protected]'], disc}},
338347

@@ -378,12 +387,12 @@
378387
%% {mnesia_table_loading_retry_timeout, 30000},
379388

380389
%% Size in bytes below which to embed messages in the queue index.
381-
%% See http://www.rabbitmq.com/persistence-conf.html
390+
%% Related doc guide: http://www.rabbitmq.com/persistence-conf.html
382391
%%
383392
%% {queue_index_embed_msgs_below, 4096},
384393

385394
%% Maximum number of queue index entries to keep in journal
386-
%% See http://www.rabbitmq.com/persistence-conf.html.
395+
%% Related doc guide: http://www.rabbitmq.com/persistence-conf.html.
387396
%%
388397
%% {queue_index_max_journal_entries, 32768},
389398

@@ -408,7 +417,7 @@
408417
%% Increasing these values may help with throughput but also can be dangerous:
409418
%% high credit flow values are no different from not having flow control at all.
410419
%%
411-
%% See https://www.rabbitmq.com/blog/2015/10/06/new-credit-flow-settings-on-rabbitmq-3-5-5/
420+
%% Related doc guide: https://www.rabbitmq.com/blog/2015/10/06/new-credit-flow-settings-on-rabbitmq-3-5-5/
412421
%% and http://alvaro-videla.com/2013/09/rabbitmq-internals-credit-flow-for-erlang-processes.html.
413422
%%
414423
%% {credit_flow_default_credit, {400, 200}},
@@ -466,7 +475,7 @@
466475
%% ----------------------------------------------------------------------------
467476
%% Advanced Erlang Networking/Clustering Options.
468477
%%
469-
%% See http://www.rabbitmq.com/clustering.html for details
478+
%% Related doc guide: http://www.rabbitmq.com/clustering.html
470479
%% ----------------------------------------------------------------------------
471480
{kernel,
472481
[%% Sets the net_kernel tick time.
@@ -479,22 +488,22 @@
479488
%% ----------------------------------------------------------------------------
480489
%% RabbitMQ Management Plugin
481490
%%
482-
%% See http://www.rabbitmq.com/management.html for details
491+
%% Related doc guide: http://www.rabbitmq.com/management.html
483492
%% ----------------------------------------------------------------------------
484493

485494
{rabbitmq_management,
486-
[%% Pre-Load schema definitions from the following JSON file. See
495+
[%% Preload schema definitions from a previously exported definitions file. See
487496
%% http://www.rabbitmq.com/management.html#load-definitions
488497
%%
489-
%% {load_definitions, "/path/to/schema.json"},
498+
%% {load_definitions, "/path/to/exported/definitions.json"},
490499

491-
%% Log all requests to the management HTTP API to a file.
500+
%% Log all requests to the management HTTP API to a directory.
492501
%%
493-
%% {http_log_dir, "/path/to/access.log"},
502+
%% {http_log_dir, "/path/to/rabbitmq/logs/http"},
494503

495504
%% Change the port on which the HTTP listener listens,
496505
%% specifying an interface for the web server to bind to.
497-
%% Also set the listener to use SSL and provide SSL options.
506+
%% Also set the listener to use TLS and provide TLS options.
498507
%%
499508
%% {listener, [{port, 12345},
500509
%% {ip, "127.0.0.1"},
@@ -521,7 +530,7 @@
521530
%% ----------------------------------------------------------------------------
522531
%% RabbitMQ Shovel Plugin
523532
%%
524-
%% See http://www.rabbitmq.com/shovel.html for details
533+
%% Related doc guide: http://www.rabbitmq.com/shovel.html
525534
%% ----------------------------------------------------------------------------
526535

527536
{rabbitmq_shovel,
@@ -587,9 +596,9 @@
587596
]},
588597

589598
%% ----------------------------------------------------------------------------
590-
%% RabbitMQ Stomp Adapter
599+
%% RabbitMQ STOMP Plugin
591600
%%
592-
%% See http://www.rabbitmq.com/stomp.html for details
601+
%% Related doc guide: http://www.rabbitmq.com/stomp.html
593602
%% ----------------------------------------------------------------------------
594603

595604
{rabbitmq_stomp,
@@ -599,18 +608,18 @@
599608
%% {tcp_listeners, [{"127.0.0.1", 61613},
600609
%% {"::1", 61613}]},
601610

602-
%% Listen for SSL connections on a specific port.
611+
%% Listen for TLS connections on a specific port.
603612
%% {ssl_listeners, [61614]},
604613

605614
%% Number of Erlang processes that will accept connections for the TCP
606-
%% and SSL listeners.
615+
%% and TLS listeners.
607616
%%
608617
%% {num_tcp_acceptors, 10},
609618
%% {num_ssl_acceptors, 1},
610619

611-
%% Additional SSL options
620+
%% Additional TLS options
612621

613-
%% Extract a name from the client's certificate when using SSL.
622+
%% Extract a name from the client's certificate when using TLS.
614623
%%
615624
%% {ssl_cert_login, true},
616625

@@ -623,21 +632,21 @@
623632
%% {default_user, [{login, "guest"},
624633
%% {passcode, "guest"}]},
625634

626-
%% If a default user is configured, or you have configured use SSL client
635+
%% If a default user is configured, or you have configured use TLS client
627636
%% certificate based authentication, you can choose to allow clients to
628637
%% omit the CONNECT frame entirely. If set to true, the client is
629638
%% automatically connected as the default user or user supplied in the
630-
%% SSL certificate whenever the first frame sent on a session is not a
639+
%% TLS certificate whenever the first frame sent on a session is not a
631640
%% CONNECT frame.
632641
%%
633642
%% {implicit_connect, true}
634643
]},
635644

636645
%% ----------------------------------------------------------------------------
637-
%% RabbitMQ MQTT Adapter
646+
%% RabbitMQ MQTT Plugin
647+
%%
648+
%% Related doc guide: https://github.com/rabbitmq/rabbitmq-mqtt/blob/stable/README.md
638649
%%
639-
%% See https://github.com/rabbitmq/rabbitmq-mqtt/blob/stable/README.md
640-
%% for details
641650
%% ----------------------------------------------------------------------------
642651

643652
{rabbitmq_mqtt,
@@ -700,8 +709,8 @@
700709
%% ----------------------------------------------------------------------------
701710
%% RabbitMQ AMQP 1.0 Support
702711
%%
703-
%% See https://github.com/rabbitmq/rabbitmq-amqp1.0/blob/stable/README.md
704-
%% for details
712+
%% Related doc guide: https://github.com/rabbitmq/rabbitmq-amqp1.0/blob/stable/README.md
713+
%%
705714
%% ----------------------------------------------------------------------------
706715

707716
{rabbitmq_amqp1_0,
@@ -721,7 +730,7 @@
721730
%% ----------------------------------------------------------------------------
722731
%% RabbitMQ LDAP Plugin
723732
%%
724-
%% See http://www.rabbitmq.com/ldap.html for details.
733+
%% Related doc guide: http://www.rabbitmq.com/ldap.html.
725734
%%
726735
%% ----------------------------------------------------------------------------
727736

@@ -736,7 +745,7 @@
736745
%%
737746
%% {servers, ["your-server-name-goes-here"]},
738747

739-
%% Connect to the LDAP server using SSL
748+
%% Connect to the LDAP server using TLS
740749
%%
741750
%% {use_ssl, false},
742751

0 commit comments

Comments
 (0)