Release [email protected]

Signed-off-by: gnzsnz <[email protected]>

Author: gnzsnz

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,23 +7,33 @@ assignees: ''
 
 ---
 
-**Describe the bug**
+## Describe the bug
+
 A clear and concise description of what the bug is.
 
-**To Reproduce**
-Steps to reproduce the behavior.
+## To Reproduce
+
+Steps to reproduce the behavior. Please include information related to docker, ex docker run command, .env file, docker-compose.yml.
+
+Please provide the output of `docker compose config`
 
-**Expected behavior**
+## Expected behavior
 A clear and concise description of what you expected to happen.
 
-**Container logs**
+## Container logs
 If applicable, add the container logs `docker logs <CONTAINER>` or `docker-compose logs` to help explain your problem.
 
-**Versions (please complete the following information):**
+## Versions
+
+Please complete the following information:
  - OS: [e.g. Windows]
  - Docker version: [e.g. chrome, safari]
- - Image Tag (`docker --version`): [e.g. latest]
+ - Image Tag (`docker image inspect ghcr.io/gnzsnz/ib-gateway:tag`): [e.g. latest]
  - Image Digest (`docker images --digests`): [e.g. sha256:60d9d54009b1b66908bbca1ebf5b8a03a39fe0cb35c2ab4023f6e41b55d17894] 
 
-**Additional context**
+## Additional context
 Add any other context about the problem here.
+
+What have you tried and failed.
+
+My primary objective is to fix any bug on the container, ex Dockerfile, run.sh script, docker-compose.yml. Please don't expect upstream issues to be solved here (ex. IB gateway, IBC, etc)

.gitignore

@@ -1,2 +1,3 @@
 /.env
 tws_settings/
+ssh/

Dockerfile.template

@@ -1,10 +1,9 @@
-
-#
+##############################################################################
 # Setup Stage: install apps
 #
 # This is a dedicated stage so that donwload archives don't end up on 
 # production image and consume unnecessary space.
-#
+##############################################################################
 
 FROM ubuntu:22.04 as setup
 
@@ -20,6 +19,8 @@ RUN apt-get update -y && \
   curl \
   ca-certificates \
   unzip && \
