<!-- ******************************************************************************** WARNING: DO NOT EDIT "rabbitmq/README.md" IT IS AUTO-GENERATED (from the other files in "rabbitmq/" combined with a set of templates) ******************************************************************************** -->
Supported tags and respective
For more information about this image and its history, please see the relevant manifest file (
library/rabbitmq). This image is updated via pull requests to the
docker-library/official-images GitHub repo.
For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the
repos/rabbitmq/tag-details.md file in the
docker-library/repo-info GitHub repo.
What is RabbitMQ?
RabbitMQ is open source message broker software (sometimes called message-oriented middleware) that implements the Advanced Message Queuing Protocol (AMQP). The RabbitMQ server is written in the Erlang programming language and is built on the Open Telecom Platform framework for clustering and failover. Client libraries to interface with the broker are available for all major programming languages.
How to use this image
Running the daemon
One of the important things to note about RabbitMQ is that it stores data based on what it calls the "Node Name", which defaults to the hostname. What this means for usage in Docker is that we should specify
--hostname explicitly for each daemon so that we don't get a random hostname and can keep track of our data:
$ docker run -d --hostname my-rabbit --name some-rabbit rabbitmq:3
If you give that a minute, then do
docker logs some-rabbit, you'll see in the output a block similar to:
=INFO REPORT==== 6-Jul-2015::20:47:02 === node : rabbit@my-rabbit home dir : /var/lib/rabbitmq config file(s) : /etc/rabbitmq/rabbitmq.config cookie hash : UoNOcDhfxW9uoZ92wh6BjA== log : tty sasl log : tty database dir : /var/lib/rabbitmq/mnesia/rabbit@my-rabbit
database dir there, especially that it has my "Node Name" appended to the end for the file storage. This image makes all of
/var/lib/rabbitmq a volume by default.
See the RabbitMQ "Clustering Guide" for more information about cookies and why they're necessary.
For setting a consistent cookie (especially useful for clustering but also for remote/cross-container administration via
$ docker run -d --hostname my-rabbit --name some-rabbit -e RABBITMQ_ERLANG_COOKIE='secret cookie here' rabbitmq:3
This can then be used from a separate instance to connect:
$ docker run -it --rm --link some-rabbit:my-rabbit -e RABBITMQ_ERLANG_COOKIE='secret cookie here' rabbitmq:3 bash root@f2a2d3d27c75:/# rabbitmqctl -n rabbit@my-rabbit list_users Listing users ... guest [administrator]
Alternatively, one can also use
RABBITMQ_NODENAME to make repeated
rabbitmqctl invocations simpler:
$ docker run -it --rm --link some-rabbit:my-rabbit -e RABBITMQ_ERLANG_COOKIE='secret cookie here' -e RABBITMQ_NODENAME=rabbit@my-rabbit rabbitmq:3 bash root@f2a2d3d27c75:/# rabbitmqctl list_users Listing users ... guest [administrator]
There is a second set of tags provided with the management plugin installed and enabled by default, which is available on the standard management port of 15672, with the default username and password of
$ docker run -d --hostname my-rabbit --name some-rabbit rabbitmq:3-management
You can access it by visiting
http://container-ip:15672 in a browser or, if you need access outside the host, on port 8080:
$ docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 rabbitmq:3-management
You can then go to
http://host-ip:8080 in a browser.
Setting default user and password
If you wish to change the default username and password of
guest, you can do so with the
RABBITMQ_DEFAULT_PASS environmental variables:
$ docker run -d --hostname my-rabbit --name some-rabbit -e RABBITMQ_DEFAULT_USER=user -e RABBITMQ_DEFAULT_PASS=password rabbitmq:3-management
You can then go to
http://host-ip:8080 in a browser and use
password to gain access to the management console
Setting default vhost
If you wish to change the default vhost, you can do so with the
RABBITMQ_DEFAULT_VHOST environmental variables:
$ docker run -d --hostname my-rabbit --name some-rabbit -e RABBITMQ_DEFAULT_VHOST=my_vhost rabbitmq:3-management
See the RabbitMQ "Configuration" for more information about various configuration options.
For enabling the HiPE compiler on startup use
RABBITMQ_HIPE_COMPILE set to
1. Accroding to the official documentation:
Set to true to precompile parts of RabbitMQ with HiPE, a just-in-time compiler for Erlang. This will increase server throughput at the cost of increased startup time. You might see 20-50% better performance at the cost of a few minutes delay at startup.
It is therefore important to take that startup delay into consideration when configuring health checks, automated clustering etc.
Connecting to the daemon
$ docker run --name some-app --link some-rabbit:rabbit -d application-that-uses-rabbitmq
rabbitmq images come in many flavors, each designed for a specific use case.
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
This image is based on the popular Alpine Linux project, available in the
alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
To minimize image size, it's uncommon for additional related tools (such as
bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the
alpine image description for examples of how to install packages if you are unfamiliar).
View license information for the software contained in this image.
Supported Docker versions
This image is officially supported on Docker version 17.03.0-ce.
Support for older versions (down to 1.6) is provided on a best-effort basis.
Please see the Docker installation documentation for details on how to upgrade your Docker daemon.
If you have any problems with or questions about this image, please contact us through a GitHub issue. If the issue is related to a CVE, please check for a
cve-tracker issue on the
official-images repository first.
You can also reach many of the official image maintainers via the
#docker-library IRC channel on Freenode.
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
Documentation for this image is stored in the
rabbitmq/ directory of the
docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository's
README.md file before attempting a pull request.