Skip to content

Commit 05b870d

Browse files
rabbitmq.conf.example: add a few missing keys; drive-by edits and corrections
(cherry picked from commit 8ffecb1)
1 parent ec4a97b commit 05b870d

File tree

1 file changed

+67
-21
lines changed

1 file changed

+67
-21
lines changed

deps/rabbit/docs/rabbitmq.conf.example

Lines changed: 67 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## This example configuration file demonstrates various settings
2-
## available via rabbitmq.conf. It primarily focuses core broker settings
2+
## available via rabbitmq.conf. It primarily focuses on core broker settings
33
## but some tier 1 plugin settings are also covered.
44
##
55
## This file is AN EXAMPLE. It is NOT MEANT TO BE USED IN PRODUCTION. Instead of
@@ -99,7 +99,7 @@
9999
## Relevant doc guide: https://www.rabbitmq.com/docs/ssl.
100100
##
101101
# listeners.ssl.1 = 5671
102-
#
102+
#
103103
# ssl_options.verify = verify_peer
104104
# ssl_options.fail_if_no_peer_cert = false
105105
# ssl_options.cacertfile = /path/to/cacert.pem
@@ -243,7 +243,7 @@
243243

244244
## Authentication
245245
## The built-in mechanisms are 'PLAIN',
246-
## 'AMQPLAIN', and 'EXTERNAL' Additional mechanisms can be added via
246+
## 'AMQPLAIN', and 'EXTERNAL'. Additional mechanisms can be added via
247247
## plugins.
248248
##
249249
## Relevant doc guide: https://www.rabbitmq.com/docs/authentication.
@@ -311,7 +311,16 @@
311311
# password_hashing_module = rabbit_password_hashing_md5
312312

313313
##
314-
## Default User / VHost
314+
## Credential validation.
315+
##
316+
## These settings can help enforce password requirements for all newly created users.
317+
##
318+
# credential_validator.validation_backend = rabbit_credential_validator_min_password_length
319+
# credential_validator.min_length = 30
320+
# credential_validator.regexp = ^[a-zA-Z0-9!@#$%^&*()]+$
321+
322+
##
323+
## Default User and Their Permissions
315324
##
316325

317326
## On first start RabbitMQ will create a vhost and a user. These
@@ -343,6 +352,39 @@
343352
# default_user_tags.management = true
344353
# default_user_tags.custom_tag = true
345354

355+
##
356+
## Default (pre-configured) Virtual Host Limits
357+
##
358+
## Apply limits automatically to newly created virtual host whose names match a pattern.
359+
## Relevant doc guide: https://www.rabbitmq.com/docs/vhosts#limits
360+
##
361+
# default_limits.vhosts.prod.pattern = ^prod-.*
362+
# default_limits.vhosts.prod.max_connections = 5000
363+
# default_limits.vhosts.prod.max_queues = 5000
364+
365+
##
366+
## Default operator Policies
367+
##
368+
## Apply operator policies automatically to queues whose names match a pattern.
369+
## Relevant doc guide: https://www.rabbitmq.com/docs/parameters#operator-policies
370+
##
371+
# default_policies.operator.limits.vhost_pattern = ^prod-.*
372+
# default_policies.operator.limits.queue_pattern = .*
373+
# default_policies.operator.limits.max_length = 10000
374+
# default_policies.operator.limits.message_ttl = 86400000
375+
376+
##
377+
## Default Users
378+
##
379+
## Pre-configure user permissions for newly created virtual hosts whose names match a pattern.
380+
## In the example below, "monitoring" is the user name.
381+
##
382+
# default_users.monitoring.vhost_pattern = .*
383+
# default_users.monitoring.tags = monitoring
384+
# default_users.monitoring.configure = ^$
385+
# default_users.monitoring.read = .*
386+
# default_users.monitoring.write = ^$
387+
346388
##
347389
## Additional network and protocol related configuration
348390
##
@@ -445,7 +487,7 @@
445487
# stream.listeners.ssl.default = 5553
446488

447489
## Number of Erlang processes that will accept RabbitMQ Stream Protocol client connections,
448-
## one setting for for the TCP and one for the TLS listeners.
490+
## one setting for the TCP and one for the TLS listeners.
449491
# stream.num_acceptors.tcp = 10
450492
# stream.num_acceptors.ssl = 1
451493

@@ -468,7 +510,7 @@
468510
## depend on the number of streams and their replicas (members).
469511
##
470512
# stream.replication.port_range.min = 5000
471-
# stream.replication.port_range.max 10000
513+
# stream.replication.port_range.max = 10000
472514

473515
## Advertised hostname and port for stream clients. Use when RabbitMQ
474516
## is behind a load balancer or in a container environment.
@@ -607,7 +649,7 @@
607649
## Make clustering happen *automatically* at startup. Only applied
608650
## to nodes that have just been reset or started for the first time.
609651
##
610-
## Relevant doc guide: https://www.rabbitmq.com/docs//cluster-formation
652+
## Relevant doc guide: https://www.rabbitmq.com/docs/cluster-formation
611653
##
612654

