Docs: warn macOS users against installing RabbitMQ via Homebrew#7267
Docs: warn macOS users against installing RabbitMQ via Homebrew#7267r0hansaxena wants to merge 2 commits intoaiidateam:mainfrom
Conversation
|
Thanks @r0hansaxena! I just want to double-check the issue here, as a macOS user I've always used HomeBrew to install RabbitMQ without issue (and it's frankly easy). Then I'll come back and review the changes. |
|
@r0hansaxena I think we can go ahead and adapt the PR in line with the discussion in the issue. So I would:
Once you've adapted the PR, I'll do a more in-depth review. Thanks! |
r0hansaxena
force-pushed
the
issue_7232_discourage_homebrew_rabbitmq
branch
from
ae6137a to
16e11aa
Compare
…_homebrew_rabbitmq
|
hi @mbercx , I have made the changes, could you please review it? |
mbercx
left a comment
mbercx
left a comment
There was a problem hiding this comment.
Thanks @r0hansaxena! Just a few small comments, then we can merge this.
|
|
||
| .. warning:: | ||
|
|
||
| The ``brew install`` can sometimes install a version of Erlang that is incompatible with the installed version of RabbitMQ, causing ``rabbitmq-server`` to crash on startup with no clear error message. |
There was a problem hiding this comment.
| The ``brew install`` can sometimes install a version of Erlang that is incompatible with the installed version of RabbitMQ, causing ``rabbitmq-server`` to crash on startup with no clear error message. | |
| Homebrew can sometimes install a version of Erlang that is incompatible with the installed version of RabbitMQ. |
| .. warning:: | ||
|
|
||
| The ``brew install`` can sometimes install a version of Erlang that is incompatible with the installed version of RabbitMQ, causing ``rabbitmq-server`` to crash on startup with no clear error message. | ||
| If you run into this issue, verify that your installed versions of Erlang and RabbitMQ are `compatible <https://www.rabbitmq.com/docs/which-erlang>`__, or consider one of the alternative installation methods below. |
There was a problem hiding this comment.
| If you run into this issue, verify that your installed versions of Erlang and RabbitMQ are `compatible <https://www.rabbitmq.com/docs/which-erlang>`__, or consider one of the alternative installation methods below. | |
| If you run into issues, verify that your installed versions of Erlang and RabbitMQ are `compatible <https://www.rabbitmq.com/docs/which-erlang>`__, or consider one of the alternative installation methods below. |
|
|
||
| The ``brew install`` can sometimes install a version of Erlang that is incompatible with the installed version of RabbitMQ, causing ``rabbitmq-server`` to crash on startup with no clear error message. | ||
| If you run into this issue, verify that your installed versions of Erlang and RabbitMQ are `compatible <https://www.rabbitmq.com/docs/which-erlang>`__, or consider one of the alternative installation methods below. | ||
| See the :ref:`troubleshooting section <installation:troubleshooting:installation:rabbitmq>` for more details. |
There was a problem hiding this comment.
The troubleshooting section actually doesn't discuss this?
| If you run into this issue, verify that your installed versions of Erlang and RabbitMQ are `compatible <https://www.rabbitmq.com/docs/which-erlang>`__, or consider one of the alternative installation methods below. | ||
| See the :ref:`troubleshooting section <installation:troubleshooting:installation:rabbitmq>` for more details. | ||
|
|
||
| **Alternative installation methods:** |
There was a problem hiding this comment.
I'd just have 3 sections, i.e. also add a Homebrew header at the top and remove this line. I also prefer boldface for the "headers".
| **Alternative installation methods:** |
| *Using the generic binary build:* | ||
|
|
||
| #. Download the latest `generic binary build <https://www.rabbitmq.com/docs/install-generic-unix>`__ from the RabbitMQ website. | ||
| #. Extract the archive and follow the included installation instructions. |
There was a problem hiding this comment.
Not sure if you checked, but the "included installation instructions" simply say:
Please see https://www.rabbitmq.com/docs/download for installation
guides.
I haven't tried this installation method, but the instructions on the RabbitMQ website also mention to "Make Sure Erlang/OTP is Installed". We definitely don't want to look up those instructions and add them here, however. So my suggestion would be to simply link to the generic binary installation instructions for this method. They explain the steps pretty well there.
2 participants
Addresses #7232
Homebrew installs the latest Erlang alongside RabbitMQ, and the two are
frequently incompatible—causing rabbitmq-server to crash on startup with no useful error message (the troubleshooting docs already document this exact failure).
This updates the macOS tab in the installation guide to warn against Homebrew and recommend the generic binary build or Docker instead. Homebrew is kept as a fallback with an explicit note to check Erlang/RabbitMQ version compatibility.