.env.example

# xchain-node configuration - copy to .env and fill in values.
# CLI tool that installs and manages the other XChain services as Docker
# containers. Most variables are optional overrides; sane defaults relative to
# the install directory are used when unset.

# Optional: container/name prefix for managed services (default "xchain-node").
# NODE_PREFIX=xchain-node

# --- Directory overrides (optional; default to paths under the install dir) ---
# XCHAIN_NODE_DATA_DIR=
# XCHAIN_NODE_CONFIG_DIR=
# XCHAIN_NODE_MODULES_DIR=
# XCHAIN_NODE_CRYPTO_NODES_DIR=
# XCHAIN_NODE_TMP_DIR=
# XCHAIN_NODE_BLOCKS_DIR=

# Optional: JSON map overriding the download URLs for service modules.
# XCHAIN_NODE_MODULES_URLS_OVERRIDE={}

# --- Database -----------------------------------------------------------------
# Optional: root password for the node-managed MariaDB container.
# XCHAIN_NODE_DB_ROOT_PASSWORD=your-db-root-password-here

# Optional: use an external MariaDB instead of the managed container.
# Set XCHAIN_NODE_EXTERNAL_DB=1 to enable, then supply the connection below.
# XCHAIN_NODE_EXTERNAL_DB=0
# XCHAIN_NODE_EXTERNAL_DB_HOST=127.0.0.1
# XCHAIN_NODE_EXTERNAL_DB_PORT=3306
# XCHAIN_NODE_EXTERNAL_DB_ROOT_USER=root
# XCHAIN_NODE_EXTERNAL_DB_ROOT_PASSWORD=your-db-root-password-here

# --- Telemetry (anonymous, opt-out) -------------------------------------------
# Anonymous node-operator telemetry is on by default. Opt out with the flag
# below (or pass --no-telemetry). No secrets, wallet, or config are ever sent.
# XCHAIN_NODE_NO_TELEMETRY=
# Optional: override the telemetry collector URL.
# XCHAIN_NODE_TELEMETRY_URL=

# Optional: telemetry defaults written into a managed hub's config. Only
# relevant when this node provisions an xchain-hub container.
# TELEMETRY_ENABLED=true
# TELEMETRY_RETENTION_DAYS=90
# TELEMETRY_IP_SALT=