diff --git a/build_helpers/schema.json b/build_helpers/schema.json index 739d7bb56..542c336a5 100644 --- a/build_helpers/schema.json +++ b/build_helpers/schema.json @@ -1169,34 +1169,34 @@ "type": "string" }, "key": { - "description": "API key for the exchange.", + "description": "API key for the exchange. Recommended to be set via environment variable FREQTRADE__EXCHANGE__KEY", "type": "string", "default": "" }, "secret": { - "description": "API secret for the exchange.", + "description": "API secret for the exchange. Recommended to be set via environment variable FREQTRADE__EXCHANGE__SECRET", "type": "string", "default": "" }, "password": { - "description": "Password for the exchange, if required.", + "description": "Password for the exchange, if required. Recommended to be set via environment variable FREQTRADE__EXCHANGE__PASSWORD", "type": "string", "default": "" }, "uid": { - "description": "User ID for the exchange, if required.", + "description": "User ID for the exchange, if required. Recommended to be set via environment variable FREQTRADE__EXCHANGE__UID", "type": "string" }, "account_id": { - "description": "Account ID for the exchange, if required.", + "description": "Account ID for the exchange, if required. Recommended to be set via environment variable FREQTRADE__EXCHANGE__ACCOUNT_ID", "type": "string" }, "wallet_address": { - "description": "Wallet address for the exchange, if required. Usually used by DEX exchanges.", + "description": "Wallet address for the exchange, if required. Usually used by DEX exchanges. Recommended to be set via environment variable FREQTRADE__EXCHANGE__WALLET_ADDRESS", "type": "string" }, "private_key": { - "description": "Private key for the exchange, if required. Usually used by DEX exchanges.", + "description": "Private key for the exchange, if required. Usually used by DEX exchanges. Recommended to be set via environment variable FREQTRADE__EXCHANGE__PRIVATE_KEY", "type": "string" }, "pair_whitelist": { diff --git a/freqtrade/config_schema/config_schema.py b/freqtrade/config_schema/config_schema.py index 4c16bc661..5e06b03f0 100644 --- a/freqtrade/config_schema/config_schema.py +++ b/freqtrade/config_schema/config_schema.py @@ -26,6 +26,8 @@ __MESSAGE_TYPE_DICT: dict[str, dict[str, str]] = {x: {"type": "object"} for x in __IN_STRATEGY = "\nUsually specified in the strategy and missing in the configuration." +__VIA_ENV = "Recommended to be set via environment variable" + CONF_SCHEMA = { "type": "object", "properties": { @@ -807,35 +809,53 @@ CONF_SCHEMA = { "properties": { "name": {"description": "Name of the exchange.", "type": "string"}, "key": { - "description": "API key for the exchange.", + "description": ( + f"API key for the exchange. {__VIA_ENV} FREQTRADE__EXCHANGE__KEY" + ), "type": "string", "default": "", }, "secret": { - "description": "API secret for the exchange.", + "description": ( + f"API secret for the exchange. {__VIA_ENV} FREQTRADE__EXCHANGE__SECRET" + ), "type": "string", "default": "", }, "password": { - "description": "Password for the exchange, if required.", + "description": ( + "Password for the exchange, if required. " + f"{__VIA_ENV} FREQTRADE__EXCHANGE__PASSWORD" + ), "type": "string", "default": "", }, - "uid": {"description": "User ID for the exchange, if required.", "type": "string"}, + "uid": { + "description": ( + "User ID for the exchange, if required. " + f"{__VIA_ENV} FREQTRADE__EXCHANGE__UID" + ), + "type": "string", + }, "account_id": { - "description": "Account ID for the exchange, if required.", + "description": ( + "Account ID for the exchange, if required. " + f"{__VIA_ENV} FREQTRADE__EXCHANGE__ACCOUNT_ID" + ), "type": "string", }, "wallet_address": { "description": ( "Wallet address for the exchange, if required. " - "Usually used by DEX exchanges." + "Usually used by DEX exchanges. " + f"{__VIA_ENV} FREQTRADE__EXCHANGE__WALLET_ADDRESS" ), "type": "string", }, "private_key": { "description": ( - "Private key for the exchange, if required. Usually used by DEX exchanges." + "Private key for the exchange, if required. Usually used by DEX exchanges. " + f"{__VIA_ENV} FREQTRADE__EXCHANGE__PRIVATE_KEY" ), "type": "string", },