|
6 | 6 | ## copying the entire (large!) file, create or generate a new rabbitmq.conf for the target system |
7 | 7 | ## and populate it with the necessary settings. |
8 | 8 | ## |
9 | | -## See https://rabbitmq.com/configure.html to learn about how to configure RabbitMQ, |
| 9 | +## See https://www.rabbitmq.com/docs/configure to learn about how to configure RabbitMQ, |
10 | 10 | ## the ini-style format used by rabbitmq.conf, how it is different from `advanced.config`, |
11 | 11 | ## how to verify effective configuration, and so on. |
12 | 12 | ## |
13 | | -## See https://rabbitmq.com/documentation.html for the rest of RabbitMQ documentation. |
| 13 | +## See https://www.rabbitmq.com/docs/documentation for the rest of RabbitMQ documentation. |
14 | 14 | ## |
15 | 15 | ## In case you have questions, please use RabbitMQ community Slack and the rabbitmq-users Google group |
16 | 16 | ## instead of GitHub issues. |
|
23 | 23 | ## Networking |
24 | 24 | ## ==================== |
25 | 25 | ## |
26 | | -## Related doc guide: https://rabbitmq.com/networking.html. |
| 26 | +## Related doc guide: https://www.rabbitmq.com/docs/networking. |
27 | 27 | ## |
28 | 28 | ## By default, RabbitMQ will listen on all interfaces, using |
29 | 29 | ## the standard (reserved) AMQP 0-9-1 and 1.0 port. |
|
84 | 84 | ## ============== |
85 | 85 | ## |
86 | 86 |
|
87 | | -## Related doc guide: https://rabbitmq.com/access-control.html. |
| 87 | +## Related doc guide: https://www.rabbitmq.com/docs/access-control. |
88 | 88 |
|
89 | 89 | ## The default "guest" user is only permitted to access the server |
90 | 90 | ## via a loopback interface (e.g. localhost). |
|
98 | 98 |
|
99 | 99 | ## TLS configuration. |
100 | 100 | ## |
101 | | -## Related doc guide: https://rabbitmq.com/ssl.html. |
| 101 | +## Related doc guide: https://www.rabbitmq.com/docs/ssl. |
102 | 102 | ## |
103 | 103 | # listeners.ssl.1 = 5671 |
104 | 104 | # |
|
192 | 192 | ## |
193 | 193 | ## Related doc guides: |
194 | 194 | ## |
195 | | -## * https://rabbitmq.com/plugins.html |
196 | | -## * https://rabbitmq.com/access-control.html |
| 195 | +## * https://www.rabbitmq.com/docs/plugins |
| 196 | +## * https://www.rabbitmq.com/docs/access-control |
197 | 197 | ## |
198 | 198 |
|
199 | 199 | # auth_backends.1 = rabbit_auth_backend_internal |
|
209 | 209 | ## |
210 | 210 | ## Relevant doc guides: |
211 | 211 | ## |
212 | | -## * https://rabbitmq.com/ldap.html |
213 | | -## * https://rabbitmq.com/access-control.html |
| 212 | +## * https://www.rabbitmq.com/docs/ldap |
| 213 | +## * https://www.rabbitmq.com/docs/access-control |
214 | 214 | ## |
215 | 215 | ## uses LDAP for both authentication and authorisation |
216 | 216 | # auth_backends.1 = rabbit_auth_backend_ldap |
|
228 | 228 | ## 'AMQPLAIN', and 'EXTERNAL' Additional mechanisms can be added via |
229 | 229 | ## plugins. |
230 | 230 | ## |
231 | | -## Related doc guide: https://rabbitmq.com/authentication.html. |
| 231 | +## Related doc guide: https://www.rabbitmq.com/docs/authentication. |
232 | 232 | ## |
233 | 233 | # auth_mechanisms.1 = PLAIN |
234 | 234 | # auth_mechanisms.2 = AMQPLAIN |
235 | 235 |
|
236 | 236 | ## The rabbitmq-auth-mechanism-ssl plugin makes it possible to |
237 | 237 | ## authenticate a user based on the client's x509 (TLS) certificate. |
238 | | -## Related doc guide: https://rabbitmq.com/authentication.html. |
| 238 | +## Related doc guide: https://www.rabbitmq.com/docs/authentication. |
239 | 239 | ## |
240 | 240 | ## To use auth-mechanism-ssl, the EXTERNAL mechanism should |
241 | 241 | ## be enabled: |
|
278 | 278 | ## |
279 | 279 | # load_definitions = /path/to/definitions/file.json |
280 | 280 |
|
281 | | - |
282 | | -## |
283 | | -## Cluster name |
284 | | -## ==================== |
285 | | -## |
286 | | -# cluster_name = dev3.eng.megacorp.local |
287 | | - |
288 | 281 | ## Password hashing implementation. Will only affect newly |
289 | 282 | ## created users. To recalculate hash for an existing user |
290 | 283 | ## it's necessary to update her password. |
|
306 | 299 |
|
307 | 300 | ## On first start RabbitMQ will create a vhost and a user. These |
308 | 301 | ## config items control what gets created. |
309 | | -## Relevant doc guide: https://rabbitmq.com/access-control.html |
| 302 | +## Relevant doc guide: https://www.rabbitmq.com/docs/access-control |
310 | 303 | ## |
311 | 304 | # default_vhost = / |
312 | 305 | # default_user = guest |
|
319 | 312 | ## Tags for default user |
320 | 313 | ## |
321 | 314 | ## For more details about tags, see the documentation for the |
322 | | -## Management Plugin at https://rabbitmq.com/management.html. |
| 315 | +## Management Plugin at https://www.rabbitmq.com/docs/management. |
323 | 316 | ## |
324 | 317 | # default_user_tags.administrator = true |
325 | 318 |
|
|
342 | 335 | ## |
343 | 336 | ## Related doc guides: |
344 | 337 | ## |
345 | | -## * https://rabbitmq.com/heartbeats.html |
346 | | -## * https://rabbitmq.com/networking.html |
| 338 | +## * https://www.rabbitmq.com/docs/heartbeats |
| 339 | +## * https://www.rabbitmq.com/docs/networking |
347 | 340 | ## |
348 | 341 | # heartbeat = 60 |
349 | 342 |
|
|
365 | 358 | ## |
366 | 359 | ## Related doc guides: |
367 | 360 | ## |
368 | | -## * https://rabbitmq.com/networking.html |
| 361 | +## * https://www.rabbitmq.com/docs/networking |
369 | 362 | ## * https://www.erlang.org/doc/man/inet.html#setopts-2 |
370 | 363 | ## |
371 | 364 |
|
|
384 | 377 | ## Resource Limits & Flow Control |
385 | 378 | ## ============================== |
386 | 379 | ## |
387 | | -## Related doc guide: https://rabbitmq.com/memory.html. |
| 380 | +## Related doc guide: https://www.rabbitmq.com/docs/memory. |
388 | 381 |
|
389 | 382 | ## Memory-based Flow Control threshold. |
390 | 383 | ## |
|
423 | 416 | ## |
424 | 417 | ## Another alternative is to configure queues to page all messages (both |
425 | 418 | ## persistent and transient) to disk as quickly |
426 | | -## as possible, see https://rabbitmq.com/lazy-queues.html. |
| 419 | +## as possible, see https://www.rabbitmq.com/docs/lazy-queues. |
427 | 420 | ## |
428 | 421 | # vm_memory_high_watermark_paging_ratio = 0.5 |
429 | 422 |
|
|
463 | 456 | ## Clustering |
464 | 457 | ## ===================== |
465 | 458 | ## |
| 459 | + |
| 460 | +## By default cluster name is set to the name of the first |
| 461 | +## node to have formed the cluster. It can be overridden |
| 462 | +## to make it easier for (human) operators to tell one cluster from another. |
| 463 | +# cluster_name = dev3.eng.megacorp.local |
| 464 | + |
| 465 | +## Selects the default strategy used to pick a node to place a new queue leader replica |
| 466 | +## on. Can be overridden by the `x-queue-leader-locator` optional queue argument |
| 467 | +## at declaration time. |
| 468 | +## |
| 469 | +## "balanced" (the default) is recommended for most environments. It works |
| 470 | +## like so: |
| 471 | +## |
| 472 | +## 1. When there are many queues in the cluster, the candidate node is picked randomly |
| 473 | +## 2. When there are few queues, uses their current replica count to pick the node |
| 474 | +## with the smallest number of replicas. |
| 475 | +## |
| 476 | +## Supported non-deprecated values are: "balanced", "client-local" |
| 477 | +# queue_leader_locator = balanced |
| 478 | + |
| 479 | + |
| 480 | +## Partition handling strategy. |
| 481 | +## Primarily affects deployments that use Mnesia and classic queues. |
| 482 | +## Khepri and quorum queues, streams will always use Raft's failure recovery |
| 483 | +## strategy. |
| 484 | +## |
466 | 485 | # cluster_partition_handling = ignore |
467 | 486 |
|
468 | 487 | ## Pauses all nodes on the minority side of a partition. The cluster |
|
479 | 498 | # cluster_partition_handling.pause_if_all_down.nodes.1 = rabbit@localhost |
480 | 499 | # cluster_partition_handling.pause_if_all_down.nodes.2 = hare@localhost |
481 | 500 |
|
482 | | -## Mirror sync batch size, in messages. Increasing this will speed |
483 | | -## up syncing but total batch size in bytes must not exceed 2 GiB. |
484 | | -## Available in RabbitMQ 3.6.0 or later. |
485 | | -## |
486 | | -# mirroring_sync_batch_size = 4096 |
487 | | - |
488 | 501 | ## Make clustering happen *automatically* at startup. Only applied |
489 | 502 | ## to nodes that have just been reset or started for the first time. |
490 | 503 | ## |
|
530 | 543 | # |
531 | 544 | # This value is no longer meant to be configured directly. |
532 | 545 | # |
533 | | -# See https://www.rabbitmq.com/management.html#fine-stats. |
| 546 | +# See https://www.rabbitmq.com/docs/management#fine-stats. |
534 | 547 |
|
535 | 548 | ## |
536 | | -## Ra Settings |
| 549 | +## Raft settings |
537 | 550 | ## ===================== |
538 | 551 | ## |
| 552 | +## These set the defaults that quorum queues, streams, Khepri, and other Raft-based features use. |
| 553 | +## |
539 | 554 | # raft.segment_max_entries = 65536 |
540 | 555 | # raft.wal_max_size_bytes = 1048576 |
541 | 556 | # raft.wal_max_batch_size = 4096 |
542 | 557 | # raft.snapshot_chunk_size = 1000000 |
543 | 558 |
|
544 | 559 | ## |
545 | | -## Misc/Advanced Options |
| 560 | +## Misc and Advanced Options |
546 | 561 | ## ===================== |
547 | 562 | ## |
548 | 563 | ## NB: Change these only if you understand what you are doing! |
|
570 | 585 | ## Timeout used when waiting for Mnesia tables in a cluster to |
571 | 586 | ## become available. |
572 | 587 | ## |
| 588 | +## Related doc guide: https://www.rabbitmq.com/docs/clustering#restarting |
573 | 589 | # mnesia_table_loading_retry_timeout = 30000 |
574 | 590 |
|
575 | 591 | ## Retries when waiting for Mnesia tables in the cluster startup. Note that |
576 | 592 | ## this setting is not applied to Mnesia upgrades or node deletions. |
577 | 593 | ## |
| 594 | +## Related doc guide: https://www.rabbitmq.com/docs/clustering#restarting |
578 | 595 | # mnesia_table_loading_retry_limit = 10 |
579 | 596 |
|
580 | 597 | ## Size in bytes below which to embed messages in the queue index. |
581 | | -## Related doc guide: https://rabbitmq.com/persistence-conf.html |
| 598 | +## Related doc guide: https://www.rabbitmq.com/docs/persistence-conf |
582 | 599 | ## |
583 | 600 | # queue_index_embed_msgs_below = 4096 |
584 | 601 |
|
|
594 | 611 | ## (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html). |
595 | 612 | ## |
596 | 613 | ## Before trying this option, please take a look at the memory |
597 | | -## breakdown (https://www.rabbitmq.com/memory-use.html). |
| 614 | +## breakdown (https://www.rabbitmq.com/docs/memory-use). |
598 | 615 | ## |
599 | 616 | # background_gc_enabled = false |
600 | 617 |
|
|
636 | 653 | ## ---------------------------------------------------------------------------- |
637 | 654 | ## Advanced Erlang Networking/Clustering Options. |
638 | 655 | ## |
639 | | -## Related doc guide: https://rabbitmq.com/clustering.html |
| 656 | +## Related doc guide: https://www.rabbitmq.com/docs/clustering |
640 | 657 | ## ---------------------------------------------------------------------------- |
641 | 658 |
|
642 | 659 | # ====================================== |
643 | 660 | # Kernel section |
644 | 661 | # ====================================== |
645 | 662 |
|
646 | 663 | ## Timeout used to detect peer unavailability, including CLI tools. |
647 | | -## Related doc guide: https://www.rabbitmq.com/nettick.html. |
| 664 | +## Related doc guide: https://www.rabbitmq.com/docs/nettick. |
648 | 665 | ## |
649 | 666 | # net_ticktime = 60 |
650 | 667 |
|
|
657 | 674 | ## ---------------------------------------------------------------------------- |
658 | 675 | ## RabbitMQ Management Plugin |
659 | 676 | ## |
660 | | -## Related doc guide: https://rabbitmq.com/management.html. |
| 677 | +## Related doc guide: https://www.rabbitmq.com/docs/management. |
661 | 678 | ## ---------------------------------------------------------------------------- |
662 | 679 |
|
663 | 680 | # ======================================= |
664 | 681 | # Management section |
665 | 682 | # ======================================= |
666 | 683 |
|
667 | 684 | ## Preload schema definitions from the following JSON file. |
668 | | -## Related doc guide: https://rabbitmq.com/management.html#load-definitions. |
| 685 | +## Related doc guide: https://www.rabbitmq.com/docs/management#load-definitions. |
669 | 686 | ## |
670 | 687 | # management.load_definitions = /path/to/exported/definitions.json |
671 | 688 |
|
|
674 | 691 | # management.http_log_dir = /path/to/access.log |
675 | 692 |
|
676 | 693 | ## HTTP listener and embedded Web server settings. |
677 | | -# ## See https://rabbitmq.com/management.html for details. |
| 694 | +# ## See https://www.rabbitmq.com/docs/management for details. |
678 | 695 | # |
679 | 696 | # management.tcp.port = 15672 |
680 | 697 | # management.tcp.ip = 0.0.0.0 |
|
687 | 704 | # management.tcp.compress = true |
688 | 705 |
|
689 | 706 | ## HTTPS listener settings. |
690 | | -## See https://rabbitmq.com/management.html and https://rabbitmq.com/ssl.html for details. |
| 707 | +## See https://www.rabbitmq.com/docs/management and https://www.rabbitmq.com/docs/ssl for details. |
691 | 708 | ## |
692 | 709 | # management.ssl.port = 15671 |
693 | 710 | # management.ssl.cacertfile = /path/to/ca_certificate.pem |
|
721 | 738 | # management.path_prefix = /a-prefix |
722 | 739 |
|
723 | 740 | ## One of 'basic', 'detailed' or 'none'. See |
724 | | -## https://rabbitmq.com/management.html#fine-stats for more details. |
| 741 | +## https://www.rabbitmq.com/docs/management#fine-stats for more details. |
725 | 742 | # management.rates_mode = basic |
726 | 743 |
|
727 | 744 | ## Configure how long aggregated data (such as message rates and queue |
728 | 745 | ## lengths) is retained. Please read the plugin's documentation in |
729 | | -## https://rabbitmq.com/management.html#configuration for more |
| 746 | +## https://www.rabbitmq.com/docs/management#configuration for more |
730 | 747 | ## details. |
731 | 748 | ## Your can use 'minute', 'hour' and 'day' keys or integer key (in seconds) |
732 | 749 | # management.sample_retention_policies.global.minute = 5 |
|
741 | 758 | ## ---------------------------------------------------------------------------- |
742 | 759 | ## RabbitMQ Shovel Plugin |
743 | 760 | ## |
744 | | -## Related doc guide: https://rabbitmq.com/shovel.html |
| 761 | +## Related doc guide: https://www.rabbitmq.com/docs/shovel |
745 | 762 | ## ---------------------------------------------------------------------------- |
746 | 763 |
|
747 | 764 | ## See advanced.config.example for a Shovel plugin example |
|
750 | 767 | ## ---------------------------------------------------------------------------- |
751 | 768 | ## RabbitMQ STOMP Plugin |
752 | 769 | ## |
753 | | -## Related doc guide: https://rabbitmq.com/stomp.html |
| 770 | +## Related doc guide: https://www.rabbitmq.com/docs/stomp |
754 | 771 | ## ---------------------------------------------------------------------------- |
755 | 772 |
|
756 | 773 | # ======================================= |
757 | 774 | # STOMP section |
758 | 775 | # ======================================= |
759 | 776 |
|
760 | | -## See https://rabbitmq.com/stomp.html for details. |
| 777 | +## See https://www.rabbitmq.com/docs/stomp for details. |
761 | 778 |
|
762 | 779 | ## TCP listeners. |
763 | 780 | ## |
|
781 | 798 | # stomp.proxy_protocol = false |
782 | 799 |
|
783 | 800 | ## TLS listeners |
784 | | -## See https://rabbitmq.com/stomp.html and https://rabbitmq.com/ssl.html for details. |
| 801 | +№№ |
| 802 | +## See https://www.rabbitmq.com/docs/stomp and https://www.rabbitmq.com/docs/ssl for details. |
785 | 803 | # stomp.listeners.ssl.default = 61614 |
786 | 804 | # |
787 | 805 | # ssl_options.cacertfile = path/to/cacert.pem |
|
860 | 878 | # mqtt.tcp_listen_options.send_timeout = 120000 |
861 | 879 |
|
862 | 880 | ## TLS listener settings |
863 | | -## ## See https://rabbitmq.com/mqtt.html and https://rabbitmq.com/ssl.html for details. |
| 881 | +## ## See https://www.rabbitmq.com/docs/mqtt and https://www.rabbitmq.com/docs/ssl for details. |
864 | 882 | # |
865 | 883 | # mqtt.listeners.ssl.default = 8883 |
866 | 884 | # |
|
956 | 974 |
|
957 | 975 | ## Logging settings. |
958 | 976 | ## |
959 | | -## See https://rabbitmq.com/logging.html for details. |
| 977 | +## See https://www.rabbitmq.com/docs/logging for details. |
960 | 978 | ## |
961 | 979 |
|
962 | 980 | ## Log directory, taken from the RABBITMQ_LOG_BASE env variable by default. |
|
1000 | 1018 | ## ---------------------------------------------------------------------------- |
1001 | 1019 | ## RabbitMQ LDAP Plugin |
1002 | 1020 | ## |
1003 | | -## Related doc guide: https://rabbitmq.com/ldap.html. |
| 1021 | +## Related doc guide: https://www.rabbitmq.com/docs/ldap. |
1004 | 1022 | ## |
1005 | 1023 | ## ---------------------------------------------------------------------------- |
1006 | 1024 |
|
|
1134 | 1152 | ## The LDAP plugin can perform a variety of queries against your |
1135 | 1153 | ## LDAP server to determine questions of authorisation. |
1136 | 1154 | ## |
1137 | | -## Related doc guide: https://rabbitmq.com/ldap.html#authorisation. |
| 1155 | +## Related doc guide: https://www.rabbitmq.com/docs/ldap#authorisation. |
1138 | 1156 |
|
1139 | 1157 | ## Following configuration should be defined in advanced.config file |
1140 | 1158 | ## DO NOT UNCOMMENT THESE LINES! |
|
0 commit comments