You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**HTTP Short Connections**: Set reasonable read timeout and enable connection reuse for frequent short connections to improve pool utilization
158
-
-**Long Connection Optimization**: Set larger timeout values for long-lived connections while avoiding resource waste
159
-
-**Resource Control**: Enable connection recycling by setting timeout in scenarios requiring strict connection lifecycle control
160
-
-**Default Mode**: Use the default no-timeout no-recycling mode for scenarios requiring maximum flexibility
155
+
**Data Read Timeout Use Cases:**
156
+
-**Connection Management**: Prevent idle connections from consuming resources indefinitely
157
+
-**Resource Control**: Set appropriate timeouts based on expected data transfer patterns
158
+
-**Network Reliability**: Handle network interruptions gracefully with automatic cleanup
161
159
162
160
## Rate Limiting
163
161
NodePass supports bandwidth rate limiting for traffic control through the `rate` parameter. This feature helps prevent network congestion and ensures fair resource allocation across multiple connections.
- The header format follows the HAProxy PROXY protocol v1 specification
265
263
- If the target service doesn't support PROXY protocol, connections may fail or behave unexpectedly
266
264
265
+
## UDP Support Control
266
+
267
+
NodePass supports UDP traffic tunneling in addition to TCP. The `noudp` parameter allows you to disable UDP support when only TCP traffic needs to be handled, which can reduce resource usage and simplify configuration.
268
+
269
+
-`noudp`: UDP support control (default: 0)
270
+
- Value 0: UDP support enabled - both TCP and UDP traffic will be tunneled
271
+
- Value 1: UDP support disabled - only TCP traffic will be tunneled, UDP packets are ignored
272
+
- Applies to both client and server modes
273
+
- When disabled, UDP-related resources (buffers, connections, sessions) are not allocated
-**TCP-Only Services**: Disable UDP when tunneling only TCP-based applications
292
+
-**Resource Optimization**: Reduce memory and CPU usage by avoiding UDP processing overhead
293
+
-**Security**: Prevent UDP-based attacks or unwanted traffic in restricted environments
294
+
-**Simplified Configuration**: Easier setup when UDP tunneling is not required
295
+
-**Network Isolation**: Isolate TCP and UDP traffic handling for better control
296
+
297
+
**Important Notes:**
298
+
- When UDP is disabled, any UDP packets sent to the tunnel will be silently dropped
299
+
- Existing UDP sessions will be terminated when switching to noudp=1
300
+
- UDP buffer pools and session management are disabled when noudp=1
301
+
267
302
## Target Address Groups and Load Balancing
268
303
269
304
NodePass supports configuring multiple target addresses to achieve high availability and load balancing. Target address groups are only applicable to the egress side (the final destination of traffic) and should not be used on the ingress side.
@@ -334,10 +369,11 @@ NodePass allows flexible configuration via URL query parameters. The following t
334
369
|`min`| Minimum pool capacity |`64`| X | O | X |
335
370
|`max`| Maximum pool capacity |`1024`| O | X | X |
336
371
|`mode`| Run mode control |`0`| O | O | X |
337
-
|`read`| Data read timeout and connection reuse|`0`| O | O | X |
372
+
|`read`| Data read timeout |`0`| O | O | X |
338
373
|`rate`| Bandwidth rate limit |`0`| O | O | X |
339
374
|`slot`| Maximum connection limit |`65536`| O | O | X |
340
375
|`proxy`| PROXY protocol support|`0`| O | O | X |
376
+
|`noudp`| UDP support control |`0`| O | O | X |
341
377
342
378
- O: Parameter is valid and recommended for configuration
343
379
- X: Parameter is not applicable and should be ignored
@@ -347,6 +383,7 @@ NodePass allows flexible configuration via URL query parameters. The following t
347
383
- For client/server dual-end handshake modes, adjust connection pool capacity (`min`, `max`) based on traffic and resource constraints for optimal performance.
348
384
- Use run mode control (`mode`) when automatic detection doesn't match your deployment requirements or for consistent behavior across environments.
349
385
- Configure rate limiting (`rate`) to control bandwidth usage and prevent network congestion in shared environments.
386
+
- Set `noudp=1` when only TCP traffic needs to be tunneled to reduce resource usage and simplify configuration.
350
387
- Log level (`log`) can be set in all modes for easier operations and troubleshooting.
0 commit comments