Environment Variables

Canton Deploy supports the following environment variables:

Variable	Purpose
`CANTON_DEPLOY_NETWORK`	Default `--network`
`CANTON_DEPLOY_HOST`	Override `host`
`CANTON_DEPLOY_ADMIN_PORT` / `CANTON_DEPLOY_LEDGER_PORT` / `CANTON_DEPLOY_HTTP_PORT`	Ports
`CANTON_DEPLOY_TOKEN`	JWT
`CANTON_DEPLOY_HTTP_HOST` / `CANTON_DEPLOY_GRPC_AUTHORITY` / `CANTON_DEPLOY_ADMIN_GRPC_AUTHORITY`	Proxy name overrides
`CANTON_DEPLOY_HTTP_USE_TLS`	`true` / `false`
`CANTON_DEPLOY_CONFIG`	Path to the config file
`CANTON_DEPLOY_SCRIPT_USER_ID`	User ID for `dpm script`
`CANTON_DEPLOY_GRPC_DEADLINE_MS`	Per-RPC deadline; default `60000`
`CANTON_DEPLOY_GRPC_CONNECT_MS`	Channel-ready wait; default `180000`

Example

export CANTON_DEPLOY_NETWORK=devnet
export CANTON_DEPLOY_HOST=validator.example.com
export CANTON_DEPLOY_ADMIN_PORT=5002
export CANTON_DEPLOY_LEDGER_PORT=5011
export CANTON_DEPLOY_HTTP_PORT=8080
export CANTON_DEPLOY_TOKEN='eyJ...'

CLI flags take precedence over environment variables, and environment variables take precedence over the configuration file.

Example​

Example