Install rabbitmq on linux

Generic Binary Build («Generic UNIX Build»)

Overview

RabbitMQ releases include a binary package for Linux, MacOS, and *BSD systems. It is minimalistic and not opinionated in how it is installed, configured and managed. This package is recommended in environments where more opinionated installation options (the Debian or RPM packages, Homebrew, BSD ports) cannot be used. It is also the most convenient option for running multiple versions on the same machine in development environments, e.g. preview release testing. There’s a separate binary package for Windows.

Downloads

Description	Download	Signature
Generic UNIX binary build (tar.xz, from GitHub, recommended)	rabbitmq-server-generic-unix-3.9.7.tar.xz	Signature

Installation

Make Sure Erlang/OTP is Installed

This package requires a supported version of Erlang to be installed in order to run.

Install the Server

Download a rabbitmq-server-generic-unix-3.9.7.tar.xz archive and extract it.

Contained in the tarball is a directory named rabbitmq_server-3.9.7 . This directory is the node base directory. It should be moved to a suitable application directory on the system, such as /usr/local . The sbin directory in that directory contains server and CLI tool scripts. It is a good candidate for including into PATH .

Operations

Running and Managing the Node

Unlike some other installation methods, namely the Debian and RPM packages, RabbitMQ generic UNIX binary build does not require sudo . It can be uncompressed into any location and started and managed using the scripts and CLI tools under sbin . Default data directory location will be under ./var , that is, in the installation directory.

Starting the Server

To start the server, run the sbin/rabbitmq-server script. This displays a short banner message, concluding with the message «completed with [n] plugins.», indicating that the RabbitMQ broker has been started successfully. To start the server in «detached» mode, use rabbitmq-server -detached . This will run the node process in the background.

Stopping the Server

To stop a running node, use sbin/rabbitmqctl shutdown . The command will wait for the node process to stop. If the target node is not running, it will exit with an error.

Configuring the Server

RabbitMQ configuration file located at $RABBITMQ_HOME/etc/rabbitmq/rabbitmq.conf is the primary way of configuring the node.

It is possible to use environment variables to control certain settings. The recommended way of doing that is using the $RABBITMQ_HOME/etc/rabbitmq/rabbitmq-env.conf file.

Neither of these files exist after installation, so they must be created first.

See RabbitMQ configuration guide to learn more.

File Locations

The generic binary build is designed to run without granted permissions to directories outside of its base one. The directories and files used by default are all held under the installation directory rabbitmq_server-3.9.7 which is in the $RABBITMQ_HOME variable in the scripts.

The node can be instructed to use more conventional system directories for configuration, node data directory, log files, plugins and so on. In order to make the node use operating system defaults, locate the following line

in the sbin/rabbitmq-defaults script and change this line to:

but do not modify any other line in this script.

Important: after this modification the default directory locations may point to non-existent directories or directories that the effective node user won’t have permissions for.

In particular RABBITMQ_MNESIA_BASE and RABBITMQ_LOG_BASE may need to be created (the server will attempt to create them at startup), and the enabled plugins file ( RABBITMQ_ENABLED_PLUGINS_FILE ) will need to be writable by rabbitmq-plugins.

The configuration files will be looked for in /etc/rabbitmq/ .

Port Access

RabbitMQ nodes bind to ports (open server TCP sockets) in order to accept client and CLI tool connections. Other processes and tools such as SELinux may prevent RabbitMQ from binding to a port. When that happens, the node will fail to start.

CLI tools, client libraries and RabbitMQ nodes also open connections (client TCP sockets). Firewalls can prevent nodes and CLI tools from communicating with each other. Make sure the following ports are accessible:

• 4369: epmd, a peer discovery service used by RabbitMQ nodes and CLI tools
• 5672, 5671: used by AMQP 0-9-1 and 1.0 clients without and with TLS
• 25672: used for inter-node and CLI tools communication (Erlang distribution server port) and is allocated from a dynamic range (limited to a single port by default, computed as AMQP port + 20000). Unless external connections on these ports are really necessary (e.g. the cluster uses federation or CLI tools are used on machines outside the subnet), these ports should not be publicly exposed. See networking guide for details.
• 35672-35682: used by CLI tools (Erlang distribution client ports) for communication with nodes and is allocated from a dynamic range (computed as server distribution port + 10000 through server distribution port + 10010). See networking guide for details.
• 15672: HTTP API clients, management UI and rabbitmqadmin (only if the management plugin is enabled)
• 61613, 61614: STOMP clients without and with TLS (only if the STOMP plugin is enabled)
• 1883, 8883: MQTT clients without and with TLS, if the MQTT plugin is enabled
• 15674: STOMP-over-WebSockets clients (only if the Web STOMP plugin is enabled)
• 15675: MQTT-over-WebSockets clients (only if the Web MQTT plugin is enabled)
• 15692: Prometheus metrics (only if the Prometheus plugin is enabled)

