{"templateId":"markdown","versions":[{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/deployment/reference","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/deployment/reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/deployment/reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/deployment/reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/deployment/reference","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/deployment/reference","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Deployment reference","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"deployment-reference","__idx":0},"children":["Deployment reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these pages to understand the main configuration areas for an on-premise ","Ripple Custody"," deployment. They describe common fields, value relationships, and example configuration shapes."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The examples in this section are illustrative. They show what a deployment values file might look like, but they are not a complete schema or a substitute for the configuration packaged with your release."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For procedures, use the installation and integration guides. For current defaults and the full supported configuration surface, use the values and templates supplied with your release package."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-use-this-section","__idx":1},"children":["How to use this section"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the parameter tables to understand field names, types, defaults, and possible values."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the examples to see one complete way to arrange related fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Treat sizing, provider choices, resource values, hostnames, and secrets as deployment-specific."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Avoid copying examples unchanged into a production environment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference-pages","__idx":2},"children":["Reference pages"]},{"$$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":"Area"},"children":["Area"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Configuration section"},"children":["Configuration section"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use this page to understand"},"children":["Use this page to understand"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Reference"},"children":["Reference"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AMQP"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.externalAmqp"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.internalAmqp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal and external message broker fields, protocol options, and secret keys"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/amqp"},"children":["AMQP configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication secrets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Kubernetes secrets for Keycloak and OAuth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Secret formats for Keycloak and OAuth-related authentication material"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/auth-secrets"},"children":["Secret management for authentication"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Blockchain nodes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.ledgers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Node endpoint patterns and how blockchain nodes relate to indexers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/blockchain-nodes"},"children":["Blockchain nodes configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Common settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["common"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.logging"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.resources"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.included_components"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Shared image pull, security context, probe, logging, resource, and component-selection fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/common"},"children":["Common configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas Station"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gasStation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gas Station service fields and supporting database, health, and telemetry settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/gas-station"},"children":["Gas Station reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Genesis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.genesis.value"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Genesis payload fields used to supply initial governance data during deployment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/governance/genesis/payload-reference"},"children":["Genesis payload reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indexers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.ledgers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["indexers.*"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Chain-specific indexer configuration and ledger field patterns"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/indexers"},"children":["Indexers configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keycloak"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.keycloak"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.keycloak"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keycloak service settings, database schema, resources, and admin credential references"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/keycloak"},"children":["Keycloak configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.notary"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.notary"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notary protocol, deployment, KMS platform, and Notary-to-Vault relationship fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/kms-notary"},"children":["Notary configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vault"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.vaults"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Vault service, vault instance, KMS platform, and Notary public key fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/kms-vault"},"children":["Vault configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ledgers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.ledgers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ledger identifiers, network types, and node connection fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/ledgers"},"children":["Ledgers configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MPC"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.vaults.<vault-id>.kms_mpc"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.mpc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MPC-related Vault fields, threshold values, and network requirements"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/mpc-configuration"},"children":["MPC configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Networking"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.certificates"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.httpProxy"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.<component>.ingress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certificate, proxy, ingress, and TLS-related fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/networking"},"children":["Networking configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notifications"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.notifications.email"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.notification"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email, webhook, notification server, and notification worker settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/notifications"},"children":["Notifications configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["components.oauth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth service resources, environment variables, private key handling, and flow settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/oauth-server"},"children":["OAuth server configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omnibus"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["omnibus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omnibus service fields and supporting database, workflow, Accounting Service, system-signed automation, and telemetry settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/omnibus"},"children":["Omnibus reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.postgresql"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postgresql"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External database connection fields, SSL modes, and schema requirements"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/postgresql"},"children":["PostgreSQL configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Repository"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.repository"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container repository and image pull secret fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/repository"},"children":["Repository configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System-signed intents"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["silo.gateway.system-signed-intents"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["systemSignedIntents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gateway signing, system signing key, runtime enablement, and policy-origin fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/system-signed-intents"},"children":["System-signed intent configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Telemetry"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.telemetry"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["opentelemetry-collector"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OTEL, syslog, metrics, and collector configuration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/telemetry-configuration"},"children":["Telemetry configuration"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URLs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["harmonize.urls"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base service URL and subdomain fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/reference/urls"},"children":["URL configuration"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-topics","__idx":3},"children":["Related topics"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/overview"},"children":["Deployment overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/install/first-time-installation"},"children":["Installation and initialization"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/governance/genesis"},"children":["Genesis"]}]}]}]},"headings":[{"value":"Deployment reference","id":"deployment-reference","depth":1},{"value":"How to use this section","id":"how-to-use-this-section","depth":2},{"value":"Reference pages","id":"reference-pages","depth":2},{"value":"Related topics","id":"related-topics","depth":2}],"frontmatter":{"seo":{"title":"Deployment reference"}},"lastModified":"2026-08-04T20:25:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/deployment/reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}