ibctl/.env.example at develop · Lcstyle/ibctl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# ibctl environment configuration
# Copy to .env and fill in your credentials.
# NEVER commit .env to version control.

# Authentication
TWS_USERID=your_username
TWS_PASSWORD=your_password
TRADING_MODE=paper                # live | paper | both

# Paper mode (only needed for TRADING_MODE=both)
TWS_USERID_PAPER=your_paper_username
TWS_PASSWORD_PAPER=your_paper_password

# Two-factor authentication
TWOFA_DEVICE=IB Key               # or "Mobile Authenticator app"
TWOFA_TIMEOUT_ACTION=restart       # restart | exit
TWOFA_EXIT_INTERVAL=120
RELOGIN_AFTER_TWOFA_TIMEOUT=yes

# Session
EXISTING_SESSION_DETECTED_ACTION=primary

# API configuration (applied after login)
TWS_ACCEPT_INCOMING=accept
TWS_MASTER_CLIENT_ID=50
READ_ONLY_API=no
BYPASS_WARNING=yes
ALLOW_BLIND_TRADING=no

# Scheduling
AUTO_RESTART_TIME=05:05 PM
TWS_COLD_RESTART=09:00

# Gateway
JAVA_HEAP_SIZE=768
TZ=America/New_York

# VNC (optional — set password to enable)
VNC_SERVER_PASSWORD=

# Logging
RUST_LOG=ibctl=info

# Command server (required for dashboard)
IBCTL_COMMAND_SERVER_ENABLED=false

# Dashboard (disabled by default)
IBCTL_DASHBOARD_ENABLED=false
IBCTL_DASHBOARD_PORT=8080
# IBCTL_DASHBOARD_TOKEN=               # set for password auth
# IBCTL_DASHBOARD_AUTH_SECRET=          # signing key for cookies (auto-derived if empty)
# IBCTL_ROOT_PATH=                      # URL prefix if behind reverse proxy (e.g. /ibctl)

# Dashboard Auth: GitHub OAuth (optional)
# IBCTL_GITHUB_OAUTH_ENABLED=false
# IBCTL_GITHUB_OAUTH_CLIENT_ID=
# IBCTL_GITHUB_OAUTH_CLIENT_SECRET=
# IBCTL_GITHUB_OAUTH_ALLOWED_USERS=     # comma-separated GitHub usernames
# IBCTL_GITHUB_OAUTH_ALLOWED_ORGS=      # comma-separated GitHub org names

# Dashboard Auth: OIDC/SSO (Authentik, Keycloak — optional)
# IBCTL_OIDC_ENABLED=false
# IBCTL_OIDC_ISSUER=                    # e.g. https://auth.example.com/application/o/ibctl/
# IBCTL_OIDC_CLIENT_ID=
# IBCTL_OIDC_CLIENT_SECRET=
# IBCTL_OIDC_ALLOWED_USERS=             # comma-separated usernames
# IBCTL_OIDC_ALLOWED_GROUPS=            # comma-separated group names

# Notifications (disabled by default)
IBCTL_NOTIFICATIONS_ENABLED=false
# IBCTL_NOTIFICATION_CHANNEL=ntfy       # ntfy | slack | telegram
# IBCTL_NTFY_URL=https://ntfy.sh
# IBCTL_NTFY_TOPIC=ibctl
# IBCTL_NTFY_TOKEN=
# IBCTL_SLACK_WEBHOOK_URL=
# IBCTL_TELEGRAM_BOT_TOKEN=
# IBCTL_TELEGRAM_CHAT_ID=