gnzsnz/ib-gateway

Interactive Brokers Gateway Docker

概述

一个无需人工交互即可在Docker容器中运行Interactive Brokers Gateway应用的Docker镜像。

包含以下组件：

• IB Gateway应用（稳定版、最新版）
• https://github.com/IbcAlpha/IBC - 用于控制IB Gateway应用（模拟用户输入）。
• https://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml - X11虚拟帧缓冲区，用于在无图形硬件的环境中运行IB Gateway应用。
• https://wiki.archlinux.org/title/x11vnc - VNC服务器，允许与IB Gateway用户界面交互（可选，用于开发/维护目的）。
• socat - 接受非本地主机的TCP连接并将其转发到本地主机的IB Gateway的工具（IB Gateway默认限制仅允许127.0.0.1连接）。
• 可与https://github.com/gnzsnz/jupyter-quant Docker镜像良好配合使用。

支持的标签

本README可能未包含最新标签，但你可以随时获取https://github.com/users/gnzsnz/packages/container/ib-gateway/***?tag=stable%E5%92%8Chttps://github.com/users/gnzsnz/packages/container/ib-gateway/***?tag=latest%E4%BB%A5%E5%8F%8A%E6%89%80%E6%9C%89%E5%8F%AF%E7%94%A8https://github.com/gnzsnz/ib-gateway-docker/pkgs/container/ib-gateway/%E3%80%82

使用方法

创建docker-compose.yml（或将ib-gateway服务添加到现有文件中）

yaml
version: "3.4"

services:
  ib-gateway:
    image: ***-ghcr.xuanyuan.run/gnzsnz/ib-gateway:latest
    restart: always
    environment:
      TWS_USERID: ${TWS_USERID}
      TWS_PASSWORD: ${TWS_PASSWORD}
      TRADING_MODE: ${TRADING_MODE:-live}
      VNC_SERVER_PASSWORD: ${VNC_SERVER_PASSWORD:-}
      READ_ONLY_API: ${READ_ONLY_API:-}
      TWOFA_TIMEOUT_ACTION: ${TWOFA_TIMEOUT_ACTION:-exit}
      AUTO_RESTART_TIME: ${AUTO_RESTART_TIME:-}
      RELOGIN_AFTER_TWOFA_TIMEOUT: ${RELOGIN_AFTER_TWOFA_TIMEOUT:-no}
      TWOFA_EXIT_INTERVAL: ${TWOFA_EXIT_INTERVAL:-60}
      TIME_ZONE: ${TIME_ZONE:-Etc/UTC}
    ports:
      - "127.0.0.1:4001:4001"
      - "127.0.0.1:4002:4002"
      - "127.0.0.1:5900:5900"

在根目录创建.env文件或设置以下环境变量：

.env文件示例：

text
TWS_USERID=myTwsAccountName
TWS_PASSWORD=myTwsPassword
TRADING_MODE=paper
READ_ONLY_API=no
VNC_SERVER_PASSWORD=myVncPassword
TWOFA_TIMEOUT_ACTION=restart
AUTO_RESTART_TIME=11:59 PM
RELOGIN_AFTER_2FA_TIMEOUT=yes
TIME_ZONE=Europe/Lisbon

运行：

$ docker-compose up

镜像下载完成、容器启动后约30秒，容器和Docker主机上的以下端口将准备就绪：

注意：上述docker-compose.yml中，端口仅暴露给Docker主机的本地（127.0.0.1），而非主机网络。若要暴露给整个网络，请相应修改端口映射（移除'127.0.0.1:'）。** 注意 **：参见离开本地主机

本地构建方法

1. 克隆仓库

   bash
   git clone https://github.com/gnzsnz/ib-gateway-docker
   

