Add .env-dist file and update README to reference it; parameterize PUID and PGID in docker-compose

Author: gnzsnz

.env-dist

@@ -0,0 +1,90 @@
+###############################################################################
+#########   Credentials, see credentials section for more details
+#########   https://github.com/gnzsnz/ib-gateway-docker?tab=readme-ov-file#credentials
+#########
+#########   To start update TWS_USERID and TWS_PASSWORD, everything is ready
+#########   to start in paper mode with default VNC password, see VNC_SERVER_PASSWORD
+###############################################################################
+TWS_USERID=myTwsAccountName
+TWS_PASSWORD=myTwsPassword
+# for credentials 
+# TWS_PASSWORD_FILE=
+# for parallel execution, live and paper simultaneourly
+# TWS_USERID_PAPER=
+# TWS_PASSWORD_PAPER=
+# TWS_PASSWORD_PAPER_FILE=
+# TWS rdesktop password
+# PASSWD=abc
+# PASSWD_FILE=
+# TWS rdesktop UID and GID
+# PUID=1000
+# PGID=1000
+# other options, Etc/UTC, Europe/Paris, America/New_York, Asia/Tokyo
+TIME_ZONE=Europe/Zurich
+###############################################################################
+#########   Settings path and custom config, see documentation
+#########   https://github.com/gnzsnz/ib-gateway-docker?tab=readme-ov-file#preserve-settings-across-containers
+###############################################################################
+# ib-gateway
+# TWS_SETTINGS_PATH=/home/ibgateway/Jts
+# tws
+# TWS_SETTINGS_PATH=/config/tws_settings
+TWS_SETTINGS_PATH=
+# if you need custom config
+# https://github.com/gnzsnz/ib-gateway-docker?tab=readme-ov-file#customizing-the-image
+# CUSTOM_CONFIG=
+###############################################################################
+#########   Java memory settings, see
+#########   https://www.ibkrguides.com/traderworkstation/increase-tws-memory-size.htm
+###############################################################################
+# JAVA_HEAP_SIZE=1024
+###############################################################################
+#########   IBC settings
+#########   these are IBC settings passed to IBC's config.ini file
+#########   for reference please visit
+#########   https://github.com/IbcAlpha/IBC/blob/master/userguide.md
+###############################################################################
+# trading mode can be live,paper,both - both allows for parallel live and paper
+TRADING_MODE=paper
+READ_ONLY_API=no
+TWOFA_TIMEOUT_ACTION=restart
+TWOFA_EXIT_INTERVAL=
+TWOFA_DEVICE=
+BYPASS_WARNING=
+AUTO_RESTART_TIME=11:59 PM
+AUTO_LOGOFF_TIME=
+TWS_COLD_RESTART=
+TWS_ACCEPT_INCOMING=
+SAVE_TWS_SETTINGS=
+RELOGIN_AFTER_TWOFA_TIMEOUT=yes
+EXISTING_SESSION_DETECTED_ACTION=primary
+ALLOW_BLIND_TRADING=no
+#TWS_MASTER_CLIENT_ID=
+###############################################################################
+#########   VNC settings
+###############################################################################
+VNC_SERVER_PASSWORD=myVncPassword
+# see credentials section for more details
+# VNC_SERVER_PASSWORD_FILE
+###############################################################################
+#########   SSH tunnel settings, see documentation
+#########   https://github.com/gnzsnz/ib-gateway-docker?tab=readme-ov-file#ssh-tunnel
+###############################################################################
+SSH_TUNNEL=
+SSH_OPTIONS=
+SSH_ALIVE_INTERVAL=
+SSH_ALIVE_COUNT=
+SSH_PASSPHRASE=
+SSH_PASSPHRASE_FILE=
+SSH_REMOTE_PORT=
+SSH_USER_TUNNEL=
+SSH_RESTART=
+SSH_VNC_PORT=
+SSH_RDP_PORT=
+###############################################################################
+#########   Start scripts settings, see documentation
+#########   https://github.com/gnzsnz/ib-gateway-docker?tab=readme-ov-file#start-up-scripts
+###############################################################################
+#START_SCRIPTS=init-scripts/start_scripts
+#X_SCRIPTS=init-scripts/x_scripts
+#IBC_SCRIPTS=init-scripts/ibc_scripts

template_README.md

@@ -112,7 +112,7 @@ services:
 
 ```
 
-Create an .env on root directory. Example .env file:
+Create an .env on root directory. You can use the provided [.env-dist](https://github.com/gnzsnz/ib-gateway-docker/blob/master/.env-dist) as a starting point. Example .env file:
 
 ```bash
 TWS_USERID=myTwsAccountName
@@ -164,7 +164,7 @@ Once `docker-compose.yml` and `.env` are in place you can start the container wi
 docker compose up
 ```
 
-To get a GUI can use vnc for ib-gateway or RDP for TWS.
+To get a GUI you can use vnc for ib-gateway or RDP for TWS.
 
 Looking for help? Please keep reading below, or go to
 [discussion](https://github.com/gnzsnz/ib-gateway-docker/discussions) section for common
@@ -188,6 +188,7 @@ All environment variables are common between ibgateway and TWS image, unless spe
 | `VNC_SERVER_PASSWORD_FILE`  | VNC server password. If not defined, then VNC server will NOT start. Specific to ibgateway, ignored by TWS. | **not defined** (VNC disabled) |
 | `TWOFA_TIMEOUT_ACTION`      | 'exit' or 'restart', set to 'restart if you set `AUTO_RESTART_TIME`. See IBC [documentation](https://github.com/IbcAlpha/IBC/blob/master/userguide.md#second-factor-authentication)  | exit  |
 | `TWOFA_DEVICE` | second factor authentication device. See IBC [documentation](https://github.com/IbcAlpha/IBC/blob/c98d0bcc2ead9b8ab3900a23a707f01f8fd7dfbc/resources/config.ini#L104) | **not defined** |
+| `TWOFA_EXIT_INTERVAL` | It controls how long (in seconds) IBC waits for login to complete after the user acknowledges the second factor authentication. See [IBC documentation](https://github.com/IbcAlpha/IBC/blob/38593af5193ccd634aa226cc66242adc8718b653/resources/config.ini#L147) | 60 seconds |
 | `BYPASS_WARNING` | Settings relate to the corresponding 'Precautions' checkboxes in the API section of the Global Configuration dialog. Accepted values `yes`, `no` if not set, the existing TWS/Gateway configuration is unchanged  | **not defined**                                      |
 | `AUTO_RESTART_TIME`  | time to restart IB Gateway, does not require daily 2FA validation. format hh:mm AM/PM. See IBC [documentation](https://github.com/IbcAlpha/IBC/blob/master/userguide.md#ibc-user-guide) | **not defined**  |
 | `AUTO_LOGOFF_TIME` | Auto-Logoff: at a specified time, TWS shuts down tidily, without restarting   | **not defined**   |

tws-docker-compose.yml

@@ -14,8 +14,8 @@ services:
         - "ghcr.io/gnzsnz/tws-rdesktop:latest"
     image: ghcr.io/gnzsnz/tws-rdesktop:latest
     environment:
-      PUID: 1000
-      PGID: 1000
+      PUID: ${PUID:-1000}
+      PGID: ${PGID:-1000}
       PASSWD: ${PASSWD:-}
       TWS_USERID: ${TWS_USERID}
       TWS_PASSWORD: ${TWS_PASSWORD}