Repository files navigation

This repository contains a Dockerized version of the Interactive Brokers Client Portal Web API Gateway. It provides a containerized solution for running the IB Gateway, making it easier to deploy and manage in various environments.

• Dockerized IB Gateway
• Multi-architecture support (amd64/arm64)
• Automated builds via GitHub Actions
• Volume mounting for configuration
• Easy deployment with Docker Compose

• Docker
• Docker Compose
• Interactive Brokers account

1. Clone this repository:

git clone https://github.com/petercool/ib-cp-gateway-docker.gitcd ib-cp-gateway-docker

2. Start the container:

docker compose up -d

The gateway will be available athttp://localhost:8000

The gateway configuration is managed throughroot/conf.yaml. Mount this file as a volume to customize the settings:

# Example configuration in docker-compose.ymlvolumes:  -./ib_cp_gateway/root:/app/root

To build the Docker image locally:

docker compose build

No environment variables are required for basic operation. All configuration is handled through theconf.yaml file.

• The gateway runs on port 8000 by default
• Consider implementing additional security measures when deploying to production
• Follow IB's security best practices for API usage

To format the OpenAPI documentation in a more readable way, you can use the following command:

yqeval -P ./docs/openapi.yml> ./docs/openapi.pretty.yml

This command creates a prettified version of the OpenAPI specification.

This project is licensed under the MIT License - see the LICENSE file for details.

• Interactive Brokers for providing the Client Portal Web API
• Docker for containerization support
• GitHub Actions for CI/CD capabilities