bitnami/rabbitmq
Bitnami container image for RabbitMQ
500M+
RabbitMQ is an open source general-purpose message broker that is designed for consistent, highly-available messaging scenarios (both synchronous and asynchronous).
Overview of RabbitMQ Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
docker run --name rabbitmq bitnami/rabbitmq:latest
You can find the default credentials and available configuration options in the Environment Variables section.
Looking to use RabbitMQ in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami RabbitMQ Chart GitHub repository.
Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
You can see the equivalence between the different tags by taking a look at the tags-info.yaml
file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml
.
Subscribe to project updates by watching the bitnami/containers GitHub repo.
The recommended way to get the Bitnami RabbitMQ Docker Image is to pull the prebuilt image from the Docker Hub Registry.
docker pull bitnami/rabbitmq:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
docker pull bitnami/rabbitmq:[TAG]
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build
command. Remember to replace the APP
, VERSION
and OPERATING-SYSTEM
path placeholders in the example command below with the correct values.
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
For persistence you should mount a directory at the /bitnami/rabbitmq/mnesia
path. If the mounted directory is empty, it will be initialized on the first run.
docker run \
-v /path/to/rabbitmq-persistence:/bitnami/rabbitmq/mnesia \
bitnami/rabbitmq:latest
NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID
1001
.
Using Docker container networking, a RabbitMQ server running inside a container can easily be accessed by your application containers.
Containers attached to the same network can communicate with each other using the container name as the hostname.
In this example, we will create a RabbitMQ client instance that will connect to the server instance that is running on the same docker network as the client.
Step 1: Create a network
docker network create app-tier --driver bridge
Step 2: Launch the RabbitMQ server instance
Use the --network app-tier
argument to the docker run
command to attach the RabbitMQ container to the app-tier
network.
docker run -d --name rabbitmq-server \
--network app-tier \
bitnami/rabbitmq:latest
Step 3: Launch your RabbitMQ client instance
Finally we create a new container instance to launch the RabbitMQ client and connect to the server created in the previous step:
docker run -it --rm \
--network app-tier \
bitnami/rabbitmq:latest rabbitmqctl -n rabbit@rabbitmq-server status
When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge
network named app-tier
. In this example we assume that you want to connect to the RabbitMQ server from your own custom application image which is identified in the following snippet by the service name myapp
.
version: '2'
networks:
app-tier:
driver: bridge
services:
rabbitmq:
image: 'bitnami/rabbitmq:latest'
networks:
- app-tier
myapp:
image: 'YOUR_APPLICATION_IMAGE'
networks:
- app-tier
IMPORTANT:
- Please update the YOUR_APPLICATION_IMAGE placeholder in the above snippet with your application image
- In your application container, use the hostname
rabbitmq
to connect to the RabbitMQ server
Launch the containers using:
docker-compose up -d
Customizable environment variables
Name | Description | Default Value |
---|---|---|
RABBITMQ_CONF_FILE | RabbitMQ configuration file. | ${RABBITMQ_CONF_DIR}/rabbitmq.conf |
RABBITMQ_DEFINITIONS_FILE | Whether to load external RabbitMQ definitions. This is incompatible with setting the RabbitMQ password securely. | /app/load_definition.json |
RABBITMQ_SECURE_PASSWORD | Whether to set the RabbitMQ password securely. This is incompatible with loading external RabbitMQ definitions. | no |
RABBITMQ_CLUSTER_NODE_NAME | RabbitMQ cluster node name. When specifying this, ensure you also specify a valid hostname as RabbitMQ will fail to start otherwise. | nil |
RABBITMQ_CLUSTER_PARTITION_HANDLING | RabbitMQ cluster partition recovery mechanism. | ignore |
RABBITMQ_DISK_FREE_RELATIVE_LIMIT | Disk relative free space limit of the partition on which RabbitMQ is storing data. | 1.0 |
RABBITMQ_DISK_FREE_ABSOLUTE_LIMIT | Disk absolute free space limit of the partition on which RabbitMQ is storing data (takes precedence over the relative limit). | nil |
RABBITMQ_ERL_COOKIE | Erlang cookie to determine whether different nodes are allowed to communicate with each other. | nil |
RABBITMQ_VM_MEMORY_HIGH_WATERMARK | High memory watermark for RabbitMQ to block publishers and prevent new messages from being enqueued. Can be specified as an absolute or relative value (as percentage or value between 0 and 1). | nil |
RABBITMQ_LOAD_DEFINITIONS | Whether to load external RabbitMQ definitions. This is incompatible with setting the RabbitMQ password securely. | no |
RABBITMQ_MANAGEMENT_BIND_IP | RabbitMQ management server bind IP address. | 0.0.0.0 |
RABBITMQ_MANAGEMENT_PORT_NUMBER | RabbitMQ management server port number. | 15672 |
RABBITMQ_MANAGEMENT_ALLOW_WEB_ACCESS | Allow web access to RabbitMQ management portal for RABBITMQ_USERNAME | false |
RABBITMQ_NODE_NAME | RabbitMQ node name. | rabbit@localhost |
RABBITMQ_USE_LONGNAME | Whether to use fully qualified names to identify nodes | false |
RABBITMQ_NODE_PORT_NUMBER | RabbitMQ node port number. | 5672 |
RABBITMQ_NODE_TYPE | RabbitMQ node type. | stats |
RABBITMQ_VHOST | RabbitMQ vhost. | / |
RABBITMQ_VHOSTS | List of additional virtual host (vhost). | nil |
RABBITMQ_CLUSTER_REBALANCE | Rebalance the RabbitMQ Cluster. | false |
RABBITMQ_CLUSTER_REBALANCE_ATTEMPTS | Max attempts for the rebalance check to run | 100 |
RABBITMQ_USERNAME | RabbitMQ user name. | user |
RABBITMQ_PASSWORD | RabbitMQ user password. | bitnami |
RABBITMQ_FORCE_BOOT | Force a node to start even if it was not the last to shut down | no |
RABBITMQ_ENABLE_LDAP | Enable the LDAP configuration. | no |
RABBITMQ_LDAP_TLS | Enable secure LDAP configuration. | no |
RABBITMQ_LDAP_SERVERS | Comma, semi-colon or space separated list of LDAP server hostnames. | nil |
RABBITMQ_LDAP_SERVERS_PORT | LDAP servers port. | 389 |
RABBITMQ_LDAP_USER_DN_PATTERN | DN used to bind to LDAP in the form cn=$${username},dc=example,dc=org. | nil |
RABBITMQ_NODE_SSL_PORT_NUMBER | RabbitMQ node port number for SSL connections. | 5671 |
RABBITMQ_SSL_CACERTFILE | Path to the RabbitMQ server SSL CA certificate file. | nil |
RABBITMQ_SSL_CERTFILE | Path to the RabbitMQ server SSL certificate file. | nil |
RABBITMQ_SSL_KEYFILE | Path to the RabbitMQ server SSL certificate key file. | nil |
RABBITMQ_SSL_DEPTH | Maximum number of non-self-issued intermediate certificates that may follow the peer certificate in a valid certification path. | nil |
RABBITMQ_SSL_FAIL_IF_NO_PEER_CERT | Whether to reject TLS connections if client fails to provide a certificate. | no |
RABBITMQ_SSL_VERIFY | Whether to enable peer SSL certificate verification. Valid values: verify_none, verify_peer. | verify_none |
RABBITMQ_MANAGEMENT_SSL_PORT_NUMBER | RabbitMQ management server port number for SSL/TLS connections. | 15671 |
RABBITMQ_MANAGEMENT_SSL_CACERTFILE | Path to the RabbitMQ management server SSL CA certificate file. | $RABBITMQ_SSL_CACERTFILE |
RABBITMQ_MANAGEMENT_SSL_CERTFILE | Path to the RabbitMQ server SSL certificate file. | $RABBITMQ_SSL_CERTFILE |
RABBITMQ_MANAGEMENT_SSL_KEYFILE | Path to the RabbitMQ management server SSL certificate key file. | $RABBITMQ_SSL_KEYFILE |
RABBITMQ_MANAGEMENT_SSL_DEPTH | Maximum number of non-self-issued intermediate certificates that may follow the peer certificate in a valid certification path, for the RabbitMQ management server. | nil |
RABBITMQ_MANAGEMENT_SSL_FAIL_IF_NO_PEER_CERT | Whether to reject TLS connections if client fails to provide a certificate for the RabbitMQ management server. | yes |
RABBITMQ_MANAGEMENT_SSL_VERIFY | Whether to enable peer SSL certificate verification for the RabbitMQ management server. Valid values: verify_none, verify_peer. | verify_peer |
Read-only environment variables
Name | Description | Value |
---|---|---|
RABBITMQ_VOLUME_DIR | Persistence base directory. | /bitnami/rabbitmq |
RABBITMQ_BASE_DIR | RabbitMQ installation directory. | /opt/bitnami/rabbitmq |
RABBITMQ_BIN_DIR | RabbitMQ executables directory. | ${RABBITMQ_BASE_DIR}/sbin |
RABBITMQ_DATA_DIR | RabbitMQ data directory. | ${RABBITMQ_VOLUME_DIR}/mnesia |
RABBITMQ_CONF_DIR | RabbitMQ configuration directory. | ${RABBITMQ_BASE_DIR}/etc/rabbitmq |
RABBITMQ_DEFAULT_CONF_DIR | RabbitMQ default configuration directory. | ${RABBITMQ_BASE_DIR}/etc/rabbitmq.default |
RABBITMQ_CONF_ENV_FILE | RabbitMQ configuration file for environment variables. | ${RABBITMQ_CONF_DIR}/rabbitmq-env.conf |
RABBITMQ_HOME_DIR | RabbitMQ home directory. | ${RABBITMQ_BASE_DIR}/.rabbitmq |
RABBITMQ_LIB_DIR | RabbitMQ lib directory. | ${RABBITMQ_BASE_DIR}/var/lib/rabbitmq |
RABBITMQ_INITSCRIPTS_DIR | RabbitMQ init scripts directory. | /docker-entrypoint-initdb.d |
RABBITMQ_LOGS_DIR | RabbitMQ logs directory. | ${RABBITMQ_BASE_DIR}/var/log/rabbitmq |
RABBITMQ_PLUGINS_DIR | RabbitMQ plugins directory. | ${RABBITMQ_BASE_DIR}/plugins |
RABBITMQ_MOUNTED_CONF_DIR | RabbitMQ directory for mounted configuration files. | ${RABBITMQ_VOLUME_DIR}/conf |
RABBITMQ_DAEMON_USER | RabbitMQ system user name. | rabbitmq |
RABBITMQ_DAEMON_GROUP | RabbitMQ system user group. | rabbitmq |
RABBITMQ_MNESIA_BASE | Path to RabbitMQ mnesia directory. | $RABBITMQ_DATA_DIR |
RABBITMQ_COMBINED_CERT_PATH | Path to the RabbitMQ server SSL certificate key file. | ${RABBITMQ_COMBINED_CERT_PATH:-/tmp/rabbitmq_combined_keys.pem} |
When you start the rabbitmq image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run
command line. If you want to add a new environment variable:
docker-compose.yml
file present in this repository: :rabbitmq:
...
environment:
- RABBITMQ_PASSWORD=my_password
...
-e
option with each variable and value.Using Docker Compose
This is the simplest way to run RabbitMQ with clustering configuration:
docker-compose.yml
Copy the snippet below into your docker-compose.yml to add a RabbitMQ stats node to your cluster configuration.
version: '2'
services:
stats:
image: bitnami/rabbitmq
environment:
- RABBITMQ_NODE_TYPE=stats
- RABBITMQ_NODE_NAME=rabbit@stats
- RABBITMQ_ERL_COOKIE=s3cr3tc00ki3
ports:
- '15672:15672'
volumes:
- 'rabbitmqstats_data:/bitnami/rabbitmq/mnesia'
Note: The name of the service (stats) is important so that a node could resolve the hostname to cluster with. (Note that the node name is
rabbit@stats
)
Update the definitions for nodes you want your RabbitMQ stats node cluster with.
queue-disc1:
image: bitnami/rabbitmq
environment:
- RABBITMQ_NODE_TYPE=queue
_Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/containers/blob/main/bitnami/rabbitmq/README.md_