Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
heshiming committed Nov 3, 2024
1 parent 3120ffb commit f7dc2f1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

IBGA is <a href="https://www.interactivebrokers.com/en/trading/ibgateway-latest.php" target="_blank">IB Gateway</a> in headless mode. It is a container image preloaded with scripts for automating user interactions with IBG.

Now with second factor authentication support!
With TOTP (Time-based one-time password/IBKR Mobile Authenticator App) automation and second factor support.

<img src="docs/images/ibga-video.gif">

Expand All @@ -16,13 +16,15 @@ Now with second factor authentication support!
* Automatic daily export of logs
* Retaining of settings after an upgrade
* A disposable container design
* <a href="https://heshiming.github.io/ibga/faq.html#how-to-setup-totp-mobile-authenticator-app-automated-login">Support Mobile Authenticator App automation</a> (as of Nov 3, 2024)
* <a href="https://heshiming.github.io/ibga/faq.html#how-is-two-factor-authentication-interactive-brokers-secure-login-system-sls-handled-in-ibga">Support two-factor authentication</a> (as of Nov 11, 2022)

## Under the hood:
* IBGA runs in a set of bash scripts.
* IBGA relies on <a href="https://heshiming.github.io/jauto/" target="_blank">JAuto, a JVMTI agent</a> to determine screen locations of windows, text boxes, and buttons.
* IBGA relies on <a href="https://github.com/jordansissel/xdotool" target="_blank">xdotool</a> to simulate keyboard and mouse input.
* IBGA relies on <a href="https://en.wikipedia.org/wiki/Xvfb" target="_blank">Xvfb</a>, <a href="https://github.com/LibVNC/x11vnc" target="_blank">x11vnc</a>, <a href="https://novnc.com/" target="_blank">novnc</a> to provide a VNC-capable <a href="https://en.wikipedia.org/wiki/X_Window_System" target="_blank">X11</a> environment for IBG.
* IBGA relies on <a href="https://www.nongnu.org/oath-toolkit/oathtool.1.html" target="_blank">oathtool</a> to generate TOTP passcodes.

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/footer_custom.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Copyright &copy; 2022 He Shiming <small>&lt;heshiming at gmail dot com&gt;</small>.
Copyright &copy; 2024 He Shiming <small>&lt;heshiming at gmail dot com&gt;</small>.

0 comments on commit f7dc2f1

Please sign in to comment.