Default User Access

The broker creates a user guest with password guest . Unconfigured clients will in general use these credentials. By default, these credentials can only be used when connecting to the broker as localhost so you will need to take action before connecting from any other machine.

See the documentation on access control for information on how to create more users and delete the guest user.

Managing the Node

To stop the server or check its status, etc., you can invoke sbin/rabbitmqctl (as the user running rabbitmq-server ). All rabbitmqctl commands will report the node absence if no broker is running.

• Invoke rabbitmqctl stop or rabbitmqctl shutdown to stop the server
• Invoke rabbitmqctl status to check whether it is running

See CLI tools guide to learn more.

Controlling System Limits on Linux

RabbitMQ installations running production workloads may need system limits and kernel parameters tuning in order to handle a decent number of concurrent connections and queues. The main setting that needs adjustment is the max number of open files, also known as ulimit -n . The default value on many operating systems is too low for a messaging broker ( 1024 on several Linux distributions). We recommend allowing for at least 65536 file descriptors for user rabbitmq in production environments. 4096 should be sufficient for many development workloads.

There are two limits in play: the maximum number of open files the OS kernel allows ( fs.file-max on Linux, kern.maxfilesperproc on OS X and FreeBSD) and the per-user limit ( ulimit -n ). The former must be higher than the latter. For more information about controlling the system-wide limit, please refer to the excellent Riak guide on open file limit tuning.

Verifying the Limit

RabbitMQ management UI displays the number of file descriptors available for it to use on the Overview tab.

includes the same value. The following command

can be used to display effective limits for the current user. There may be more convenient OS-specific ways of doing that for a running process, such as the /proc filesystem on Linux.

Configuration Management Tools

Configuration management tools (e.g. Chef, Puppet, BOSH) provide assistance with system limit tuning. Our developer tools guide lists relevant modules and projects.

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!

Источник

Downloading and Installing RabbitMQ

The latest release of RabbitMQ is 3.9.7. See change log for release notes. See RabbitMQ support timeline to find out what release series are supported.

Experimenting with RabbitMQ on your workstation? Try the community Docker image:

Open Source RabbitMQ Server

Installation Guides

• Linux, BSD, UNIX: Debian, Ubuntu | RHEL, CentOS, Fedora | Generic binary build | Solaris
• Windows: Chocolatey or Installer (recommended) | Binary build
• MacOS: Homebrew | Generic binary build
• Erlang/OTP for RabbitMQ

Preview Releases (Betas, Release Candidates)

You can contribute to RabbitMQ by helping the community test preview releases.

Preview releases are distributed via GitHub and marked as pre-release.

VMware Tanzu™ RabbitMQ® (Commercial Edition)

Kubernetes

RabbitMQ Cluster Kubernetes Operator

RabbitMQ Topology Kubernetes Operator

Other guides related to Kubernetes:

Docker

Cloud

• Tanzu™ RabbitMQ®
• RabbitMQ Cluster Kubernetes Operator by VMware (developed on GitHub)
• Tanzu™ RabbitMQ® on Kubernetes
• CloudAMQP: RabbitMQ-as-a-Service available in multiple clouds
• Amazon EC2

Downloads on GitHub

Debian (Apt) and RPM (Yum) Repositories

Provisioning Tools (Chef, Puppet, etc)

Release Signing Key

• Release Signing Key 0x6B73A36E6026DFCA (on GitHub)
• How to Verify Release Artifact Signatures
• Release Signing Key (alternative download location on rabbitmq.com)

Client Libraries

Java Client

• On Maven Central: RabbitMQ Java client
• Quick download: Maven.org | Source
• API guide
• API reference (JavaDoc)
• License and other information
• Older versions

JMS Client

.NET/C# Client

Erlang Client

Clients for Other Languages

The RabbitMQ community has created a large number of clients and developer tools covering a variety of platforms and languages.

Community Plugins

For your convenience, we offer binary downloads of various plugins developed by the community.

Snapshot (Alpha) Builds

Snapshot releases of the RabbitMQ broker available to users who wish to experiment with the latest and greatest features and bug fixes. For more details, head over to the snapshots page.

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!

Источник

Installing on RPM-based Linux (RedHat Enterprise Linux, CentOS, Fedora, openSUSE)