+  apt-get clean && \
+  rm -rf /var/lib/apt/lists/* && \
 # Install IB Gateway
 # Use this instead of "RUN curl .." to install a local file:
 #COPY ibgateway-${IB_GATEWAY_VERSION}-standalone-linux-x64.sh .
@@ -41,36 +42,44 @@ COPY ./config/ibc/config.ini.tmpl /root/ibc/config.ini.tmpl
 # Copy scripts
 COPY ./scripts /root/scripts
 
-#
+##############################################################################
 # Build Stage: build production image
-#
+##############################################################################
 
 FROM ubuntu:22.04
 
 ENV IB_GATEWAY_VERSION=$VERSION
-
-WORKDIR /root
+# IB Gateway user constants
+ARG USER_ID="${USER_ID:-1000}"
+ARG USER_GID="${USER_GID:-1000}"
+# IBC env vars
+ENV TWS_MAJOR_VRSN=${IB_GATEWAY_VERSION}
+ENV TWS_PATH=/home/ibgateway/Jts
+ENV TWS_INI=jts.ini
+ENV IBC_PATH=/home/ibgateway/ibc
+ENV IBC_INI=/home/ibgateway/ibc/config.ini
+# Copy files
 COPY --from=setup /usr/local/i4j_jres/ /usr/local/i4j_jres
+COPY --chown=${USER_ID}:${USER_GID} --from=setup /root/ /home/ibgateway/
 
 # Prepare system
 RUN apt-get update -y && \
-  apt-get install --no-install-recommends --yes \
-  gettext-base  \
-  socat \
-  xvfb \
-  x11vnc \
-  && rm -rf /var/lib/apt/lists/*
-
-# Copy files
-COPY --from=setup /root/ .
-RUN chmod a+x /root/scripts/*.sh
+  DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends --yes \
+  gettext-base socat xvfb x11vnc sshpass openssh-client && \
+  apt-get clean && \
+  rm -rf /var/lib/apt/lists/* && \
+  groupadd --gid ${USER_GID} ibgateway && \
+  useradd -ms /bin/bash --uid ${USER_ID} --gid ${USER_GID} ibgateway && \
+  chmod a+x /home/ibgateway/scripts/*.sh
 
-# IBC env vars
-ENV TWS_MAJOR_VRSN ${IB_GATEWAY_VERSION}
-ENV TWS_PATH /root/Jts
-ENV TWS_INI jts.ini
-ENV IBC_PATH /root/ibc
-ENV IBC_INI /root/ibc/config.ini
+USER ${USER_ID}:${USER_GID}
+WORKDIR /home/ibgateway/
 
 # Start run script
-CMD ["/root/scripts/run.sh"]
+CMD ["/home/ibgateway/scripts/run.sh"]
+
+LABEL org.opencontainers.image.source=https://github.com/gnzsnz/ib-gateway-docker
+LABEL org.opencontainers.image.url=https://github.com/gnzsnz/ib-gateway-docker/pkgs/container/ib-gateway
+LABEL org.opencontainers.image.description="Docker image with IB Gateway and IBC "
+LABEL org.opencontainers.image.licenses="Apache License Version 2.0"
+LABEL org.opencontainers.image.version=${IB_GATEWAY_VERSION}-${IB_GATEWAY_RELEASE_CHANNEL}

README.md

@@ -4,10 +4,10 @@ services:
   ib-gateway:
     restart: always
     build:
-      context: ./stable
+      context: ./latest
       tags:
-        - "ghcr.io/gnzsnz/ib-gateway:stable"
-    image: ghcr.io/gnzsnz/ib-gateway:stable
+        - "ghcr.io/gnzsnz/ib-gateway:latest"
+    image: ghcr.io/gnzsnz/ib-gateway:latest
     environment:
       TWS_USERID: ${TWS_USERID}
       TWS_PASSWORD: ${TWS_PASSWORD}
@@ -21,11 +21,21 @@ services:
       TWOFA_EXIT_INTERVAL: ${TWOFA_EXIT_INTERVAL:-60}
       TIME_ZONE: ${TIME_ZONE:-Etc/UTC}
       CUSTOM_CONFIG: ${CUSTOM_CONFIG:-NO}
+      SSH_TUNNEL: ${SSH_TUNNEL:-}
+      SSH_OPTIONS: ${SSH_OPTIONS:-}
+      SSH_ALIVE_INTERVAL: ${SSH_ALIVE_INTERVAL:-}
+      SSH_ALIVE_COUNT: ${SSH_ALIVE_COUNT:-}
+      SSH_PASSPHRASE: ${SSH_PASSPHRASE:-}
+      SSH_REMOTE_PORT: ${SSH_REMOTE_PORT:-}
+      SSH_USER_TUNNEL: ${SSH_USER_TUNNEL:-}
+      SSH_RESTART: ${SSH_RESTART:-}
+      SSH_VNC_PORT: ${SSH_VNC_PORT:-}
 #    volumes:
-#      - ${PWD}/jts.ini:/root/Jts/jts.ini
-#      - ${PWD}/config.ini:/root/ibc/config.ini
-#      - ${PWD}/tws_settings/:${TWS_SETTINGS_PATH:-/root/Jts}
+#      - ${PWD}/jts.ini:/home/ibgateway/Jts/jts.ini
+#      - ${PWD}/config.ini:/home/ibgateway/ibc/config.ini
+#      - ${PWD}/tws_settings/:${TWS_SETTINGS_PATH:-/home/ibgateway/Jts}
+#      - ${PWD}/ssh/:/home/ibgateway/.ssh
     ports:
-      - "127.0.0.1:4001:4001"
-      - "127.0.0.1:4002:4002"
+      - "127.0.0.1:4001:4003"
+      - "127.0.0.1:4002:4004"
       - "127.0.0.1:5900:5900"

docker-compose.yml

@@ -264,7 +264,7 @@ LoginDialogDisplayTimeout=60
 # NB: this setting is now DEPRECATED. You should use the
 # TWS_SETTINGS_PATH setting in the relevant start script.
 
-IbDir=/root/Jts
+#IbDir=/home/ibgateway/Jts
 
 
 # Store settings on server
@@ -340,7 +340,7 @@ ExistingSessionDetectedAction=primary
 # non-FIX users will never need it, so don't use it unless you know
 # you need it.
 
-OverrideTwsApiPort=4000
+OverrideTwsApiPort=
 
 
 # Override TWS Master Client ID

image-files/config/ibc/config.ini.tmpl

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+if [ "$SSH_TUNNEL" = "yes" ]; then
+
+  if [ "$TRADING_MODE" = "paper" ] ; then
+    SSH_LOCAL_PORT=4002
+  else
+    SSH_LOCAL_PORT=4001
+  fi
+
+  if [ -z "$SSH_REMOTE_PORT" ]; then
+    SSH_REMOTE_PORT="$SSH_LOCAL_PORT"
+  fi
+
+  if [ -n "$SSH_VNC_PORT" ] && [ -n "$VNC_SERVER_PASSWORD" ]
+  then
+    SSH_VNC_TUNNEL="-R 127.0.0.1:5900:localhost:$SSH_VNC_PORT"
+  fi
+
+  while true
+  do
+    echo "> ssh sock: $SSH_AUTH_SOCK"
+    bash -c "ssh ${SSH_ALL_OPTIONS} -TNR 127.0.0.1:${SSH_LOCAL_PORT}:localhost:${SSH_REMOTE_PORT} ${SSH_VNC_TUNNEL:-} ${SSH_USER_TUNNEL}"
+    sleep "${SSH_RESTART:-5}"
+  done
+
+else
+  # no ssh tunnel, start socat
+  sleep 30
+  #
+  if [ "$TRADING_MODE" = "paper" ]; then
+    # paper
+    printf "Forking :::4002 onto 0.0.0.0:4004 > trading mode %s \n" \
+      "${TRADING_MODE}"
+    socat TCP-LISTEN:4004,fork TCP:127.0.0.1:4002
+  else
+    # live
+    printf "Forking :::4001 onto 0.0.0.0:4003 > trading mode %s \n" \
+      "${TRADING_MODE}"
+    socat TCP-LISTEN:4003,fork TCP:127.0.0.1:4001
+  fi
+fi

image-files/scripts/port_forwarding.sh

@@ -1,38 +1,105 @@
-#!/bin/sh
+#!/bin/bash
 
 export DISPLAY=:1
 
+stop() {
+  echo "> 😘 Received SIGINT or SIGTERM. Shutting down IB Gateway."
+
+  #
+  if [ -n "$VNC_SERVER_PASSWORD" ]; then
+    echo "> Stopping x11vnc."
+    pkill x11vnc
+  fi
+  #
+  echo "> Stopping Xvfb."
+  pkill Xvfb
+  #
+  if [ -n "$SSH_TUNNEL" ]; then
+    echo "> Stopping ssh."
+    pkill ssh
+  else
+    echo "> Stopping socat."
+    pkill socat
+  fi
+  # Get PID
+  local pid
+  pid=$(</tmp/pid)
+  # Set TERM
+  echo "> Stopping IBC."
+  kill -SIGTERM "${pid}"
+  # Wait for exit
+  wait "${pid}"
+  # All done.
+  echo "> Done... $?"
+}
+
+# start Xvfb
 rm -f /tmp/.X1-lock
 Xvfb $DISPLAY -ac -screen 0 1024x768x16 &
 
+# setup SSH Tunnel
+if [ "$SSH_TUNNEL" = "yes" ]; then
+
+  _SSH_OPTIONS="-o ServerAliveInterval=${SSH_ALIVE_INTERVAL:-20}"
+  _SSH_OPTIONS+=" -o ServerAliveCountMax=${SSH_ALIVE_COUNT:-3}"
+
+  if [ -n "$SSH_OPTIONS" ]; then
+    _SSH_OPTIONS+=" $SSH_OPTIONS"
+  fi
+  SSH_ALL_OPTIONS="$_SSH_OPTIONS"
+  export SSH_ALL_OPTIONS
+  echo "> SSH options: $SSH_ALL_OPTIONS"
+
+  if [ -n "$SSH_PASSPHRASE" ]; then
+    echo "> Starting ssh-agent."
+    export SSH_ASKPASS_REQUIRE="never"
+    eval "$(ssh-agent)"
+    SSHPASS="${SSH_PASSPHRASE}" sshpass -e -P "passphrase" ssh-add
+    echo "> ssh-agent identities: $(ssh-add -l)"
+  fi
+fi
+
+# start VNC server
 if [ -n "$VNC_SERVER_PASSWORD" ]; then
-  echo "Starting VNC server"
-  /root/scripts/run_x11_vnc.sh &
+  echo "> Starting VNC server"
+  /home/ibgateway/scripts/run_x11_vnc.sh &
 fi
 
-if [ "$CUSTOM_CONFIG" != "YES" ]; then
+# apply settings
+if [ "$CUSTOM_CONFIG" != "yes" ]; then
   # replace env variables
   envsubst < "${IBC_INI}.tmpl" > "${IBC_INI}"
 
   # where are settings stored
   if [ -n "$TWS_SETTINGS_PATH" ]; then
     _JTS_PATH=$TWS_SETTINGS_PATH
+    if [ ! -d "$TWS_SETTINGS_PATH" ]; then
+      # if TWS_SETTINGS_PATH does not exists, create it
+      echo "> Creating directory: $TWS_SETTINGS_PATH"
+      mkdir "$TWS_SETTINGS_PATH"
+    fi
   else
     _JTS_PATH=$TWS_PATH
   fi
-
   # only if jts.ini does not exists
   if [ ! -f "$_JTS_PATH/$TWS_INI" ]; then
     echo "Setting timezone in ${_JTS_PATH}/${TWS_INI}"
     envsubst < "${TWS_PATH}/${TWS_INI}.tmpl" > "${_JTS_PATH}/${TWS_INI}"
   fi
-
 fi
 
-/root/scripts/fork_ports_delayed.sh &
+# forward ports, socat or ssh
+/home/ibgateway/scripts/port_forwarding.sh &
 
-/root/ibc/scripts/ibcstart.sh "${TWS_MAJOR_VRSN}" -g \
+# start IBC
+/home/ibgateway/ibc/scripts/ibcstart.sh "${TWS_MAJOR_VRSN}" -g \
      "--tws-path=${TWS_PATH}" \
      "--ibc-path=${IBC_PATH}" "--ibc-ini=${IBC_INI}" \
      "--on2fatimeout=${TWOFA_TIMEOUT_ACTION}" \
-     "--tws-settings-path=${TWS_SETTINGS_PATH:-}"
+     "--tws-settings-path=${TWS_SETTINGS_PATH:-}" &
+
+pid="$!"
+echo "$pid" > /tmp/pid
+trap stop SIGINT SIGTERM
+wait "${pid}"
+exit $?

image-files/scripts/run.sh

@@ -1,3 +1,3 @@
-#!/bin/sh
+#!/bin/bash
 
-x11vnc -ncache_cr -display :1 -forever -shared -logappend /var/log/x11vnc.log -bg -noipv6 -passwd "$VNC_SERVER_PASSWORD"
+x11vnc -ncache_cr -display :1 -forever -shared -bg -noipv6 -passwd "$VNC_SERVER_PASSWORD"

image-files/scripts/run_x11_vnc.sh

@@ -8,7 +8,7 @@
 
 FROM ubuntu:22.04 as setup
 
-ENV IB_GATEWAY_VERSION=10.25.1m
+ENV IB_GATEWAY_VERSION=10.25.1n
 ENV IB_GATEWAY_RELEASE_CHANNEL=latest
 ENV IBC_VERSION=3.18.0
 
@@ -47,7 +47,7 @@ COPY ./scripts /root/scripts
 
 FROM ubuntu:22.04
 
-ENV IB_GATEWAY_VERSION=10.25.1m
+ENV IB_GATEWAY_VERSION=10.25.1n
 
 WORKDIR /root
 COPY --from=setup /usr/local/i4j_jres/ /usr/local/i4j_jres