datawookie/ib-gateway repository overview

⁠Interactive Brokers Gateway Docker

A Docker image to run the Interactive Brokers Gateway.

⁠Components

The images consists of the following components:

• IB Gateway
• IBC⁠ — Interaction with the IB Gateway application.
• Xvfb — X11 virtual framebuffer to enable GUI application on headless device.
• x11vnc — VNC server for remote access to IB Gateway GUI.

⁠Configuration

Create an environment file, .env, with the following fields:

TWS_USERID=
TWS_PASSWORD=
TRADING_MODE=
VNC_SERVER_PASSWORD=

The value for TRADING_MODE should be live or paper.

⁠Running

docker run --env-file .env --rm --name ib-gateway --network host datawookie/ib-gateway:1016.1h

The image version (or tag) is the same as the Gateway version.

Exposed ports:

⁠Security Considerations

The connection to the Interactive Brokers API is mediated by the Gateway. Authentication happens via the Gateway too. This means that any client which has access to the Gateway is able to communicate via the API using the authenticated account. 🚨 It is therefore paramount to ensure that access to the Gateway is suitably secured.

⁠Releases

The release files are large, so they are not included in the repository, but handled instead using Git Large File Storage (LFS).

Adding new files:

git lfs track releases/ibgateway-981.3o-standalone-linux-x64.sh
git add releases/ibgateway-981.3o-standalone-linux-x64.sh

Downloading releases:

# Stable version
wget https://download.interactivebrokers.com/installers/ibgateway/stable-standalone/ibgateway-stable-standalone-linux-x64.sh
# Latest version
wget https://download.interactivebrokers.com/installers/ibgateway/latest-standalone/ibgateway-latest-standalone-linux-x64.sh

To discover the version, just start running the installer and look at the version number at the top of the installer dialog.

When getting a new release you need to update the version number in latest-version.txt.