vrr/g3
2
0
Fork 0
mirror of https://github.com/bytedance/g3.git synced 2026-05-03 14:10:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

update doc

Browse source
This commit is contained in:
Zhang Jingqiang 2023-08-18 15:49:30 +08:00
parent 3c4a7e2099
commit f3a1a38c24
2 changed files with 12 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

17
g3proxy/doc/configuration/escapers/direct_float.rst
View file

@ -15,13 +15,6 @@ The following interfaces are supported:
* http(s) forward
* ftp over http
The following egress path selection methods is supported:
* :ref:`by json <proto_egress_path_selection_by_json>`
The json value will be parsed as one (json map) or more (json array) :ref:`Bind IP <config_escaper_dynamic_bind_ip>`.
The bind ips passed here will overwrite the ones in the escaper config.
The Cap'n Proto RPC publish command is supported on this escaper, the published data should be a map, with the keys:
* ipv4
@ -34,7 +27,15 @@ The Cap'n Proto RPC publish command is supported on this escaper, the published
Set the IPv6 bind ip address(es).
The value could be an array of or just one :ref:`bind ip <config_escaper_dynamic_bind_ip>`.
There is no path selection support for this escaper.
The following egress path selection methods is supported:
* :ref:`by json <proto_egress_path_selection_by_json>`
The json value will be parsed as one (json map) or more (json array) :ref:`Bind IP <config_escaper_dynamic_bind_ip>`.
The bind ips passed here will overwrite the ones in the escaper config.
.. note:: you should consider disable ipv4 / ipv6 at escaper level if the value in the egress path selection doesn't
support ipv4 / ipv6
Config Keys
===========

10
g3proxy/doc/configuration/escapers/proxy_float.rst
View file

@ -19,6 +19,9 @@ The following interfaces are supported:
* udp connect (only socks5 peer)
* http(s) forward
The Cap'n Proto RPC publish command is supported on this escaper, the published data should be an array of
or just one :ref:`peer <config_escaper_dynamic_peer>`.
The following egress path selection methods is supported:
* :ref:`by json <proto_egress_path_selection_by_json>`
@ -26,11 +29,6 @@ The following egress path selection methods is supported:
The json value will be parsed as one (json map) or more (json array) :ref:`peer <config_escaper_dynamic_peer>`.
The peers passed here will overwrite the ones in the escaper config.
The Cap'n Proto RPC publish command is supported on this escaper, the published data should be an array of
or just one :ref:`peer <config_escaper_dynamic_peer>`.
There is no path selection support for this escaper.
Config Keys
===========
@ -374,8 +372,6 @@ https
Set the tls server name for server certificate verification.
.. note:: IP address is not supported by now. So if not set, the connection will fail.
**default**: not set
* http_connect_rsp_header_max_size