Skip to content

Fix RabbitMQ README #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2025
Merged

Fix RabbitMQ README #19

merged 1 commit into from
May 9, 2025

Conversation

och42
Copy link

@och42 och42 commented Apr 23, 2025

The RabbitMQ plugin sets the $RABBITMQ_CONFIG_FILES environment variable, not $RABBITMQ_CONFIG_FILE, as shown in rabbitmq/plugin.json:6.[1]

Both variables are documented in the official RabbitMQ Environment Variables guide.[2]

[1]

"RABBITMQ_CONFIG_FILES": "{{.DevboxDir}}/conf.d",

[2] https://www.rabbitmq.com/docs/relocate#environment-variables

The RabbitMQ plugin sets the `$RABBITMQ_CONFIG_FILES` environment variable,
not `$RABBITMQ_CONFIG_FILE`, as shown in `rabbitmq/plugin.json:6`.[1]

Both variables are documented in the official RabbitMQ Environment Variables guide.[2]

[1] https://github.com/jetify-com/devbox-plugins/blob/4aab8235eb412ff6997900969aed64158c4497c8/rabbitmq/plugin.json#L6
[2] https://www.rabbitmq.com/docs/relocate#environment-variables
Copy link
Contributor

@LucilleH LucilleH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RABBITMQ_CONFIG_FILE is also part of the documentation. Leaning towards not fix

@LucilleH LucilleH closed this May 8, 2025
@och42
Copy link
Author

och42 commented May 9, 2025

I don't understand why not fix it. Devbox plugins documentation is incorrect. It says that it sets the RABBITMQ_CONFIG_FILE (no "S" suffix)

* **RABBITMQ_CONFIG_FILE** = {{.DevboxDir}}/conf.d
but that is not true.
It actually sets RABBITMQ_CONFIG_FILES (with "S" suffix).
"RABBITMQ_CONFIG_FILES": "{{.DevboxDir}}/conf.d",

While RabbitMQ defines both configuration variables, each has a different purpose:

  • RABBITMQ_CONFIG_FILE - sets a single main (or primary) configuration file, typically path to rabbitmq.conf file.
  • RABBITMQ_CONFIG_FILES - sets a directory of configuration files, typically path to conf.d/ directory.

As RabbitMQ documentation says in The Main Configuration File, rabbitmq.conf chapter's last paragraph:

To override the main RabbitMQ config file location, use the > RABBITMQ_CONFIG_FILE (or RABBITMQ_CONFIG_FILES to use a conf.d-style directory of sorted files) environment variables.

and in Using a Directory of .conf Files chapter's first paragraph:

A conf.d-style directory of files can also be used. Use RABBITMQ_CONFIG_FILES (note the plural "_FILES") to point the node at a directory of such files:

Previously referenced documentation chapter Environment Variables also states differences between RABBITMQ_CONFIG_FILE and RABBITMQ_CONFIG_FILES.

Devbox plugin only sets the RABBITMQ_CONFIG_FILES.

This is basically just a typo in documentation.

Edit: Changed links to GitHub style to show code previews.

@LucilleH LucilleH reopened this May 9, 2025
@LucilleH
Copy link
Contributor

LucilleH commented May 9, 2025

@och42 I have misunderstood your message. Thanks for clarifying!

@LucilleH LucilleH merged commit c0d10af into jetify-com:main May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants