Merge pull request #2 from petercool/iss-1

[Iss-1][Feature] Implement containerisation of ib-cp-gateway

Author: petercool

.github/workflows/docker-ci.yml

@@ -0,0 +1,41 @@
+name: Docker CI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ secrets.DOCKER_HUB_USERNAME }}/ib-gateway
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release-pleases.yml

@@ -0,0 +1,21 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        with:
+          release-type: node
+          package-name: ib-gateway
+          token: ${{ secrets.RELEASE_GITHUB_TOKEN }}

.gitignore

@@ -22,3 +22,8 @@
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 replay_pid*
+
+.idea/
+.vscode/
+.DS_Store
+.aider*

Dockerfile

@@ -0,0 +1,15 @@
+FROM openjdk:8-jdk
+
+WORKDIR /app
+
+# Copy the entire ib_cp_gateway directory
+COPY ib_cp_gateway/ .
+
+# Make the run script executable
+RUN chmod +x bin/run.sh
+
+# Expose port 8000
+EXPOSE 8000
+
+# Set the entrypoint
+ENTRYPOINT ["./bin/run.sh", "./root/conf.yaml"]

compose.yml

@@ -0,0 +1,11 @@
+version: '3.8'
+
+services:
+  ib-gateway:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./ib_cp_gateway/root:/app/root

ib_cp_gateway/bin/run.bat

@@ -0,0 +1,25 @@
+@echo off
+
+rem example setting a JAVA_HOME and adding to PATH
+#set JAVA_HOME=c:\jdk
+#set PATH=%JAVA_HOME%\bin;%PATH%
+
+if exist %1 goto FOUND_CONF
+echo "usage: %0 /path/to/conf.yaml"
+goto END
+
+:FOUND_CONF
+set config_file=%1
+for /F %%i in ("%config_file%") do set config_path=%%~dpi
+echo "config path :%config_path%"
+
+set RUNTIME_PATH="%config_path%;dist\ibgroup.web.core.iblink.router.clientportal.gw.jar;build\lib\runtime\*"
+
+echo "running %verticle% "
+echo "runtime path : %RUNTIME_PATH%"
+
+java -server -Dvertx.disableDnsResolver=true -Djava.net.preferIPv4Stack=true -Dvertx.logger-delegate-factory-class-name=io.vertx.core.logging.SLF4JLogDelegateFactory -Dnologback.statusListenerClass=ch.qos.logback.core.status.OnConsoleStatusListener -Dnolog4j.debug=true -Dnolog4j2.debug=true -classpath %RUNTIME_PATH% ibgroup.web.core.clientportal.gw.GatewayStart
+rem optional arguments
+rem -conf conf.beta.yaml --nossl
+
+:END

ib_cp_gateway/bin/run.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# example setting a JAVA_HOME and adding to PATH
+#export JAVA_HOME=/usr/local/jdk1.8_x64/
+#export PATH=$JAVA_HOME/bin:$PATH
+
+if [ $# -lt 1 ]; then
+    >&2 echo "usage: $0 /path/to/conf.yaml"
+    exit 1
+fi
+
+config_file=$1
+config_path=$(dirname $1)
+name=$(basename $config_path)
+
+export RUNTIME_PATH="$config_path:dist/ibgroup.web.core.iblink.router.clientportal.gw.jar:build/lib/runtime/*"
+
+echo "running $verticle "
+echo " runtime path : $RUNTIME_PATH"
+echo " config file  : $config_file"
+
+java \
+-server \
+-Dvertx.disableDnsResolver=true \
+-Djava.net.preferIPv4Stack=true \
+-Dvertx.logger-delegate-factory-class-name=io.vertx.core.logging.SLF4JLogDelegateFactory \
+-Dnologback.statusListenerClass=ch.qos.logback.core.status.OnConsoleStatusListener \
+-Dnolog4j.debug=true \
+-Dnolog4j2.debug=true \
+-cp "${RUNTIME_PATH}" \
+ibgroup.web.core.clientportal.gw.GatewayStart \
+--conf ../$config_file \

ib_cp_gateway/doc/GettingStarted.md

@@ -0,0 +1,50 @@
+# Getting Started
+
+The Client Portal gateway is available for download at: [http://download2.interactivebrokers.com/portal/clientportal.gw.zip](http://download2.interactivebrokers.com/portal/clientportal.gw.zip)
+
+You can download and extract to any location your user has access to. We will install it under 
+
+C:\gateway\ in Windows or ~user\gateway in Linux.
+
+The gateway requires Java 1.8 update 192 or higher to run, and has been tested successfully with OpenJDK 11. 
+
+Oracle Java 8 download: [https://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html](https://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html)
+
+Once you extract the .zip file, you will see the following directories:
+
+- **bin** contains the run scripts for Linux and Windows
+
+- **build** contains all the 3rd party libraries required for the gateway to run
+
+- **dist** contains the .jar file for the gateway
+
+- **doc** contains this GettingStarted.md guide
+
+- **root** contains files required for the runtime configuration of the gateway and is also the location where webapps reside. We will explain those in more detail later.
+
+To start the gateway you need to open a command prompt or bash on the directory the files were extracted. In our case we will open windows -> run -> cmd and go to c:\gateway\.
+
+Once in that directory you can run *"bin\run.sh root/conf.yaml"* or *"bin\run.bat root\conf.yaml"*
+
+Once the gateway is running, you should see the following entry in the console:
+"Server listening on port 5000" 
+By default the gateway runs in SSL mode and port 5000. 
+
+Now that the gateway is running, you are ready to authenticate, to do that open your browser and go to:
+[https://localhost:5000/](https://localhost:5000/)
+
+In this page you should see our regular login page which is also visible here:
+[https://gdcdyn.interactivebrokers.com/sso/Login?forwardTo=22](https://gdcdyn.interactivebrokers.com/sso/Login?forwardTo=22)
+
+Once you login, the gateway will confirm the client is authenticated and is ok to close the browser window. Or will display any reasons why the authentication may have failed.
+
+Once the gateway is authenticated you can close the browser or navigate away.
+
+From this point on, the end points documented in the API spec should be available for you to query with curl or any other HTTP client.
+
+[https://gdcdyn.interactivebrokers.com/portal.proxy/v1/portal/swagger/swagger?format=yaml](https://gdcdyn.interactivebrokers.com/portal.proxy/v1/portal/swagger/swagger?format=yaml)
+
+[https://rebilly.github.io/ReDoc/?url=https://rebilly.github.io/ReDoc/?url=https://gdcdyn.interactivebrokers.com/portal.proxy/v1/portal/swagger/swagger?format=yaml](https://rebilly.github.io/ReDoc/?url=https://rebilly.github.io/ReDoc/?url=https://gdcdyn.interactivebrokers.com/portal.proxy/v1/portal/swagger/swagger?format=yaml)
+
+There is an external Client Portal API guide with test pages at: [https://interactivebrokers.github.io/cpwebapi](https://interactivebrokers.github.io/cpwebapi)
+