Documentation: Table of Contents
This page summarises the available RabbitMQ documentation for the current release, 3.8.3. Also available are:
Installation(安装)
See the Downloads and Installation page for information on the most recent release and how to install it.
Get Started
See the Get Started page for our tutorials that offer a gentle introduction to messaging,
one of the protocols RabbitMQ supports, key messaging features, and some common usage scenarios. AMQP 0-9-1 Overview provides a brief overview for the original RabbitMQ protocol.
Server and Key Plugins
RabbitMQ server documentation is organised(组织) in a number of guides:
- Installation and Provisioning:
- All Packages and Repositories
- Provisioning Tools (e.g. Chef cookbook, Puppet module, Docker image)
- Debian and Ubuntu
- RHEL, CentOS, Fedora
- Windows Installer, Windows-specific Issues
- Generic UNIX Binary Build
- MacOS via Standalone Binary Build
- MacOS via Homebrew
- Amazon EC2
- Solaris
- Schema Definitions
- Upgrade
- Blue-green deployment-based upgrade
- Package Signatures
- Supported Erlang/OTP Versions
- Supported RabbitMQ Versions
- Changelog
- Snapshot (Nightly) Builds
- CLI tools
- CLI Tools Overview
- rabbitmqctl (rabbitmqctl.bat on Windows)
- rabbitmq-plugins (rabbitmq-plugins.bat on Windows)
- rabbitmqadmin (requires management plugin)
- man pages
- Configuration
- Authentication and authorisation:
- Networking and TLS:
- Monitoring, Audit, Application Troubleshooting:
- Management UI and HTTP API
- Monitoring, metrics and health checks
- Troubleshooting guidance
- rabbitmqadmin, an HTTP API command line tool
- Client Connections
- AMQP 0-9-1 Channels
- Internal Event Exchange
- Per Virtual Host Limits
- Message Tracing
- Capturing Traffic with Wireshark
- Distributed RabbitMQ:
- Mirroring, Shovel, Federation Overview
- Clustering
- Queue Mirroring
- Reliable Message Delivery
- Active-passive (standby) highly available configuration with Pacemaker (legacy).
- Guidance:
- Message Store and Resource Management:
- Queue and consumer features:
- Publisher features:
- STOMP, MQTT, WebSockets
- man Pages
Client Libraries and Features
RabbitMQ clients documentation is organised in a number of guides and API references. A separate set of tutorials for many popular programming languages are also available, as is an AMQP 0-9-1 Overview.
Client Documentation guides:
Client-driven Features:
- Client Connections
- Consumers
- Publishers
- Channels
- Publisher Confirms and Consumer Acknowledgements
- Queue and Message TTL
- Queue Length Limits
- Lazy Queues
- Exchange-to-Exchange Bindings
- Sender-Selected Distribution
- Priority Queues
- Consumer Cancellation Notifications
- Consumer Prefetch
- Consumer Priorities
- Dead Lettering
- Alternate Exchanges
- Message Tracing
- Capturing Traffic with Wireshark
See Clients and Developer Tools for community client libraries.
Plugins
Popular plugins:
See Community Plugins, RabbitMQ GitHub repositories the Plugins Guide for more information about plugins.
Development
- RabbitMQ GitHub repositories
- Contributor Code of Conduct
- How to build RabbitMQ from source, or from GitHub.
Protocols
- AMQP 0-9-1: Extensions | Quick Reference
- STOMP
- MQTT
- STOMP over WebSockets
- MQTT over WebSockets
- AMQP 0-9-1 implementation details.
- AMQP 0-9-1 Errata document.
Getting Help and Providing Feedback
If you have questions about the contents of this guide or any other topic related to RabbitMQ, don't hesitate to ask them on the RabbitMQ mailing list.
Help Us Improve the Docs <3
If you'd like to contribute an improvement to the site, its source is available on GitHub. Simply fork the repository and submit a pull request. Thank you!