feat: recommend setting secrets via environment variable

This commit is contained in:
Matthias
2025-05-20 06:53:13 +02:00
parent 3a74fc85b4
commit 1666746692
2 changed files with 34 additions and 14 deletions

View File

@@ -1169,34 +1169,34 @@
"type": "string" "type": "string"
}, },
"key": { "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", "type": "string",
"default": "" "default": ""
}, },
"secret": { "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", "type": "string",
"default": "" "default": ""
}, },
"password": { "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", "type": "string",
"default": "" "default": ""
}, },
"uid": { "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" "type": "string"
}, },
"account_id": { "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" "type": "string"
}, },
"wallet_address": { "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" "type": "string"
}, },
"private_key": { "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" "type": "string"
}, },
"pair_whitelist": { "pair_whitelist": {

View File

@@ -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." __IN_STRATEGY = "\nUsually specified in the strategy and missing in the configuration."
__VIA_ENV = "Recommended to be set via environment variable"
CONF_SCHEMA = { CONF_SCHEMA = {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -807,35 +809,53 @@ CONF_SCHEMA = {
"properties": { "properties": {
"name": {"description": "Name of the exchange.", "type": "string"}, "name": {"description": "Name of the exchange.", "type": "string"},
"key": { "key": {
"description": "API key for the exchange.", "description": (
f"API key for the exchange. {__VIA_ENV} FREQTRADE__EXCHANGE__KEY"
),
"type": "string", "type": "string",
"default": "", "default": "",
}, },
"secret": { "secret": {
"description": "API secret for the exchange.", "description": (
f"API secret for the exchange. {__VIA_ENV} FREQTRADE__EXCHANGE__SECRET"
),
"type": "string", "type": "string",
"default": "", "default": "",
}, },
"password": { "password": {
"description": "Password for the exchange, if required.", "description": (
"Password for the exchange, if required. "
f"{__VIA_ENV} FREQTRADE__EXCHANGE__PASSWORD"
),
"type": "string", "type": "string",
"default": "", "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": { "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", "type": "string",
}, },
"wallet_address": { "wallet_address": {
"description": ( "description": (
"Wallet address for the exchange, if required. " "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", "type": "string",
}, },
"private_key": { "private_key": {
"description": ( "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", "type": "string",
}, },