docs: clarify -ports-range is for port forwarding

This commit is contained in:
WofWca 2024-12-13 16:47:35 +04:00
parent 92521b6679
commit 85a93c5303
2 changed files with 2 additions and 1 deletions

View file

@ -50,6 +50,7 @@ Usage of ./proxy:
disable the exposing mechanism for stats using logs disable the exposing mechanism for stats using logs
-ephemeral-ports-range range -ephemeral-ports-range range
Set the range of ports used for client connections (format:"<min>:<max>"). Set the range of ports used for client connections (format:"<min>:<max>").
Useful in conjunction with port forwarding, in order to make the proxy NAT type "unrestricted".
If omitted, the ports will be chosen automatically from a wide range. If omitted, the ports will be chosen automatically from a wide range.
When specifying the range, make sure it's at least 2x as wide as the amount of clients that you are hoping to serve concurrently (see the "capacity" flag). When specifying the range, make sure it's at least 2x as wide as the amount of clients that you are hoping to serve concurrently (see the "capacity" flag).
-keep-local-addresses -keep-local-addresses

View file

@ -44,7 +44,7 @@ func main() {
metricsAddress := flag.String("metrics-address", "localhost", "set listen `address` for metrics service") metricsAddress := flag.String("metrics-address", "localhost", "set listen `address` for metrics service")
metricsPort := flag.Int("metrics-port", 9999, "set port for the metrics service") metricsPort := flag.Int("metrics-port", 9999, "set port for the metrics service")
verboseLogging := flag.Bool("verbose", false, "increase log verbosity") verboseLogging := flag.Bool("verbose", false, "increase log verbosity")
ephemeralPortsRangeFlag := flag.String("ephemeral-ports-range", "", "Set the `range` of ports used for client connections (format:\"<min>:<max>\").\nIf omitted, the ports will be chosen automatically from a wide range.\nWhen specifying the range, make sure it's at least 2x as wide as the amount of clients that you are hoping to serve concurrently (see the \"capacity\" flag).") ephemeralPortsRangeFlag := flag.String("ephemeral-ports-range", "", "Set the `range` of ports used for client connections (format:\"<min>:<max>\").\nUseful in conjunction with port forwarding, in order to make the proxy NAT type \"unrestricted\".\nIf omitted, the ports will be chosen automatically from a wide range.\nWhen specifying the range, make sure it's at least 2x as wide as the amount of clients that you are hoping to serve concurrently (see the \"capacity\" flag).")
versionFlag := flag.Bool("version", false, "display version info to stderr and quit") versionFlag := flag.Bool("version", false, "display version info to stderr and quit")
var ephemeralPortsRange []uint16 = []uint16{0, 0} var ephemeralPortsRange []uint16 = []uint16{0, 0}