Documentation: Table of Contents

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, the protocol, RabbitMQ 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
  • Upgrade
  • Blue-green deployment-based upgrade
  • Package Signatures
  • Supported Erlang/OTP Versions
  • Change log
  • 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
  • Configuration
  • File and Directory Locations
  • Logging
  • Policies and Runtime Parameters
  • Per Virtual Host Limits
  • Client Connection Heartbeats
  • Inter-node Connection Heartbeats
  • Queue and Message TTL
• Authentication and Authorization:
  • Authentication and Authorization Backends
  • Authentication Mechanisms
  • Virtual Hosts
  • Credentials and Passwords
  • LDAP
  • x509 Certificate-based Authentication
  • Validated User ID
  • Authentication Failure Notifications
• Networking and TLS:
  • Networking
  • Troubleshooting Network Connectivity
  • Using TLS for Client Connections
  • Using TLS for Inter-node Traffic
  • Troubleshooting TLS
• Monitoring, Audit, Application Troubleshooting:
  • Management UI and HTTP API
  • rabbitmqadmin, an HTTP API command line tool
  • Monitoring
  • Internal Event Exchange
  • Per Virtual Host Limits
  • Configuring HTTP-based (Web) plugins
  • 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).
• Guidelines:
  • Monitoring
  • Production Checklist
  • Backup and Restore
  • Reliable Message Delivery
• Message Store and Resource Management:
  • Memory Usage
  • Memory Management
  • Resource Alarms
  • Free Disk Space Alarms
  • Flow Control
  • Message Store Configuration
  • Queue and Message TTL
  • Queue Length Limits
  • Lazy Queues
• Queue, Routing, and Consumer Features:
  • Queue Properties and Feature Overview
  • Queue and Message TTL
  • Queue Length Limits
  • Lazy Queues
  • Exchange-to-Exchange Bindings
  • Dead Lettering
  • Sender-Selected Distribution
  • Priority Queues
  • Consumer Cancellation Notifications
  • Consumer Prefetch
  • Consumer Priorities
  • Alternate Exchanges
• STOMP, MQTT, WebSockets
  • STOMP
  • MQTT
  • STOMP over WebSockets
  • MQTT over 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:

• Java client
• .NET client
• Ruby client
• JMS library
• Erlang client
• RabbitMQ extensions to AMQP 0-9-1

Client-driven Features:

• 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

References:
• Java
• .NET
• Erlang
• AMQP 0-9-1 URI Specification
• URI Query Parameters

See Clients and Developer Tools for community client libraries.

Plugins

Popular plugins:

• Management
• STOMP
• MQTT
• STOMP over WebSockets
• MQTT over WebSockets
• Federation
• Shovel
• Internal Event Exchange

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
• Other protocol documentation.