Overview

This guide covers RabbitMQ installation on RPM-based Linux (RedHat Enterprise Linux, CentOS, Fedora, openSUSE).

RabbitMQ is included in standard Fedora and RHEL repositories. However, the versions included are usually outdated and out of support.

There are two ways to install the most recent version of RabbitMQ on an RPM distribution:

• Installing the package using Yum repositories (this option is highly recommended) on Cloudsmith.io or PackageCloud
• Downloading the package and installing it with rpm . This option will require manual installation of all package dependencies.

The following guide focuses on RabbitMQ installation on RPM-based distributions such as Fedora, RHEL and CentOS. It covers a number of topics:

Overview

The package is distributed via Yum repositories on PackageCloud.

rabbitmq-server is included in Fedora. However, the versions included often lag behind RabbitMQ releases. It is recommended that you use Yum repositories from PackageCloud.

Check the Fedora package details for which version of the server is available for which versions of the distribution.

Supported Distributions

RabbitMQ is supported on several major RPM-based distributions that are still actively maintained by their primary vendor or developer group.

Note that modern versions of Erlang can have incompatibilities with older distributions (e.g. older than three to four years) or ship without much or any testing on older distributions or OS kernel versions.

Older distributions can also lack a recent enough version of OpenSSL. Erlang 24 cannot be used on distributions that do not provide OpenSSL 1.1 as a system library. CentOS 7 and Fedora releases older than 26 are examples of such distributions.

Currently the list of supported RPM-based distributions includes

• CentOS Linux 8.x and CentOS Stream 8.x
• RedHat Enterprise Linux 8.x
• Fedora 32 through 34 (use the CentOS 8.x package)

The packages may work on other RPM-based distributions if dependencies are satisfied but their testing and support is done on a best effort basis.

User Privilege Requirements

RabbitMQ RPM package will require sudo privileges to install and manage. In environments where sudo isn’t available, consider using the generic binary build.

Install Erlang

Before installing RabbitMQ, you must install a supported version of Erlang/OTP. Standard Red Hat, Fedora, CentOS repositories provide Erlang versions that are typically out of date and cannot be used to run latest RabbitMQ releases.

There are three alternative sources for modern Erlang on RPM-based distributions:

• Team RabbitMQ produces a package stripped down to only provide those components needed to run RabbitMQ. This is the recommended option.
• openSUSE produces Erlang packages for both openSUSE and SLES
• Erlang Solutions produces packages that are usually reasonably up to date and involve installation of a potentially excessive list of dependencies

Zero-dependency Erlang from RabbitMQ

As the name suggests, the package strips off some Erlang modules and dependencies that are not essential for running RabbitMQ.

Erlang packages from openSUSE

openSUSE package repositories provide Erlang so it can be installed using Zypper:

Erlang versions available in the standard repositories will in practice be behind the most recent version. To use the last version with the newest features, add the openSUSE Factory repositories for Erlang:

Package Dependencies

When installing with Yum, all dependencies other than Erlang/OTP should be resolved and installed automatically as long as compatible versions are available. When that’s not the case, dependency packages must be installed manually.

However, when installing a local RPM file via yum dependencies must be installed manually. The dependencies are:

Install Using PackageCloud Yum Repository

A Yum repository with RabbitMQ packages is available from PackageCloud. Package Cloud also can be used to install a recent Erlang version via yum.

A quick way to set up the repository is to use a Package Cloud-provided script. It is not a requirement and should be carefully considered since it pipes a generated script from the public Internet to a privileged shell.

The rest of this section guide will focus on a more traditional way that explicitly installs a Yum repository file.

Yum will verify signatures of any packages it installs, therefore the first step in the process is to import the signing key

Add Yum Repositories for RabbitMQ and Modern Erlang

In order to use the Yum repository, a .repo file (e.g. rabbitmq.repo ) has to be added under the /etc/yum.repos.d/ directory. The contents of the file will vary slightly between distributions (e.g. CentOS 8 and 7 vs. OpenSUSE).

Red Hat 8, CentOS 8, Modern Fedora Releases

The following example sets up a repository that will install RabbitMQ and its Erlang dependency from PackageCloud, and targets CentOS 8. The same repository definition can be used by recent Fedora releases.

OpenSUSE

The following example targets OpenSUSE and only installs the RabbitMQ package repository. Erlang is assumed to be provisioned from the devel:languages:erlang:Factory repository.

Install Packages with Yum

CentOS 8, RHEL 8, Modern Fedora

Update Yum package metadata:

