Configuration

Complete reference for the .env file used to configure your Trade Beam local bot.

Example .env File

# Required
DERIBIT_API_KEY=your_api_key_here
DERIBIT_API_SECRET=your_api_secret_here

# Optional overrides
# SUBSCRIPTION_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
# DEPLOYMENT_MODE=local
# INSTRUMENT=BTC-PERPETUAL
# LOG_LEVEL=info

Subscription

Identifies your bot instance with the Trade Beam platform.

SUBSCRIPTION_UUIDRequired

Your unique bot instance identifier from FM Portal. Pre-filled in the downloaded docker-compose.yml. Used to sync configuration and report status to the platform.

Deribit API

Credentials for connecting to the Deribit exchange. Create these at deribit.com (or test.deribit.com for testnet).

DERIBIT_API_KEYRequired

Your Deribit API key. Must have trade and read permissions enabled.

DERIBIT_API_SECRETRequired

Your Deribit API secret. Keep this value private.

Deployment

Controls how and where the bot operates.

DEPLOYMENT_MODEOptionalDefault: local

Set to "local" for running on your own machine, or "cloud" for managed cloud deployment. Local mode uses the bundled Redis container.

BOT_IDOptionalDefault: (auto-generated)

A unique identifier for this bot instance. Auto-generated from SUBSCRIPTION_UUID if not set. Useful when running multiple bots on the same machine.

Trading

Instrument and strategy settings.

INSTRUMENTOptionalDefault: BTC-PERPETUAL

The Deribit instrument to trade. Common values: BTC-PERPETUAL, ETH-PERPETUAL. Must match the instrument configured in FM Portal.

Logging

Controls log verbosity for debugging.

LOG_LEVELOptionalDefault: info

Log verbosity level. Options: "debug", "info", "warn", "error". Use "debug" to see detailed order placement and fill information.

Redis

Local cache settings. A Redis container is bundled in docker-compose.yml, so these usually do not need changing.

REDIS_HOSTOptionalDefault: redis

Redis hostname. Defaults to the bundled Redis container name.

REDIS_PORTOptionalDefault: 6379

Redis port number.

REDIS_PASSWORDOptionalDefault: (empty)

Redis password. The bundled Redis instance runs without authentication by default.

Tips

  • Use LOG_LEVEL=debug when first setting up to see detailed connection and order information.
  • Test with test.deribit.com API keys first to verify your setup without risking real funds.
  • After changing .env, restart the bot with docker compose restart for changes to take effect.