Menu

Installing on Windows (manual)

This guide describes how RabbitMQ can be installed and configured manually on Windows. In general we recommend using the provided Windows installer when possible.

Download the Server

DescriptionDownload
Binary build for Windows systems (from GitHub) rabbitmq-server-windows-3.7.10.zip

Install Erlang/OTP

First you need to install a supported version of Erlang for Windows. Run the Erlang Windows installer. Erlang will appear in the Start Menu, and \erlx.x.x\bin\erl.exe will be in C:\Program Files (x86) or C:\Program Files, depending on your platform and whether you chose a 32bit or 64bit version of Erlang.

Set ERLANG_HOME

If you have an existing RabbitMQ installation with the broker running as a service and you installed an Erlang VM with a different architecture then you must uninstall the service before updating ERLANG_HOME.

Set ERLANG_HOME to where you actually put your Erlang installation, e.g. C:\Program Files\erlx.x.x (full path). The RabbitMQ batch files expect to execute %ERLANG_HOME%\bin\erl.exe.

Go to Start > Settings > Control Panel > System > Advanced > Environment Variables. Create the system environment variable ERLANG_HOME and set it to the full path of the directory which contains bin\erl.exe.

Install RabbitMQ Server

Download rabbitmq-server-windows-3.7.10.zip from the link above.

From the zip file, extract the folder named rabbitmq_server-3.7.10 into C:\Program Files\RabbitMQ (or somewhere suitable for application files).

Synchronise Erlang Cookie

The Erlang cookie is a shared secret used for authentication between RabbitMQ nodes and CLI tools. The value is stored in a file commonly referred to as the Erlang cookie file.

The cookie file used by the service account and the user running rabbitmqctl.bat must be synchronised for CLI tools such as rabbitmqctl.bat to function. All nodes in a cluster must have the same cookie value (cookie file contents).

Please see How CLI Tools Authenticate to Nodes (and Nodes to Each Other): the Erlang Cookie for details.

Locating CLI Tools and App Data

CLI tools

Within the rabbitmq_server-3.7.10\sbin directory are some scripts which run commands to control the RabbitMQ server.

The RabbitMQ server can be run as either an application or service (not both).

Log in as an administrator. To see the output, run these from a Command Prompt in the sbin directory.

Note: On Windows Vista (and later) it is necessary to elevate privilege (e.g. right-click on the icon to select Run as Administrator).

Set up the system path so RabbitMQ server and CLI tools from the sbin directory can be executed without using fully qualified paths.

  • Create a system environment variable (e.g. RABBITMQ_SERVER) for "C:\Program Files\RabbitMQ\rabbitmq_server-3.7.10". Adjust this if you put rabbitmq_server-3.7.10 elsewhere, or if you upgrade versions.
  • Append the literal string ";%RABBITMQ_SERVER%\sbin" to your system path (aka %PATH%).
Now it should be possible to run rabbitmq commands from any (administrator) Command Prompt.

Navigate to rabbitmq_server-3.7.10\sbin to run commands if the system path does not contain the RabbitMQ sbin directory.

Data Directory

By default, the RabbitMQ logs and node's data directory are stored in the current user's Application Data directory e.g. C:\Documents and Settings\%USERNAME%\Application Data or C:\Users\%USERNAME%\AppData\Roaming.

Execute echo %APPDATA% at a Command Prompt to find this directory. Alternatively, Start > Run %APPDATA% will open this folder.

A node can be configured to use a different data directory using an environment variable, .

Running RabbitMQ Server as an Application

The application is started by the rabbitmq-server.bat script in sbin.

Customise RabbitMQ Server Environment Variables

Environment variables are used to configure certain parameters of a node, e.g. directory paths. They can be customised as needed.

Start the Broker as an Application

Run the command

rabbitmq-server.bat -detached
. This will start a node in the background (not attached to the Command Prompt).

Alternatively, rabbitmq-server.bat can be executed in Windows Explorer to start a node in foreground.

If you start by double-clicking, a Command Prompt window opens, displays a short banner message, concluding with the message "completed with [n] plugins.", indicating that the RabbitMQ broker has been started successfully.

If the node was started without the -detached option, e.g. using Windows Explorer, a second Command Prompt window will be necessary to control the application using CLI tools. Note: Closing the original Command Prompt window will forcefully shut down a server started this way.

Running RabbitMQ Server as a Service

The service will run in the security context of the system account without the need for a user to be logged in on a console. This is normally more appropriate for production use. The server should not be run as a service and application simultaneously.

The service runs using the rabbitmq-service.bat script in sbin.

Customise RabbitMQ Service Environment Variables

The rabbitmq-service.bat script recognises many of the same environment variables as rabbitmq-server.bat, as well as a few additional service environment variables.

Note: After setting environment variables, it is necessary to reinstall the service.

Install the Service

Install the service by running

rabbitmq-service.bat install

A service with the name defined by RABBITMQ_SERVICENAME should now appear in the Windows Services control panel (Start > Run services.msc).

Managing the Service

To manage the service (install, remove, start, stop, enable, disable), use rabbitmq-service.bat commands. Alternatively, the Windows Services panel (services.msc) can be used to perform some of the same functions as the service script.

Start the Broker as a Service

To start the broker, execute

rabbitmq-service.bat start

If the output from this command is "Service RABBITMQ_SERVICENAME started", then the service was started successfully.

Confirm the service named RABBITMQ_SERVICENAME reports a "Started" status in Services:
Start > Run services.msc.

Port Access

Firewalls and other security tools may prevent RabbitMQ from binding to a port. When that happens, RabbitMQ will fail to start. Make sure the following ports can be opened:

  • 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)
It is possible to configure RabbitMQ to use different ports.

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, delete the guest user, or allow remote access to the guest user.

Managing the Broker

To stop the broker or check its status, use rabbitmqctl.bat in sbin (as an administrator).

Stopping the Node

rabbitmqctl.bat stop

Checking Node Status

rabbitmqctl.bat status

See RabbitMQ CLI tools guide and rabbitmqctl man page for details.

Server Logs

Server logs are critically important in troubleshooting and root cause analysis. See Logging and File and Directory Location guides to learn about log file location, log rotation and more.

Troubleshooting When Running as a Service

In the event that the Erlang VM crashes whilst RabbitMQ is running as a service, rather than writing the crash dump to the current directory (which doesn't make sense for a service) it is written to an erl_crash.dump file in the base directory of the RabbitMQ server (set by the RABBITMQ_BASE environment variable, defaulting to %APPDATA%\%RABBITMQ_SERVICENAME% - typically %APPDATA%\RabbitMQ otherwise).

Windows-specific Issues

We aim to make RabbitMQ a first-class citizen on Windows. However, sometimes there are circumstances beyond our control. Please consult the Windows-specific Issues page.

Getting Help

If you have questions or need help, feel free to ask on the RabbitMQ mailing list.

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!