This section provides comprehensive guidance for deploying Ripple Custody in your environment. Follow the structured approach below to plan, configure, and install your custody solution.
| Step | Phase | Description | Documentation |
|---|---|---|---|
| 1 | Planning | Plan infrastructure, networking, database, messaging, and KMS | Planning |
| 2 | Installation | Deploy Ripple Custody using Helm charts | Installation |
| 3 | Reference configuration | Configure components and integrations | Deployment reference |
| 4 | Verification | Verify deployment and test functionality | Register (UI) | Register (API) |
Before deploying Ripple Custody, plan your infrastructure requirements. Follow the pages in order:
| Step | Topic | Description | Documentation |
|---|---|---|---|
| 1 | Personnel and expertise | Required skills and team responsibilities | Personnel and expertise |
| 2 | Resilience | Component HA/DR strategies and responsibilities | Resilience planning |
| 3 | Key management | KMS/HSM selection (HSM vs MPC) | Key management planning |
| 4 | Blockchain nodes | Blockchain node requirements and connectivity | Blockchain node planning |
| 5 | Database | PostgreSQL requirements and HA configuration | Database planning |
| 6 | Messaging | AMQP/RabbitMQ requirements | Message queue planning |
| 7 | Networking | Firewall rules, proxy, and TLS certificates | Network planning |
| 8 | Secrets management | Secret management and credential storage | Secrets management planning |
Deploy Ripple Custody using Helm charts:
| Topic | Description | Documentation |
|---|---|---|
| Helm Charts | Helm chart structure, values, and customization | Installation environment setup |
| Installation | Step-by-step installation guide | Installation and initialization |
After installation, integrate your Key Management System. Ripple Custody supports HSM (Hardware Security Module) and MPC (Multi-Party Computation) key management approaches.
For a complete list of supported KMS platforms and integration guides, see Key management system integration.
Use the deployment reference when you are ready to set Helm values for your environment:
| Topic | Description | Documentation |
|---|---|---|
| Complete values.yaml reference | Map Helm values to the correct reference page | Deployment reference |
| Infrastructure | Database, AMQP, networking, URLs, and shared settings | PostgreSQL, AMQP, networking |
| Key management | Vault, notary, HSM, and MPC configuration | Vault configuration, notary configuration, MPC configuration |
| Blockchain | Ledgers, blockchain nodes, and indexers | Ledgers, blockchain nodes, indexers |
| Observability | Telemetry and OTEL Collector configuration | Telemetry configuration, OTEL Collector deployment |
- Start with planning: Review all planning documents to understand requirements
- Choose your KMS: Review Key management planning and select your KMS from the KMS integration options.
- Deploy with Helm: Follow Installation and initialization for step-by-step deployment.
- Configure components: Use the deployment reference to customize your deployment.
- Verify deployment: Register as a user following Register (UI) or Register (API)
First time deploying? Start with the Design your governance model for a high-level overview, then return here for detailed deployment instructions.