mirror of
https://github.com/bytedance/g3.git
synced 2026-05-03 06:00:42 +00:00
110 lines
3 KiB
ReStructuredText
110 lines
3 KiB
ReStructuredText
.. _configuration_escaper_proxy_socks5:
|
|
|
|
proxy_socks5
|
|
============
|
|
|
|
This escaper will access the target upstream through another http proxy.
|
|
|
|
The following interfaces are supported:
|
|
|
|
* tcp connect
|
|
* udp_relay
|
|
* udp_connect
|
|
* http(s) forward
|
|
|
|
There is no path selection support for this escaper.
|
|
|
|
The following common keys are supported:
|
|
|
|
* :ref:`shared_logger <conf_escaper_common_shared_logger>`
|
|
* :ref:`resolver <conf_escaper_common_resolver>`, **required** only if *proxy_addr* is domain
|
|
* :ref:`resolve_strategy <conf_escaper_common_resolve_strategy>`
|
|
* :ref:`tcp_sock_speed_limit <conf_escaper_common_tcp_sock_speed_limit>`
|
|
* :ref:`udp_sock_speed_limit <conf_escaper_common_udp_sock_speed_limit>`
|
|
* :ref:`no_ipv4 <conf_escaper_common_no_ipv4>`
|
|
* :ref:`no_ipv6 <conf_escaper_common_no_ipv6>`
|
|
* :ref:`tcp_connect <conf_escaper_common_tcp_connect>`
|
|
* :ref:`happy eyeballs <conf_escaper_common_happy_eyeballs>`
|
|
* :ref:`tcp_misc_opts <conf_escaper_common_tcp_misc_opts>`
|
|
* :ref:`udp_misc_opts <conf_escaper_common_udp_misc_opts>`
|
|
* :ref:`peer negotiation timeout <conf_escaper_common_peer_negotiation_timeout>`
|
|
* :ref:`extra_metrics_tags <conf_escaper_common_extra_metrics_tags>`
|
|
|
|
proxy_addr
|
|
----------
|
|
|
|
**required**, **type**: :ref:`upstream str <conf_value_upstream_str>` | seq
|
|
|
|
Set the target proxy address. The default port is 1080 which can be omitted.
|
|
|
|
For *seq* value, each of its element must be :ref:`weighted upstream addr <conf_value_weighted_upstream_addr>`.
|
|
|
|
proxy_addr_pick_policy
|
|
----------------------
|
|
|
|
**optional**, **type**: :ref:`selective pick policy <conf_value_selective_pick_policy>`
|
|
|
|
Set the policy to select next proxy address.
|
|
|
|
The key for ketama/rendezvous/jump hash is *<client-ip>[-<username>]-<upstream-host>*.
|
|
|
|
**default**: random
|
|
|
|
proxy_username
|
|
--------------
|
|
|
|
**optional**, **type**: :ref:`username <conf_value_username>`
|
|
|
|
Set the proxy username. The User auth scheme is used by default.
|
|
|
|
proxy_password
|
|
--------------
|
|
|
|
**optional**, **type**: :ref:`password <conf_value_password>`
|
|
|
|
Set the proxy password. Required if username is present.
|
|
|
|
bind_ipv4
|
|
---------
|
|
|
|
**optional**, **type**: :ref:`ipv4 addr str <conf_value_ipv4_addr_str>`
|
|
|
|
Set the bind ip address for inet sockets.
|
|
|
|
**default**: not set
|
|
|
|
bind_ipv6
|
|
---------
|
|
|
|
**optional**, **type**: :ref:`ipv6 addr str <conf_value_ipv6_addr_str>`
|
|
|
|
Set the bind ip address for inet6 sockets.
|
|
|
|
**default**: not set
|
|
|
|
tcp_keepalive
|
|
-------------
|
|
|
|
**optional**, **type**: :ref:`tcp keepalive <conf_value_tcp_keepalive>`
|
|
|
|
Set tcp keepalive.
|
|
|
|
The tcp keepalive set in user config won't be taken into account.
|
|
|
|
**default**: 60s
|
|
|
|
transmute_udp_peer_ip
|
|
---------------------
|
|
|
|
**optional**, **type**: bool or map
|
|
|
|
Set this option if the UDP peer IP returned from the remote proxy should be transmuted.
|
|
|
|
For map value, the key should be the returned IP, and the value should be the real IP to use.
|
|
If the map is empty, the peer IP used by the tcp connection will be used.
|
|
|
|
For bool value, an empty map will be used if set to true, or disabled if set to false.
|
|
|
|
**default**: false
|
|
|
|
.. versionadded:: 1.7.19
|