Add environment variable support for PORT, TO_CLT_BUFSIZE, TO_TG_BUFSIZE and optional configs by Copilot · Pull Request #10 · xrh0905/mtprotoproxy

Copilot · 2025-12-09T15:53:07Z

Several configuration options were only settable via config.py modifications, making Docker deployments less flexible. This adds environment variable support for the requested variables plus common tuning parameters.

Changes

config.py

Added PORT environment variable (default: 443)
Added TO_CLT_BUFSIZE and TO_TG_BUFSIZE with support for both integer (65536) and tuple ("16384,100,131072") formats for adaptive sizing
Added optional performance tunables: STATS_PRINT_PERIOD, CLIENT_KEEPALIVE, TG_CONNECT_TIMEOUT, FAST_MODE
Added network settings: LISTEN_ADDR_IPV4, LISTEN_ADDR_IPV6, PREFER_IPV6
Added metrics settings: METRICS_PORT, METRICS_EXPORT_LINKS

README.md

Added environment variables reference table organized by category (Core, Security, Performance, Network, Metrics)
Included Docker run example with new variables

docker-compose.yml

Updated example to include PORT

Usage

docker run -d --name mtprotoproxy \
  --network host \
  -e PORT=8443 \
  -e TO_CLT_BUFSIZE=65536 \
  -e TO_TG_BUFSIZE="16384,100,131072" \
  -e METRICS_PORT=9090 \
  ghcr.io/xrh0905/mtprotoproxy:latest

Variables only defined when environment variables are set; falls back to mtprotoproxy.py defaults via setdefault() otherwise.

Original prompt

This section details on the original issue you should resolve

<issue_title>Missing ENVIROMENT variable for configs</issue_title>
<issue_description>- TO_CLT_BUFSIZE

TO_TG_BUFSIZE

PORT
etc.
Optional config should also be exposed and displayed on README.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Missing ENVIROMENT variable for configs #9

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…IZE and other optional configs Co-authored-by: xrh0905 <29017419+xrh0905@users.noreply.github.com>

Copilot

Pull request overview

This PR adds comprehensive environment variable support for PORT, buffer sizes (TO_CLT_BUFSIZE, TO_TG_BUFSIZE), and various optional performance/network/metrics configuration parameters to make Docker deployments more flexible. The changes allow users to configure all proxy settings via environment variables without modifying config.py directly.

Key changes:

Added environment variable support for 13 configuration parameters including PORT, buffer sizes, performance tunables, network settings, and Prometheus metrics
Documented all available environment variables in README.md with organized tables by category
Updated docker-compose.yml example to include PORT configuration

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.

File	Description
config.py	Added environment variable parsing for PORT (always set) and 12 optional configuration parameters (only defined when env vars are set, falling back to mtprotoproxy.py defaults)
docker-compose.yml	Added PORT=443 environment variable to the example configuration
README.md	Added comprehensive environment variables reference documentation organized by category (Core, Security, Performance, Network, Metrics) with defaults and descriptions, plus Docker run example

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-09T16:11:53Z

+        TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(","))
+    else:
+        TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)
+


Missing validation for tuple format. According to the code in mtprotoproxy.py:487, the tuple format requires exactly 3 elements (low, margin, high). If a user provides a string like "16384,100" or "16384,100,131072,999", this will either fail unpacking later or use incorrect values.

Consider adding validation:

if "," in _to_clt_bufsize_env: parts = [int(x.strip()) for x in _to_clt_bufsize_env.split(",")] if len(parts) != 3: print(f"Warning: TO_CLT_BUFSIZE tuple must have exactly 3 values (low,users_margin,high), got {len(parts)}") else: TO_CLT_BUFSIZE = tuple(parts)

Suggested change

TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(","))

else:

TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)

parts = [int(x.strip()) for x in _to_clt_bufsize_env.split(",")]

if len(parts) != 3:

print(f"Warning: TO_CLT_BUFSIZE tuple must have exactly 3 values (low,users_margin,high), got {len(parts)}")