613655
# cluster_formation.peer_discovery_backend = rabbit_peer_discovery_classic_config
@@ -661,6 +703,10 @@
661703
# raft.wal_max_batch_size = 4096
662704
# raft.snapshot_chunk_size = 1000000
663705

706+
## Metadata store (Khepri) operation timeout in milliseconds.
707+
##
708+
# metadata_store.khepri.default_timeout = 30000
709+
664710
##
665711
## Misc and Advanced Options
666712
##
@@ -669,7 +715,7 @@
669715

670716
## To permit or deny a deprecated feature when it is in its
671717
## `permitted_by_default` or `denied_by_default` deprecation phase, the
672-
## default state can be overriden from the configuration.
718+
## default state can be overridden from the configuration.
673719
##
674720
## When a deprecated feature is permitted by default (first phase of the
675721
## deprecation period), it means the feature is available by default and can
@@ -737,21 +783,21 @@
737783
##
738784
# proxy_protocol = false
739785

740-
## Overriden product name and version.
786+
## Overridden product name and version.
741787
## They are set to "RabbitMQ" and the release version by default.
742788
# product.name = RabbitMQ
743789
# product.version = 1.2.3
744790

745791
## "Message of the day" file.
746792
## Its content is used to expand the logged and printed banners.
747-
## Default to /etc/rabbitmq/motd on Unix, %APPDATA%\RabbitMQ\motd.txt
793+
## Defaults to /etc/rabbitmq/motd on Unix, %APPDATA%\RabbitMQ\motd.txt
748794
## on Windows.
749795
# motd_file = /etc/rabbitmq/motd
750796

751797
## Consumer timeout
752-
## If a message delivered to a consumer has not been acknowledge before this timer
753-
## triggers the channel will be force closed by the broker. This ensure that
754-
## faultly consumers that never ack will not hold on to messages indefinitely.
798+
## If a message delivered to a consumer has not been acknowledged before this timer
799+
## triggers the channel will be force closed by the broker. This ensures that
800+
## faulty consumers that never ack will not hold on to messages indefinitely.
755801
##
756802
# consumer_timeout = 900000
757803

@@ -847,7 +893,7 @@
847893
## lengths) is retained.
848894
##
849895
## Relevant doc guide: https://www.rabbitmq.com/docs/management#configuration
850-
## Your can use 'minute', 'hour' and 'day' keys or integer key (in seconds)
896+
## You can use 'minute', 'hour' and 'day' keys or integer key (in seconds)
851897
# management.sample_retention_policies.global.minute = 5
852898
# management.sample_retention_policies.global.hour = 60
853899
# management.sample_retention_policies.global.day = 1200
@@ -913,7 +959,7 @@
913959

914960

915961
## Number of Erlang processes that will accept AMQP 0-9-1 and AMQP 1.0 client connections,
916-
## one setting for for the TCP and one for the TLS listeners.
962+
## one setting for the TCP and one for the TLS listeners.
917963
##
918964
# stomp.num_acceptors.tcp = 10
919965
# stomp.num_acceptors.ssl = 1
@@ -933,7 +979,7 @@
933979
# stomp.default_user = guest
934980
# stomp.default_pass = guest
935981

936-
## If a default user is configured, or you have configured use TLS client
982+
## If a default user is configured, or you have configured to use TLS client
937983
## certificate based authentication, you can choose to allow clients to
938984
## omit the CONNECT frame entirely. If set to true, the client is
939985
## automatically connected as the default user or user supplied in the
@@ -1038,7 +1084,7 @@
10381084
## Sets the durable queue type to be used for QoS 1 subscriptions.
10391085
##
10401086
## Supported types are:
1041-
##
1087+
##
10421088
## * classic
10431089
## * quorum
10441090
##
@@ -1178,11 +1224,11 @@
11781224
##
11791225
# management.oauth_client_id = rabbitmq-management
11801226

1181-
## Allows disable Basic HTTP Authentication. Opt-in to use JWT tokens exclusively.
1227+
## Allows disabling Basic HTTP Authentication. Opt-in to use JWT tokens exclusively.
11821228
##
11831229
# management.oauth_disable_basic_auth = true
11841230

1185-
## The scopes RabbitMq should claim during the management UI authorization flow.
1231+
## The scopes RabbitMQ should claim during the management UI authorization flow.
11861232
## Defaults to "openid profile"
11871233
##
11881234
# management.oauth_scopes = openid profile rabbitmq.tag:management
@@ -1266,7 +1312,7 @@
12661312

12671313
## Sets Server Name Indication for LDAP connections.
12681314
## If an LDAP server host is available via multiple domain names, set this value
1269-
## to the preferred domain name target LDAP server
1315+
## to the preferred domain name of the target LDAP server
12701316
# auth_ldap.ssl_options.sni = ldap.identity.eng.megacorp.local
12711317

12721318
## take wildcards into account when performing hostname verification
@@ -1318,7 +1364,7 @@
13181364
# auth_ldap.other_bind.user_dn = User
13191365
# auth_ldap.other_bind.password = Password
13201366

1321-
## If user_dn and password defined - other options is ignored.
1367+
## If user_dn and password are defined - other options are ignored.
13221368

13231369
##
13241370
## LDAP: Limitations

0 commit comments

Comments
 (0)