Server Operator Documentation
RabbitMQ ships in a state where it can be used straight away in simple cases such as development and QA environments - just start the server, enable the necessary plugins and it's ready to go.
This guide provides a table of contents of documentation oriented at RabbitMQ operators. For a complete documentation ToC that includes developer-oriented guides, see All Documentation Guides.
Installation and Provisioning:
- Packages and repositories
- Provisioning Tools (e.g. Chef cookbook, Puppet module, Docker image)
- Package Signatures
- Supported Erlang/OTP Versions
- Supported RabbitMQ Versions
- Changelog
Operating Systems and Platforms
- Debian and Ubuntu
- Red Hat Enterprise Linux, CentOS, Fedora
- Windows Installer, Windows-specific Issues
- Generic UNIX Binary Build
- MacOS via Homebrew
- Amazon EC2
- Solaris
Snapshots
Upgrading
CLI tools
- RabbitMQ CLI Tools: general installation and usage topics
- rabbitmqctl: primary RabbitMQ CLI tool
- rabbitmq-diagnostics: monitoring, health checking, observability tooling
- rabbitmq-plugins: plugin management
- rabbitmq-queues: operations on quorum queues
- rabbitmq-streams: operations on streams
- rabbitmq-upgrade: operations related to upgrades
- rabbitmqadmin (HTTP API-based zero dependency management tool)
- man pages
Configuration
- Configuration
- File and Directory Locations
- Logging
- Policies and Runtime Parameters
- Schema Definitions
- Per Virtual Host Limits
- Client Connection Heartbeats
- Inter-node Connection Heartbeats
- Runtime Tuning
- Queue and Message TTL
Authentication and authorisation:
- Access Control: main authentication and authorisation guide
- AMQP 0-9-1 Authentication Mechanisms
- Virtual Hosts
- Credentials and Passwords
- x509 (TLS) Certificate-based client authentication
- OAuth 2 Support
- OAuth 2 Examples for common identity providers
- LDAP
- Validated User ID
- Authentication Failure Notifications
Networking and TLS
- Client Connections
- Networking
- Inter-protocol Conversions
- 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
- Monitoring, metrics and health checks
- Troubleshooting guidance
- rabbitmqadmin, an HTTP API command line tool
- Client Connections
- AMQP 0-9-1 Channels
- Inter-protocol Conversions
- Internal Event Exchange
- Per Virtual Host Limits
- Per User Limits
- Message Tracing
- Capturing Traffic with Wireshark
Clustering
Replicated Queue Types, Streams, High Availability
- Quorum Queues: a modern highly available replicated queue type
- Streams: a messaging abstraction that allows for repeatable consumption
- RabbitMQ Stream plugin: the plugin and binary protocol behind RabbitMQ streams
Distributed RabbitMQ
- Replication and Distributed Feature Overview
- Reliability of distributed deployments, publishers and consumers
- Federation
- Shovel
Guidance
- Monitoring
- Production Checklist
- Backup and Restore
- Troubleshooting guidance
- Reliable Message Delivery
Resource Management
- Memory Usage Analysis
- Memory Management
- Resource Alarms
- Free Disk Space Alarms
- Runtime Tuning
- Flow Control
- Queue and Message TTL
- Queue Length Limits
Queue and Consumer Features
- Queues guide
- Classic Queues
- Consumers guide
- Queue and Message TTL
- Queue Length Limits
- Lazy Queues
- Dead Lettering
- Priority Queues
- Consumer Cancellation Notifications
- Consumer Prefetch
- Consumer Priorities
- Streams