Build 060.30: finalize Market Data Acquisition documentation

app/.env.example

@@ -1,29 +1,48 @@
+# Настройки приложения. Файл является примером: не храните здесь
+# реальные секреты. Для каждого секрета задайте либо прямое значение,
+# либо *_FILE, но не оба. *_FILE должен указывать на доступный для чтения
+# UTF-8 файл с одним секретом.
+
+# Telegram и приложение
 BOT_TOKEN=PUT_YOUR_TELEGRAM_BOT_TOKEN_HERE
+# BOT_TOKEN_FILE=/run/secrets/bot_token
 BOT_PARSE_MODE=HTML
 APP_ENV=dev
 LOG_LEVEL=INFO
 TZ=Europe/Minsk
+DEBUG_ENABLED=false
+JOURNAL_DEBUG_ENABLED=false
+# Только для контейнера с отдельным runtime-файлом, доступным для записи:
+# DZENTRA_RUNTIME_ENV_FILE=/var/lib/dzentra/runtime.env
 
+# PostgreSQL
 DB_HOST=localhost
 DB_PORT=5432
 DB_NAME=dzentra_bot
 DB_USER=dzentra_bot
-DB_PASSWORD=change_me
+DB_PASSWORD=PUT_YOUR_DATABASE_PASSWORD_HERE
+# DB_PASSWORD_FILE=/run/secrets/db_password
 
+# Постоянное хранилище Market Data
 MARKET_DATA_STORAGE_ENABLED=false
 MARKET_DATA_STORAGE_POOL_MIN_SIZE=1
 MARKET_DATA_STORAGE_POOL_MAX_SIZE=4
 MARKET_DATA_STORAGE_POOL_TIMEOUT_SECONDS=10
 
-EXCHANGE_ENABLED=true
+# Биржа. Безопасный пример совпадает с выключенными значениями по умолчанию.
+EXCHANGE_ENABLED=false
 EXCHANGE_NAME=dzengi
-EXCHANGE_BASE_URL=https://demo-api-adapter.dzengi.com
+EXCHANGE_BASE_URL=
+EXCHANGE_WS_URL=
 EXCHANGE_API_KEY=
+# EXCHANGE_API_KEY_FILE=/run/secrets/exchange_api_key
 EXCHANGE_API_SECRET=
+# EXCHANGE_API_SECRET_FILE=/run/secrets/exchange_api_secret
 EXCHANGE_TIMEOUT_SEC=10
-EXCHANGE_TESTNET=true
-DEFAULT_SYMBOL=BTC/USD_LEVERAGE
+EXCHANGE_TESTNET=false
+DEFAULT_SYMBOL=ETH/USD_LEVERAGE
 
+# Поток сделок Production Trade Stream
 TRADE_STREAM_ENABLED=false
 TRADE_STREAM_WS_URL=
 TRADE_STREAM_SYMBOLS=
@@ -35,3 +54,20 @@ TRADE_STREAM_SCHEDULER_INTERVAL_SECONDS=5
 TRADE_STREAM_RECOVERY_WINDOW_MS=3599999
 TRADE_STREAM_SUBSCRIPTION_ACK_TIMEOUT_SECONDS=10
 TRADE_STREAM_STARTUP_MARKET_BUFFER_CAPACITY=10000
+
+# Управляющие переменные Docker Compose передаются самому Compose,
+# а не сохраняются в app/.env. Пути должны вести к защищённым файлам
+# вне repository; BOT_STOP_GRACE_PERIOD задаётся после расчёта бюджета.
+# Каталог файлов с секретами: mode 0700; сами файлы: mode 0444.
+# DZENTRA_COMPOSE_PROJECT_NAME=dzentra-production
+# DZENTRA_BOT_IMAGE=dzentra-bot:local
+# DZENTRA_POSTGRES_IMAGE=dzentra-postgres:16.14-hardened
+# BOT_TOKEN_SECRET_FILE=/absolute/protected/dzentra/bot_token
+# POSTGRES_ADMIN_PASSWORD_SECRET_FILE=/absolute/protected/dzentra/postgres_admin_password
+# DB_PASSWORD_SECRET_FILE=/absolute/protected/dzentra/db_password
+# POSTGRES_ADMIN_USER=dzentra_admin
+# BOT_STOP_GRACE_PERIOD=30m
+# POSTGRES_STOP_GRACE_PERIOD=60s
+# Только с infra/compose/docker-compose.exchange-auth.yml:
+# EXCHANGE_API_KEY_SOURCE_FILE=/absolute/protected/dzentra/exchange_api_key
+# EXCHANGE_API_SECRET_SOURCE_FILE=/absolute/protected/dzentra/exchange_api_secret