{"templateId":"markdown","versions":[{"version":"v1.43","label":"v1.43 LTS","link":"/pt-br/products/custody/deployment/reference/amqp","default":true,"active":true,"folderId":"714bb270"},{"version":"v1.42","label":"v1.42 STS","link":"/pt-br/products/custody/v1.42/deployment/reference/amqp","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.41","label":"v1.41 STS","link":"/pt-br/products/custody/v1.41/deployment/reference/amqp","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.34","label":"v1.34 LTS","link":"/pt-br/products/custody/v1.34/deployment/reference/amqp","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.26","label":"v1.26 LTS","link":"/pt-br/products/custody/v1.26/deployment/reference/amqp","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.19","label":"v1.19 LTS","link":"/pt-br/products/custody/v1.19/deployment/reference/amqp","default":false,"active":false,"folderId":"714bb270"},{"version":"v1.15","label":"v1.15 LTS","link":"/pt-br/products/custody/v1.15/deployment/reference/amqp","default":false,"active":false,"folderId":"714bb270"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/pt-BR/products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"AMQP configuration","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"amqp-configuration","__idx":0},"children":["AMQP configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this page to understand the AMQP fields that control RabbitMQ connectivity for ","Ripple Custody",". The examples show one possible configuration shape; your broker topology, hostnames, credentials, and TLS settings depend on your deployment."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page applies to on-premise deployments only. For current defaults and the full supported schema, use the configuration packaged with your release."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-this-config-controls","__idx":1},"children":["What this config controls"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody"," uses AMQP for message-based communication between components. There are two AMQP configuration areas:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["External AMQP"]},": Customer-managed RabbitMQ. External AMQP is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," for event processing and can ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["optionally"]}," be used for core components."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Internal AMQP"]},": RabbitMQ deployed with ","Ripple Custody",". Internal AMQP is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["enabled by default"]}," for core components and is never used for event processing."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Core components can use either internal AMQP or external AMQP, but not both at the same time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration-fields","__idx":2},"children":["Configuration fields"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"external-amqp","__idx":3},"children":["External AMQP"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Location: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.externalAmqp"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabledForCoreComponents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Route core component AMQP traffic through the external broker. Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalAmqp.enabledForCoreComponents"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["host"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External AMQP host address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["port"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External AMQP port. Common values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5672"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5671"]}," for TLS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Username for authentication."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["password"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Password for authentication."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vhost"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Virtual host name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sslEnabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enable SSL/TLS connection."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"plain-authentication\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amqpProtocolVersion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"v1\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Protocol version. Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v09"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["topicName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Topic name for messaging."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["existingSecret"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nil"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference to an existing Kubernetes secret."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"internal-amqp","__idx":4},"children":["Internal AMQP"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Location: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.internalAmqp"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabledForCoreComponents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enable internal AMQP for core components. Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalAmqp.enabledForCoreComponents"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["host"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<chart-fullname>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal RabbitMQ host."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["port"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["int"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5672"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RabbitMQ port."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"user\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RabbitMQ username."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vhost"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"harmonize\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RabbitMQ virtual host."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sslEnabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bool"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Enable SSL for internal RabbitMQ."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amqpProtocolVersion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"v09\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Protocol version. Internal AMQP supports ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v09"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["existingSecret"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"\""]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference to an existing Kubernetes secret."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"constraints-and-relationships","__idx":5},"children":["Constraints and relationships"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.externalAmqp.enabledForCoreComponents"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.internalAmqp.enabledForCoreComponents"]}," are mutually exclusive."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Event processing requires external AMQP."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Internal AMQP is not used for event processing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Core components use internal AMQP unless you route them to external AMQP."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["External AMQP supports ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v1"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v09"]},"; internal AMQP uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v09"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"secret-format","__idx":6},"children":["Secret format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["existingSecret"]}," for either internal or external AMQP, the secret must contain the expected password and connection URI keys:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"apiVersion: v1\nkind: Secret\nmetadata:\n  name: amqp-credentials\ntype: Opaque\nstringData:\n  rabbitmq-password: \"<password>\"\n  AMQP_URI: \"amqp://<username>:<password>@<host>:<port>/<vhost>\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":7},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This example shows internal AMQP for core components and external AMQP for event processing:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"harmonize:\n  internalAmqp:\n    enabledForCoreComponents: true\n    username: \"user\"\n    vhost: \"harmonize\"\n    sslEnabled: true\n\n  externalAmqp:\n    enabledForCoreComponents: false\n    host: \"events-rabbitmq.example.com\"\n    port: 5671\n    username: \"events\"\n    password: \"SECURE_PASSWORD\"\n    vhost: \"events\"\n    sslEnabled: true\n    amqpProtocolVersion: \"v1\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this shape, core components communicate through internal AMQP. Event processing uses the external broker."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":8},"children":["Related topics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/deployment/reference/postgresql"},"children":["PostgreSQL configuration"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/deployment/reference/networking"},"children":["Networking configuration"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/custody/deployment/planning/messaging"},"children":["Message queue planning"]}]}]}]},"headings":[{"value":"AMQP configuration","id":"amqp-configuration","depth":1},{"value":"What this config controls","id":"what-this-config-controls","depth":2},{"value":"Configuration fields","id":"configuration-fields","depth":2},{"value":"External AMQP","id":"external-amqp","depth":3},{"value":"Internal AMQP","id":"internal-amqp","depth":3},{"value":"Constraints and relationships","id":"constraints-and-relationships","depth":2},{"value":"Secret format","id":"secret-format","depth":2},{"value":"Example","id":"example","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"seo":{"title":"AMQP configuration"}},"lastModified":"2026-10-21T06:01:40.974Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/custody/deployment/reference/amqp","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}