User Manual

This manual covers all aspects of installing, configuring, and operating Canton nodes to support distributed applications. This includes both universally available features and features available only through Daml Enterprise.

• Obtaining Canton
  • Choosing Open-Source or Enterprise Edition
  • Downloading the Open Source Edition
  • Downloading the Enterprise Edition
• Installing Canton
  • Downloading Canton
  • Your Topology
  • Environment Variables
  • Selecting your Storage Layer
  • Setting up a Participant
  • Setting up a Domain
  • Multi-Node Setup
• Upgrading
  • Upgrade Canton Binary
  • Change the Canton Protocol Version
• Running in Docker
  • Obtaining the Docker Images
  • Starting Canton
  • Configuring Logging
  • Supplying custom configuration and DARs
  • Exposing the ledger-api to the host machine
  • Running Postgres in Docker
• Static Configuration
  • Configuration reference
  • Configuration Compatibility
  • Advanced Configurations
  • Configuration Mixin
  • Multiple Domains
  • Fail Fast Mode
  • Init Configuration
• Persistence
  • Postgres
  • Oracle
  • General Settings
  • Backup and Restore
  • Database Failover
• Api Configuration
  • Default Ports
  • Administration API
  • TLS Configuration
  • Keep Alive
  • Max Inbound Message Size
  • Participant Configuration
  • Domain Configurations
  • Limiting concurrent GRPC requests (preview feature)
• Command-line Arguments
  • Selecting a Configuration
  • Run Modes
  • Flush Log Files Immediately
  • Java Virtual Machine Arguments
• Canton Console
  • Remote Administration
  • Node References
  • Help
  • Lifecycle Operations
  • Timeouts
  • Code-Generation in Console
• Sequencer Connections
  • Participant Connections
  • Mediator and Domain Manager
• Manage Dars and Packages
  • Uploading DARs
  • Inspecting DARs and Packages
  • Understanding Package Vetting
  • Removing Packages and DARs
• Identity Management
  • Introduction
  • User Identity Management
  • Cookbook
• Security
  • Cryptographic Key Usage
  • Cryptographic Key Management
  • Ledger-API Authorization
• Enterprise Drivers
  • Oracle Domain
  • Trusted Enclave Domain (CCF)
  • Fabric Domain
  • Ethereum Domain
• Manage Domains
  • Permissioned Domains
  • Domain Rules
  • Dynamic domain parameters
• Manage Domain Entities
  • Setting up a Distributed Domain With a Single Console
  • Setting up a Distributed Domain With Separate Consoles
  • Adding new sequencers to distributed domain
• High Availability Usage
  • Overview
  • Domain Manager
  • HA Setup on Oracle
  • Mediator
  • Sequencer
  • Participant
• Scaling and Performance
  • Network Scaling
  • Node Scaling
  • Performance and Sizing
  • Batching
  • Storage Estimation
  • How to Setup Canton to Get Best Performance?
• Monitoring
  • Logging
  • Tracing
  • Status
  • Health Dumps
  • Health Check
  • Metrics
• Ledger Pruning
  • Pruning Ledgers in Test Environments
  • Common Notes
• Repairing Nodes
  • Preparation
  • Importing an actual Ledger
  • Recovering from a Lost Domain
  • Repairing an actual Topology
  • Clone Identity
  • Importing existing Contracts
• Versioning
  • Canton release version
  • For application developers and operators
  • For Canton participant and domain operators
• Contract Keys in Canton
  • Domains with Uniqueness Guarantees
  • Non Unique Contract Keys Mode
• Frequently Asked Questions
  • Log Messages
  • Console Commands
  • Bootstrap Scripts
  • Why is Canton complaining about my database version?
  • How do I enable unsupported features?
  • How to troubleshoot included configuration files?