else:

TO_CLT_BUFSIZE = tuple(parts)

else:

TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)

Copilot · 2025-12-09T16:11:54Z

+    if "," in _to_tg_bufsize_env:
+        TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))
+    else:
+        TO_TG_BUFSIZE = int(_to_tg_bufsize_env)
+


Missing error handling for invalid integer values. If TO_TG_BUFSIZE is set to a non-numeric string, this will raise a ValueError. Consider adding the same error handling as suggested for TO_CLT_BUFSIZE.

Example:

if _to_tg_bufsize_env: try: if "," in _to_tg_bufsize_env: TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(",")) else: TO_TG_BUFSIZE = int(_to_tg_bufsize_env) except ValueError: print(f"Warning: Invalid TO_TG_BUFSIZE value: {_to_tg_bufsize_env}, using default")

Suggested change

if "," in _to_tg_bufsize_env:

TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))

else:

TO_TG_BUFSIZE = int(_to_tg_bufsize_env)

try:

if "," in _to_tg_bufsize_env:

TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))

else:

TO_TG_BUFSIZE = int(_to_tg_bufsize_env)

except ValueError:

print(f"Warning: Invalid TO_TG_BUFSIZE value: {_to_tg_bufsize_env}, using default")

Copilot · 2025-12-09T16:11:54Z

+_stats_print_period = os.environ.get("STATS_PRINT_PERIOD", None)
+if _stats_print_period:
+    STATS_PRINT_PERIOD = int(_stats_print_period)


Missing error handling for invalid integer conversion. If STATS_PRINT_PERIOD is set to a non-numeric string, this will raise a ValueError. The same issue exists for CLIENT_KEEPALIVE (line 71), TG_CONNECT_TIMEOUT (line 76), and METRICS_PORT (line 103).

Consider adding try-except blocks or validation for all these integer conversions to prevent crashes on invalid input.

Copilot · 2025-12-09T16:11:54Z

+        TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))
+    else:
+        TO_TG_BUFSIZE = int(_to_tg_bufsize_env)
+


Missing validation for tuple format. According to the code in mtprotoproxy.py:479, the tuple format requires exactly 3 elements (low, margin, high). If a user provides a string with wrong number of elements, this will either fail unpacking later or use incorrect values.

Consider adding the same validation as suggested for TO_CLT_BUFSIZE.

Suggested change

TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))

else:

TO_TG_BUFSIZE = int(_to_tg_bufsize_env)

tg_bufsize_tuple = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))

if len(tg_bufsize_tuple) != 3:

raise ValueError("TO_TG_BUFSIZE must have exactly 3 comma-separated values (low, margin, high)")

TO_TG_BUFSIZE = tg_bufsize_tuple

else:

TO_TG_BUFSIZE = int(_to_tg_bufsize_env)

Copilot · 2025-12-09T16:11:55Z

+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `TO_CLT_BUFSIZE` | `16384,100,131072` | Buffer size to client. Single integer or comma-separated tuple (low,users_margin,high) for adaptive sizing |


The default value documented here should be (16384, 100, 131072) (a tuple) not 16384,100,131072 (a string). According to mtprotoproxy.py:275, the default is a tuple: conf_dict.setdefault("TO_CLT_BUFSIZE", (16384, 100, 131072)).

The current documentation could be misleading as it suggests the default is a string format, when in fact the code defaults to a tuple when the variable is not set.

Suggested change

| `TO_CLT_BUFSIZE` | `16384,100,131072` | Buffer size to client. Single integer or comma-separated tuple (low,users_margin,high) for adaptive sizing |

| `TO_CLT_BUFSIZE` | `(16384, 100, 131072)` | Buffer size to client. Single integer or tuple (low, users_margin, high) for adaptive sizing. Default is a tuple. |

Copilot · 2025-12-09T16:11:55Z

