Interactive Brokers Gateway Docker

This is the home of the waytrade/ib-gateway images.

What is it?

A docker image to run the Interactive Brokers Gateway Application without any human interaction on a docker container.

It includes:

IB Gateway Application
IBC Application - to control the IB Gateway Application (simulates user input).
Xvfb - a X11 virtual framebuffer to run IB Gateway Application without graphics hardware.
x11vnc - a VNC server that allows to interact with the IB Gateway user interface (optional, for development / maintenance purpose).
socat a tool to accept TCP connection from non-localhost and relay it to IB Gateway from localhost (IB Gateway restricts connections to 127.0.0.1 by default).

How to use?

Create a docker-compose.yml (or include ib-gateway services on your existing one)

version: "3.4"

services:
  ib-gateway:
    image: waytrade/ib-gateway:1012.2c
    restart: always
    environment:
      TWS_USERID: ${TWS_USERID}
      TWS_PASSWORD: ${TWS_PASSWORD}
      TRADING_MODE: ${TRADING_MODE:-live}
      VNC_SERVER_PASSWORD: ${VNC_SERVER_PASSWORD:-}
    ports:
      - "127.0.0.1:4001:4001"
      - "127.0.0.1:4002:4002"
      - "127.0.0.1:5900:5900"

Create an .env on root directory or set the following environment variables:

Varabiel	Description	Default
TWS_USERID	The TWS user name.
TWS_PASSWORD	The TWS password.
TRADING_MODE	'live' or 'paper'	paper
VNC_SERVER_PASSWORD	VNC server password. If not defined, no VNC server will be started.	not defined (VNC disabled)

Example .env file:

TWS_USERID=myTwsAccountName
TWS_PASSWORD=myTwsPassword
TRADING_MODE=paper
VNC_SERVER_PASSWORD=myVncPassword

Run:

$ docker-compose up

After image is downloaded, container is started + 30s, the following ports will be ready for usage on the container and docker host:

Port	Description
4001	TWS API port for live accounts.
4002	TWS API port for paper accounts.
5900	When VNC_SERVER_PASSWORD was defined, the VNC server port.

Note that with the above docker-compose.yml, ports are only exposed to the docker host (127.0.0.1), but not to the network of the host. To expose it to the whole network change the port mappings on accordingly (remove the '127.0.0.1:'). Attention: See Leaving localhost

Versions and Tags

The docker image version is similar to the IB Gateway version on the image.

See Supported tags

IB Gateway installation files

Note that the Dockerfile does not download IB Gateway installer files from IB homepage but from the releases of this project.

This is because it shall be possible to (re-)build the image, targeting a specific Gateway version, but IB does only provide donwload links for the 'latest' or 'stable' version (there is no 'old version' donwload archive).
The installer files stored on releases have been donwloaded from IB homepage and renamed to refelect the version.
If you want to download Gateway installer from IB homepage directly, or use your local installation file, change this line on Dockerfile RUN curl -sSL https://github.com/waytrade/ib-gateway-docker/releases/download/v${IB_GATEWAY_VERSION}/ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh --output ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh to download (or copy) the file from the source you prefer.
Example: change to 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 for using current stable version from IB homepage.

Customizing the image

The image can be customized by overwiting the default configuration files with custom ones.

Apps and config file locations:

App	Folder	Config file	Default
IB Gateway	/root/Jts	/root/Jts/jts.ini	jts.ini
IBC	/root/ibc	/root/ibc/config.ini	config.ini

To start the IB Gateway run /root/scripts/run.sh from your Dockerfile or run-script.

Security Considerations

Leaving localhost

The IB API protocol is based on an unencrypted, unauthenticated, raw TCP socket connection between a client and the IB Gateway. If the port to IB API is open to the network, every device on it (including potential rogue devices) can access your IB account via the IB Gateway.
Because of this, the default docker-compose.yml only exposes the IB API port to the localhost on the docker host, but not to the whole network.
If you want to connect to IB Gateway from a remote device, consider adding an additional layer of security (e.g. TLS/SSL or SSH tunnel) to protect the 'plain text' TCP sockets against unauthorized access or manipulation.

Credentials

This image does not contain nor store any user credentials.
They are provided as environment variable during the container startup and the host is responsible to properly protect it (e.g. use Kubernetes Secrets or similar).

Supported Tags

Tag	IB Gateway Version	IB Gateway Release Channel	IBC Version
1012.2c	10.12.2c	latest	3.12.0
981.3g	981.3g	stable	3.12.0
1010	10.10	latest	3.10.0
981	981c	stable	3.10.0

electic/ib-gateway-docker