2. 修改Dockerfile，使用本地IB Gateway安装文件而非从项目发布版加载：在编辑器中打开Dockerfile，将以下行替换：

   docker
   RUN curl -sSL https://github.com/gnzsnz/ib-gateway-docker/raw/gh-pages/ibgateway-releases/ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh \
       --output ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh
   RUN curl -sSL https://github.com/gnzsnz/ib-gateway-docker/raw/gh-pages/ibgateway-releases/ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh.sha256 \
       --output ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh.sha256
   

   替换为

   docker
   COPY ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh
   

3. 从Dockerfile中移除RUN sha256sum --check ./ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh.sha256（除非需要保留校验和检查）

4. 下载IB Gateway并命名为ibgateway-{IB_GATEWAY_VERSION}-standalone-linux-x64.sh，其中{IB_GATEWAY_VERSION}必须与Dockerfile（第一行）中配置的版本匹配

5. 下载IBC并命名为IBCLinux-{IBC_VERSION}.zip，其中{IBC_VERSION}必须与Dockerfile（第二行）中配置的版本匹配

6. 构建并运行：docker-compose up --build

版本和标签

Docker镜像版本与镜像中的IB Gateway版本对应。参见支持的标签

IB Gateway安装文件

注意https://github.com/gnzsnz/ib-gateway-docker/blob/master/Dockerfile** 不会 **从IB官网下载IB Gateway安装文件，而是从本项目的https://github.com/gnzsnz/ib-gateway-docker/tree/gh-pages/ibgateway-releases%E4%B8%8B%E8%BD%BD%E3%80%82

这是因为需要能够（重新）构建特定Gateway版本的镜像，而IB仅提供latest或stable版本的下载链接（无“旧版本”下载归档）。

存储在https://github.com/gnzsnz/ib-gateway-docker/tree/gh-pages/ibgateway-releases%E4%B8%AD%E7%9A%84%E5%AE%89%E8%A3%85%E6%96%87%E4%BB%B6%E5%B7%B2%E4%BB%8EIB%E5%AE%98%E7%BD%91%E4%B8%8B%E8%BD%BD%E5%B9%B6%E6%9B%B4%E5%90%8D%E4%BB%A5%E5%8F%8D%E6%98%A0%E7%89%88%E6%9C%AC%E3%80%82

若要直接从IB官网下载Gateway安装文件或使用本地安装文件，修改https://github.com/gnzsnz/ib-gateway-docker/blob/master/Dockerfile%E4%B8%AD%E7%9A%84%E4%BB%A5%E4%B8%8B%E8%A1%8C%EF%BC%9A%60RUN curl -sSL https://github.com/gnzsnz/ib-gateway-docker/raw/gh-pages/ibgateway-releases/ibgateway-$%7BIB_GATEWAY_VERSION%7D-standalone-linux-x64.sh --output ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh** 示例 **：改为RUN curl -sSL https://download2.interactivebrokers.com/installers/ibgateway/stable-standalone/ibgateway-stable-standalone-linux-x64.sh --output ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh`以使用IB官网当前稳定版。

自定义镜像

可通过用自定义配置文件覆盖默认配置文件来自定义镜像。

应用和配置文件位置：

要启动IB Gateway，从Dockerfile或运行脚本中执行/root/scripts/run.sh。

安全考虑

离开本地主机

IB API协议基于客户端与IB Gateway之间未加密、未认证的原始TCP套接字连接。若IB API端口对网络开放，则网络中的所有设备（包括潜在***设备）均可通过IB Gateway访问你的IB账户。

因此，默认docker-compose.yml仅将IB API端口暴露给Docker主机的**本地主机 **，而非整个网络。

若要从远程设备连接IB Gateway，考虑添加额外安全层（如TLS/SSL或SSH隧道）以保护“明文”TCP套接字免受未授权访问或篡改。

凭据

本镜像不包含也不存储任何用户凭据。

凭据在容器启动时通过环境变量提供，主机负责妥善保护（例如使用https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-environment-variables%E7%AD%89%EF%BC%89%E3%80%82