Next install dependencies from the standard repositories:

Finally, install modern Erlang and RabbitMQ:

Install Packages with Zypper

First, update Zypper package metadata:

Then install the packages:

Install Using Cloudsmith Yum Repository

A Yum repository with RabbitMQ packages is available from Cloudsmith. Cloudsmith also can be used to install a recent Erlang version via yum.

A quick way to set up the repository is to use a Cloudsmith-provided script. It is not a requirement and should be carefully considered since it pipes a generated script from the public Internet to a privileged shell.

The rest of this section will focus on a more traditional way that explicitly installs a Yum repository file.

Yum will verify signatures of any packages it installs, therefore the first step in the process is to import the signing key

Add Yum Repositories for RabbitMQ and Modern Erlang

In order to use the Yum repository, a .repo file (e.g. rabbitmq.repo ) has to be added under the /etc/yum.repos.d/ directory. The contents of the file will vary slightly between distributions (e.g. CentOS 8 and 7 vs. OpenSUSE).

Red Hat 8, CentOS 8, Modern Fedora Releases

The following example sets up a repository that will install RabbitMQ and its Erlang dependency from Cloudsmith, and targets CentOS 8. The same repository definition can be used by recent Fedora releases.

OpenSUSE

The following example targets OpenSUSE and only installs the RabbitMQ package repository. Erlang is assumed to be provisioned from the devel:languages:erlang:Factory repository.

Install Packages with Yum

CentOS 8, RHEL 8, modern Fedora

Update Yum package metadata:

Next install dependencies from the standard repositories:

Finally, install modern Erlang and RabbitMQ:

Install Packages with Zypper

First, update Zypper package metadata:

Then install the packages:

Package Version Locking in Yum

yum version locking plugin can be used to prevent unexpected package upgrades. Using it carries the risk of leaving the system behind in terms of updates, including important bug fixes and security patches.

With rpm and Downloaded RPM

After downloading the server package, issue the following command as ‘root’:

Download the Server

In some cases it may be easier to download the package and install it manually. The package can be downloaded from GitHub.

Description	Download	Signature
RPM for RHEL Linux 8.x, CentOS 8.x, Fedora 31+ (supports systemd)	rabbitmq-server-3.9.7-1.el8.noarch.rpm	Signature
RPM for openSUSE Linux	rabbitmq-server-3.9.7-1.suse.noarch.rpm	Signature

Run RabbitMQ Server

Start the Server

The server is not started as a daemon by default when the RabbitMQ server package is installed. To start the daemon by default when the system boots, as an administrator run

As an administrator, start and stop the server as usual, e.g. using service :

If the service tool is not installed on the system, it can be installed using yum :

Configuring RabbitMQ

On most systems, a node should be able to start and run with all defaults. Please refer to the Configuration guide to learn more and Production Checklist for guidelines beyond development environments.

Note: the node is set up to run as system user rabbitmq . If location of the node database or the logs is changed, the files and directories must be owned by this user.

RabbitMQ nodes bind to ports (open server TCP sockets) in order to accept client and CLI tool connections. Other processes and tools such as SELinux may prevent RabbitMQ from binding to a port. When that happens, the node will fail to start.

CLI tools, client libraries and RabbitMQ nodes also open connections (client TCP sockets). Firewalls can prevent nodes and CLI tools from communicating with each other. Make sure the following ports are accessible:

• 4369: epmd, a peer discovery service used by RabbitMQ nodes and CLI tools
• 5672, 5671: used by AMQP 0-9-1 and 1.0 clients without and with TLS
• 25672: used for inter-node and CLI tools communication (Erlang distribution server port) and is allocated from a dynamic range (limited to a single port by default, computed as AMQP port + 20000). Unless external connections on these ports are really necessary (e.g. the cluster uses federation or CLI tools are used on machines outside the subnet), these ports should not be publicly exposed. See networking guide for details.
• 35672-35682: used by CLI tools (Erlang distribution client ports) for communication with nodes and is allocated from a dynamic range (computed as server distribution port + 10000 through server distribution port + 10010). See networking guide for details.
• 15672: HTTP API clients, management UI and rabbitmqadmin (only if the management plugin is enabled)
• 61613, 61614: STOMP clients without and with TLS (only if the STOMP plugin is enabled)
• 1883, 8883: MQTT clients without and with TLS, if the MQTT plugin is enabled
• 15674: STOMP-over-WebSockets clients (only if the Web STOMP plugin is enabled)
• 15675: MQTT-over-WebSockets clients (only if the Web MQTT plugin is enabled)
• 15692: Prometheus metrics (only if the Prometheus plugin is enabled)