+|----------|---------|-------------|
+| `LISTEN_ADDR_IPV4` | `0.0.0.0` | IPv4 listen address |
+| `LISTEN_ADDR_IPV6` | `::` | IPv6 listen address |
+| `PREFER_IPV6` | Auto-detected | Prefer IPv6 for outgoing connections |


[nitpick] The documentation states the default is "Auto-detected" based on mtprotoproxy.py:164 which sets it to socket.has_ipv6. However, the table format should clarify this is a boolean value that gets auto-detected. Consider changing to something like: Auto-detected (socket.has_ipv6) or true if IPv6 available to be clearer about the data type.

Suggested change

| `PREFER_IPV6` | Auto-detected | Prefer IPv6 for outgoing connections |

| `PREFER_IPV6` | `true` if IPv6 available (auto-detected via socket.has_ipv6) | Prefer IPv6 for outgoing connections |

Copilot · 2025-12-09T16:11:55Z

+    if "," in _to_clt_bufsize_env:
+        TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(","))
+    else:
+        TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)
+


Missing error handling for invalid integer values. If TO_CLT_BUFSIZE is set to a non-numeric string (e.g., "invalid"), this will raise a ValueError. Consider wrapping the conversion in a try-except block or validating the input before conversion, similar to the existing pattern for SOCKS5_PORT at line 40 which uses .isdigit() check.

Example:

if _to_clt_bufsize_env: try: if "," in _to_clt_bufsize_env: TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(",")) else: TO_CLT_BUFSIZE = int(_to_clt_bufsize_env) except ValueError: print(f"Warning: Invalid TO_CLT_BUFSIZE value: {_to_clt_bufsize_env}, using default")

Suggested change

if "," in _to_clt_bufsize_env:

TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(","))

else:

TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)

try:

if "," in _to_clt_bufsize_env:

TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(","))

else:

TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)

except ValueError:

print(f"Warning: Invalid TO_CLT_BUFSIZE value: {_to_clt_bufsize_env}, using default")

Copilot · 2025-12-09T16:11:55Z

+# Client keepalive period in seconds
+_client_keepalive = os.environ.get("CLIENT_KEEPALIVE", None)
+if _client_keepalive:
+    CLIENT_KEEPALIVE = int(_client_keepalive)


Missing error handling for invalid integer conversion. If CLIENT_KEEPALIVE is set to a non-numeric string, this will raise a ValueError. Consider adding error handling as mentioned in the comment for STATS_PRINT_PERIOD.

Suggested change

CLIENT_KEEPALIVE = int(_client_keepalive)

try:

CLIENT_KEEPALIVE = int(_client_keepalive)

except (ValueError, TypeError):

# Fallback to a default value, e.g., 60 seconds, and optionally log a warning

CLIENT_KEEPALIVE = 60

# print(f"Warning: Invalid CLIENT_KEEPALIVE value '{_client_keepalive}', using default 60")

Copilot · 2025-12-09T16:11:56Z

+    TG_CONNECT_TIMEOUT = int(_tg_connect_timeout)
+


Missing error handling for invalid integer conversion. If TG_CONNECT_TIMEOUT is set to a non-numeric string, this will raise a ValueError. Consider adding error handling as mentioned in the comment for STATS_PRINT_PERIOD.

Suggested change

TG_CONNECT_TIMEOUT = int(_tg_connect_timeout)

try:

TG_CONNECT_TIMEOUT = int(_tg_connect_timeout)

except (ValueError, TypeError):

print(f"Warning: Invalid TG_CONNECT_TIMEOUT value '{_tg_connect_timeout}', using default (None).")

TG_CONNECT_TIMEOUT = None

Copilot · 2025-12-09T16:11:56Z

+    METRICS_PORT = int(_metrics_port)
+


Missing error handling for invalid integer conversion. If METRICS_PORT is set to a non-numeric string, this will raise a ValueError. Consider adding error handling as mentioned in the comment for STATS_PRINT_PERIOD.

Suggested change

METRICS_PORT = int(_metrics_port)

try:

METRICS_PORT = int(_metrics_port)

