3.6.12
,3.6
,3
,latest
(3.6/debian/Dockerfile)3.6.12-management
,3.6-management
,3-management
,management
(3.6/debian/management/Dockerfile)3.6.12-alpine
,3.6-alpine
,3-alpine
,alpine
(3.6/alpine/Dockerfile)3.6.12-management-alpine
,3.6-management-alpine
,3-management-alpine
,management-alpine
(3.6/alpine/management/Dockerfile)
-
Where to get help:
the Docker Community Forums, the Docker Community Slack, or Stack Overflow -
Where to file issues:
https://github.com/docker-library/rabbitmq/issues -
Maintained by:
the Docker Community -
Supported architectures: (more info)
amd64
,arm32v5
,arm32v7
,arm64v8
,i386
,ppc64le
,s390x
-
Published image artifact details:
repo-info repo'srepos/rabbitmq/
directory (history)
(image metadata, transfer size, etc) -
Image updates:
official-images PRs with labellibrary/rabbitmq
official-images repo'slibrary/rabbitmq
file (history) -
Source of this description:
docs repo'srabbitmq/
directory (history) -
Supported Docker versions:
the latest release (down to 1.6 on a best-effort basis)
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.
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 -h
/--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
Note the 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.
RabbitMQ contains functionality which explicitly tracks and manages memory usage, and thus needs to be made aware of cgroup-imposed limits.
The upstream configuration setting for this is vm_memory_high_watermark
, and it is described under "Memory Alarms" in the documentation.
In this image, this value is set via RABBITMQ_VM_MEMORY_HIGH_WATERMARK
. The value of this environment variable is interpreted as follows:
0.49
is treated as49%
, just like upstream ({ vm_memory_high_watermark, 0.49 }
)56%
is treated as56%
(0.56
;{ vm_memory_high_watermark, 0.56 }
)1073741824
is treated as an absolute number of bytes ({ vm_memory_high_watermark, { absolute, 1073741824 } }
)1024MiB
is treated as an absolute number of bytes with a unit ({ vm_memory_high_watermark, { absolute, "1024MiB" } }
)
The main behavioral difference is in how percentages are handled. If the current container has a memory limit (--memory
/-m
), a percentage value will be calculated to an absolute byte value based on the memory limit, rather than being passed to RabbitMQ as-is. For example, a container run with --memory 2048m
(and the implied upstream-default RABBITMQ_VM_MEMORY_HIGH_WATERMARK
of 40%
) will set the effective limit to 819MB
(which is 40%
of 2048MB
).
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 rabbitmqctl
), use RABBITMQ_ERLANG_COOKIE
:
$ 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 guest
/ guest
:
$ 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://localhost:8080
or http://host-ip:8080
in a browser.
If you wish to change the default username and password of guest
/ guest
, you can do so with the RABBITMQ_DEFAULT_USER
and 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://localhost:8080
or http://host-ip:8080
in a browser and use user
/password
to gain access to the management console
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
Warning: if you're using the Alpine variant, there is currently an outstanding bug (Alpine Linux bug #5700) with the erlang-hipe
package which prevents HiPE from working in Alpine Linux. See docker-library/rabbitmq#151 for more discussion.
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.
$ docker run --name some-app --link some-rabbit:rabbit -d application-that-uses-rabbitmq
The 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 git
or 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.