Operate

This site describes how to operate a Participant Node, the component that connects your applications to the Canton Network.

The table of contents contains links to tutorials for those getting started with running a Participant Node, as well as how-tos, explanations, and reference materials to assist experienced operators.

If you want to run Canton on a local, private deployment, then follow the instructions in this section.

If you want to deploy a node on the public network, follow the Splice Validator deployment instructions.

• Overview
• Tutorials
  • Install Canton
  • Canton KMS Driver developer guide
  • Example Monitoring Setup
• How Tos
  • Download
    • Download the Release Bundle
    • Obtaining the Docker Images
  • Install
    • Install Canton
    • Work With the Docker Containers
  • Configure
    • Use the Canton Command Line
    • Set Configuration Options
    • Declarative Configuration
    • Configure a Node’s Identity
    • Configure storage
    • Configure Canton with PostgreSQL
    • API Configuration
    • Admin API Configuration
    • gRPC Ledger API Configuration
    • JSON Ledger API Configuration
    • Configure Canton parameters
  • Secure
    • TLS API Configuration
    • Configure API Authentication and Authorization with JWT
    • Configure API Limits
    • Set Resource Limits
    • Crypto key management
    • Restrict key usage
    • Namespace Key Management
    • Key management service (KMS) configuration
      • Configure a KMS
        • Configure a Amazon Web Services (AWS) KMS
        • Configure a Google Cloud Provider (GCP) KMS
        • Configure a Driver-based KMS
      • Select a KMS mode of operation
        • Enable encrypted private key storage with a KMS
        • Enable external key storage with a KMS
      • Migrate to a KMS
        • Migrate to encrypted private key storage with KMS
        • Migrate to external key storage with a KMS by exporting the key material
        • Migrate to external key storage with a KMS with asset transfer
      • Rotate keys with KMS
        • Rotate the envelope wrapper key
        • Rotate external KMS keys
  • Optimize
    • Scaling and Performance
    • Optimize Storage
    • Configure Caching
    • Configure Batching
    • Configure session keys
  • Observe
    • Participant Node Health
    • Logging
    • Configure Metrics
    • Configure Tracing
    • Monitoring with Datadog
    • Monitor ACS Commitments
    • Monitoring Best Practices
  • Operate
    • Initializing node identity manually
    • Canton Console
    • Synchronizer connections
    • High Availability Usage
    • Manage Daml packages and archives
    • Participant Node pruning
    • Party Management
    • Party replication
    • Decentralized party overview
    • Implementing Multi-Sig in Canton
    • Additional Topics
    • Managing hosting relationships
    • Ledger API User Management
    • Node Traffic Management
    • Identity Management
  • Upgrade
  • Decommission
  • Recover
    • Repair procedures
    • Backup and Restore
    • Database Replication for Disaster Recovery
  • Troubleshoot
    • Troubleshooting Guide
    • Canton Frequently Asked Questions
    • Troubleshoot ACS Commitments
    • Troubleshoot TLS
• Explanations
  • Participant Architecture
  • Overview
  • Active-Passive Participant Node Configuration
  • Security & Key Management
  • Repairing Participant Nodes
• Reference
  • Error Codes
  • Console Commands
  • Versioning
  • Supported Cryptographic Schemes And Formats
  • Metrics
  • Automatic Pruning