docs(messaging): connecting to an external ActiveMQ broker - #209
Merged
Conversation
DIRIGIBLE_MESSAGING_BROKER_URL (plus the optional username and password) points messaging at a broker the platform does not own; unset keeps the embedded one. The env-var reference had no messaging section at all, and several pages stated the broker is always embedded - the producer SDK page went as far as promising "no broker URL". Adds a Messaging table to both env-var pages and a "Broker - embedded or external" section to the message listeners page, covering the configuration, why a shared broker matters for global destinations, and the three things that differ: the Messaging perspective is unavailable, the embedded persistence flag is ignored, and an unreachable broker fails startup on purpose. The remaining edits correct pages that asserted an embedded-only broker. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the messaging broker configuration added in
eclipse-dirigible/dirigible#6870:
Unset keeps today's behaviour - the broker embedded in the server process.
Why more than one page changed
The env-var reference carried no messaging section at all (
DIRIGIBLE_MESSAGING_USE_DEFAULT_DATABASEexisted only in the archived
help_oldtree), and several pages asserted the broker is alwaysembedded. The producer SDK page went as far as promising "no broker URL, no client configuration",
which is now wrong.
New content
help/reference/environment-variables- aMessagingsection (between Flowable and CMS/S3), allfour variables with defaults, plus the two operational consequences.
help/setup/environment-variables- the install-oriented subset of the same.help/develop/message-listeners- aBroker - embedded or externalsection: the configuration,ssl://andfailover:(...)URLs, a tip on why a shared broker is what makes aglobal:destination a contract between deployments, and what differs in external mode.
help/ide/perspectives/messaging- anEmbedded broker onlysection. The perspective reads thein-process
BrokerService(JMX is disabled), so against an external broker its endpoints are notregistered and answer
404.Corrections to existing statements
sdk/messaging/producer,sdk/messaging/index,help/artefacts/process/listener,help/ide/views/listeners,help/reference/glossary- each said or implied the broker is alwaysembedded. Reworded to "the platform's / the runtime's broker" with a link to the new section. No
change of meaning for a default deployment.
help_old/was deliberately left alone (archived, out of nav).Verification
npm run docs:buildcompletes clean.#broker-embedded-or-external,#messaging,#embedded-broker-only), so the cross-links between the pages are live.:::containers, no em-dashes or en-dashes, absolute cross-links,frontmatter intact. No
config.mtschange needed - every page edited is already in the nav.🤖 Generated with Claude Code