except (ValueError, TypeError):

METRICS_PORT = None

Initial plan

35a1ef9

Copilot AI assigned Copilot and xrh0905 Dec 9, 2025

Copilot started work on behalf of xrh0905 December 9, 2025 15:53 View session

Add environment variable support for PORT, TO_CLT_BUFSIZE, TO_TG_BUFS…

eede5c0

…IZE and other optional configs Co-authored-by: xrh0905 <29017419+xrh0905@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add missing environment variables for configurations~~ Add environment variable support for PORT, TO_CLT_BUFSIZE, TO_TG_BUFSIZE and optional configs Dec 9, 2025

Copilot AI requested a review from xrh0905 December 9, 2025 16:02

Copilot finished work on behalf of xrh0905 December 9, 2025 16:02

xrh0905 marked this pull request as ready for review December 9, 2025 16:03

Copilot AI review requested due to automatic review settings December 9, 2025 16:03

xrh0905 merged commit 5a76d5d into edge Dec 9, 2025
4 checks passed

Copilot started reviewing on behalf of xrh0905 December 9, 2025 16:04 View session

Copilot AI reviewed Dec 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add environment variable support for PORT, TO_CLT_BUFSIZE, TO_TG_BUFSIZE and optional configs#10

Add environment variable support for PORT, TO_CLT_BUFSIZE, TO_TG_BUFSIZE and optional configs#10
xrh0905 merged 2 commits into
edgefrom
copilot/add-env-variable-configs

Copilot AI commented Dec 9, 2025 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Copilot AI Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-        TO_CLT_BUFSIZE = tuple(int(x.strip()) for x in _to_clt_bufsize_env.split(","))
-    else:
-        TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)
+        parts = [int(x.strip()) for x in _to_clt_bufsize_env.split(",")]
+        if len(parts) != 3:
+            print(f"Warning: TO_CLT_BUFSIZE tuple must have exactly 3 values (low,users_margin,high), got {len(parts)}")
+        else:
+            TO_CLT_BUFSIZE = tuple(parts)
+    else:
+        TO_CLT_BUFSIZE = int(_to_clt_bufsize_env)

-        TO_TG_BUFSIZE = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))
-    else:
-        TO_TG_BUFSIZE = int(_to_tg_bufsize_env)
+        tg_bufsize_tuple = tuple(int(x.strip()) for x in _to_tg_bufsize_env.split(","))
+        if len(tg_bufsize_tuple) != 3:
+            raise ValueError("TO_TG_BUFSIZE must have exactly 3 comma-separated values (low, margin, high)")
+        TO_TG_BUFSIZE = tg_bufsize_tuple
+    else:
+        TO_TG_BUFSIZE = int(_to_tg_bufsize_env)

	\| `TO_CLT_BUFSIZE` \| `16384,100,131072` \| Buffer size to client. Single integer or comma-separated tuple (low,users_margin,high) for adaptive sizing \|
	\| `TO_CLT_BUFSIZE` \| `(16384, 100, 131072)` \| Buffer size to client. Single integer or tuple (low, users_margin, high) for adaptive sizing. Default is a tuple. \|

	\| `PREFER_IPV6` \| Auto-detected \| Prefer IPv6 for outgoing connections \|
	\| `PREFER_IPV6` \| `true` if IPv6 available (auto-detected via socket.has_ipv6) \| Prefer IPv6 for outgoing connections \|

-    CLIENT_KEEPALIVE = int(_client_keepalive)
+    try:
+        CLIENT_KEEPALIVE = int(_client_keepalive)
+    except (ValueError, TypeError):
+        # Fallback to a default value, e.g., 60 seconds, and optionally log a warning
+        CLIENT_KEEPALIVE = 60
+        # print(f"Warning: Invalid CLIENT_KEEPALIVE value '{_client_keepalive}', using default 60")

Conversation

Copilot AI commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Usage

Comments on the Issue (you are @copilot in this section)

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Dec 9, 2025 •

edited

Loading