Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
zh-jq-b committed Aug 18, 2023
1 parent 3c4a7e2 commit f3a1a38
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
17 changes: 9 additions & 8 deletions g3proxy/doc/configuration/escapers/direct_float.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
===========
Expand Down
10 changes: 3 additions & 7 deletions g3proxy/doc/configuration/escapers/proxy_float.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,16 @@ 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>`

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
===========

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit f3a1a38

Please sign in to comment.