Rabbit Public Umbrella
This repository makes it easier to work on multiple RabbitMQ sub-projects
at once. It is no longer a requirement for working on an individual plugin
(as of the 3.6.0 cycle) thanks to
After you clone the umbrella for the first time, use
to clone all dependencies. They will be checked out under
Dependencies (sub-projects) are named after their Erlang application names. Mostly they are self-explanatory but there are some less obvious cases for historical reasons:
rabbitis RabbitMQ server
amqp_clientis RabbitMQ Erlang client (AMQP 0-9-1)
rabbit_commonis a library shared by the above
rabbitmq_server_releasecontains release automation and packaging bits
rabbitmq_java_clientalso contains integration test suites for the server
Running RabbitMQ from Source
To run a RabbitMQ node built from source without any plugins, change to the
directory and run:
If you need to access log files, see under
Running RabbitMQ with Plugins
To build a package, and all its dependencies, cd into the package
deps and run
To start RabbitMQ from a plugin directory, use
To run a node with multiple plugins, cd into
deps/rabbitmq_server_release, and run
PLUGINS listing the plugins you need:
make run-broker PLUGINS='rabbitmq_management rabbitmq_consistent_hash_exchange'
To run a node built from source with multiple plugins and a config file, use
make run-broker PLUGINS='rabbitmq_management rabbitmq_consistent_hash_exchange' RABBITMQ_CONFIG_FILE=/path/to/config/file
Integration tests require that you have JDK *+ and Maven 3.x installed. To run all test suites with:
cd deps/rabbitmq_java_client make tests
Full Server Tests
To run all server tests, use
cd deps/rabbit make tests
Note that the above can take up to 2 hours depending on the hardware.
To run a subset of the most essential tests:
To run tests for a sub-project, run
from its directory.
Variables That Can Be Set When Building
The following variables can be passed on the 'make' command line in order to configure builds.
ERL: the Erlang 'erl' command to use,
ERLC: the Erlang 'erlc' command to use,
TMPDIR: temporary directory for database directories, logs, etc
RABBIT_VSN: the RabbitMQ version number,
Consider Using a Snapshot
Before building a distribution from source, consider using a snapshot build instead. For contributions that were merged into one of the maintained release branches, there should typically be no reason to build from source as snapshot releases will be published in the next 15 minutes to several hours (depending on the change and how busy the pipeline is).
Producing a Distribution from Source
The distro-specific packaging targets are now integrated into the top-level build system. You should need to do no more than:
make VERSION=3.7.0.snapshot.123 RABBIT_VSN=3.7.0.snapshot.123 UNOFFICIAL_RELEASE=1 dist
to build debs and rpms, along with the source and binary tarballs. If you just want to build one package, you can use the targets debian_packages, rpm_packages or java_packages in the top-level Makefile.
You need to have cdbs installed to build the Debian packages, and rpm for the Fedora packages.
UNOFFICIAL_RELEASE is used to determine whether packages
should be signed: if the variable is set then they will not be
signed, otherwise they will be. The signing key ID is
UNOFFICIAL_RELEASE is also used by the Debian target to determine
changelog behaviour. If it is not set, then debian/changelog must
contain an entry for the version string in
<Version>. If it is set,
it creates a fake changelog entry.