Default User Access

The broker creates a user guest with password guest . Unconfigured clients will in general use these credentials. By default, these credentials can only be used when connecting to the broker as localhost so you will need to take action before connecting from any other machine.

See the documentation on access control for information on how to create more users and delete the guest user.

Controlling System Limits on Linux

RabbitMQ installations running production workloads may need system limits and kernel parameters tuning in order to handle a decent number of concurrent connections and queues. The main setting that needs adjustment is the max number of open files, also known as ulimit -n . The default value on many operating systems is too low for a messaging broker ( 1024 on several Linux distributions). We recommend allowing for at least 65536 file descriptors for user rabbitmq in production environments. 4096 should be sufficient for many development workloads.

There are two limits in play: the maximum number of open files the OS kernel allows ( fs.file-max ) and the per-user limit ( ulimit -n ). The former must be higher than the latter.

With systemd (Recent Linux Distributions)

On distributions that use systemd, the OS limits are controlled via a configuration file at /etc/systemd/system/rabbitmq-server.service.d/limits.conf . For example, to set the max open file handle limit ( nofile ) to 64000 :

See systemd documentation to learn about the supported limits and other directives.

With Docker

To configure kernel limits for Docker contains, use the «default-ulimits» key in Docker daemon configuration file. The file has to be installed on Docker hosts at /etc/docker/daemon.json :

Without systemd (Older Linux Distributions)

The most straightforward way to adjust the per-user limit for RabbitMQ on distributions that do not use systemd is to edit the /etc/default/rabbitmq-server (provided by the RabbitMQ Debian package) or rabbitmq-env.conf to invoke ulimit before the service is started.

This soft limit cannot go higher than the hard limit (which defaults to 4096 in many distributions). The hard limit can be increased via /etc/security/limits.conf . This also requires enabling the pam_limits.so module and re-login or reboot. Note that limits cannot be changed for running OS processes.

For more information about controlling fs.file-max with sysctl , please refer to the excellent Riak guide on open file limit tuning.

Verifying the Limit

RabbitMQ management UI displays the number of file descriptors available for it to use on the Overview tab.

includes the same value.

The following command

can be used to display effective limits of a running process. $RABBITMQ_BEAM_PROCESS_PID is the OS PID of the Erlang VM running RabbitMQ, as returned by rabbitmqctl status .

Configuration Management Tools

Configuration management tools (e.g. Chef, Puppet, BOSH) provide assistance with system limit tuning. Our developer tools guide lists relevant modules and projects.

Managing the Service

To start and stop the server, use the service tool. The service name is rabbitmq-server :

service rabbitmq-server status will report service status as observed by systemd (or similar service manager):

It will produce output similar to this:

rabbitmqctl , rabbitmq-diagnostics , and other CLI tools will be available in PATH and can be invoked by a sudo -enabled user:

All rabbitmqctl commands will report an error if no node is running. See the CLI tools and Monitoring guides to learn more.

Log Files and Management

Server logs can be found under the configurable directory, which usually defaults to /var/log/rabbitmq when RabbitMQ is installed via a Linux package manager.

RABBITMQ_LOG_BASE can be used to override log directory location.

Assuming a systemd -based distribution, system service logs can be inspected using

which requires superuser privileges. Its output can be filtered to narrow it down to RabbitMQ-specific entries:

The output will look similar to this:

Log Rotation

The broker always appends to the log files, so a complete log history is retained.

logrotate is the recommended way of log file rotation and compression. By default, the package will set up logrotate to run weekly on files located in default /var/log/rabbitmq directory. Rotation configuration can be found in /etc/logrotate.d/rabbitmq-server .

Install on Older Distributions (CentOS 7, RHEL 7) Using PackageCloud Yum Repository

This section covers installation on RHEL 7 and CentOS 7. CentOS 7 has reached the end of general support and is no longer supported. Its use is therefore highly discouraged.

Yum will verify signatures of any packages it installs, therefore the first step in the process is to import the signing key

Add Yum Repositories for RabbitMQ and Modern Erlang

In order to use the Yum repository, a .repo file (e.g. rabbitmq.repo ) has to be added under the /etc/yum.repos.d/ directory.

Red Hat 7, CentOS 7

The following example sets up a repository that will install RabbitMQ and its Erlang dependency from PackageCloud, and targets CentOS 7. There are slight differences to CentOS 8 instructions.

Install Packages with Yum

CentOS 7

Update Yum package metadata:

Next, install the packages:

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!

Источник