Documentation
You are currently viewing documentation for version 3.0 which is not a long-term support release. The latest long-term support release is version 2.6

Set Up the Message Queue Broker

Out-of-the-box, Oro applications can use one of two Message Queue brokers: the proprietary DBAL based and the RabbitMQ.

Note

For more information about Message Queue brokers, their roles and purpose, see the Message Queue Broker article of the Architecture section.

Since the DBAL broker is built-in in every Oro application, it does not need additional actions to install. To use this broker, it is enough to specify it in the appropriate parameter value of the application configuration.

The RabbitMQ broker integration is part of the Enterprise Edition Oro Applications. Whenever possible, it is recommended to use it, as it provides better and faster message delivery versus DBAL.

Since RabbitMQ is a third-party software, additional installation and configuration efforts are required in order to be used in Oro applications.

Install RabbitMQ

You need to have RabbitMQ version 3.6.* installed.

To install the RabbitMQ, follow the download and installation manual.

After the installation, please check that you have the required plugins installed and enabled:

Plugin name Version Appointment
rabbitmq_del ayed_message _exchange 20171215 Required. A plugin that adds delayed-messa ging (or scheduled-mes saging) to RabbitMQ. See also
rabbitmq_man agement 3.6.* Optional. Provides an HTTP-based API for management and monitoring of your RabbitMQ server. See also

The rabbitmq_delayed_message_exchange plugin is required for the proper work but it is not installed by default, therefore you need to download and enable it following the instructions below:

  1. Download it using the following command:

    1
    wget https://dl.bintray.com/rabbitmq/community-plugins/3.6.x/rabbitmq_delayed_message_exchange/rabbitmq_delayed_message_exchange-20171215-3.6.x.zip && unzip rabbitmq_delayed_message_exchange-20171215-3.6.x.zip -d {RABBITMQ_HOME}/plugins && rm rabbitmq_delayed_message_exchange-20171215-3.6.x.zip
    
  2. Enable it using the following command:

    1
    rabbitmq-plugins enable --offline rabbitmq_delayed_message_exchange
    

RabbitMQ Useful Hints

  • You can see the RabbitMQ default web interface here, if the rabbitmq_management plugin is enabled:

    http://localhost:15672/. More details are available here.

  • You can temporary stop RabbitMQ by running the rabbitmqctl stop_app command. It stops the RabbitMQ application leaving the Erlang node running. You can resume it with the rabbitmqctl start_app command. More details are available here.

Troubleshooting

The following exception

1
2
[PhpAmqpLib\Exception\AMQPRuntimeException]
Broken pipe or closed connection

may be caused by one of the following reasons:

  • The rabbitmq_delayed_message_exchange plugin is missing.
  • The RabbitMQ version is too old (older than 3.5.8).

RabbitMQ Minimum Permissions

More about access control.

Your credentials must meet the following minimum requirements:

  • Access to requested RabbitMQ’s virtual host (/ by default).
  • Permissions to: configure, write, read. It could be a default value .* or a stricter oro.*.

You will be redirected to [title]. Would you like to continue?

Yes No
sso for www.magecore.comsso for oroinc.desso for oroinc.frsso for marketplace.orocommerce.comsso for marketplace.orocrm.com