Browse Source

docs: update describe of vlessObject and trojanObject

master
dnomd343 2 years ago
parent
commit
e8dce9f565
  1. 4
      docs/ProxyObject/Shadowsocks.md
  2. 343
      docs/ProxyObject/Trojan.md
  3. 353
      docs/ProxyObject/VLESS.md
  4. 4
      docs/ProxyObject/VMess.md

4
docs/ProxyObject/Shadowsocks.md

@ -85,7 +85,7 @@
### plugin ### plugin
+ 类型:*None* / [*pluginObject*](#pluginobject) + 类型:*None* / [*pluginObject*](#pluginobject)
+ 说明:SIP003插件 + 说明:SIP003插件选项
+ 缺省:`None` + 缺省:`None`
+ 限制:无 + 限制:无
@ -94,7 +94,7 @@
``` ```
{ {
'type': ---, 'type': ---,
'param': --- 'param': ---,
} }
``` ```

343
docs/ProxyObject/Trojan.md

@ -1,366 +1,341 @@
## Trojan ## trojanObject
> **remark**
>
> + 类型:*str*
> + 说明:节点备注名称
> + 缺省:''
> + 可选值:不限
``` ```
{ {
'type': 'trojan', 'server': ---,
'server': ..., 'port': ---,
'port': ..., 'passwd': ---,
'passwd': ..., 'stream': ---,
'stream': ...
} }
``` ```
**server** ### server
+ 类型:*str* + 类型:*str*
+ 说明:服务地址 + 说明:Trojan服务地址
+ 缺省:必选 + 缺省:必选
+ 可选值:合法的IP地址或域名 + 限制:IP地址或域名
**port** ### port
+ 类型:*int* + 类型:*int*
+ 说明:服务端口 + 说明:Trojan服务端口
+ 缺省:必选 + 缺省:必选
+ 可选值:1 ~ 65535 + 限制:1 ~ 65535
**passwd** ### passwd
+ 类型:*str* + 类型:*str*
+ 说明:Trojan连接密码 + 说明:Trojan连接密码
+ 缺省:必选 + 缺省:必选
+ 可选值:不 + 限制:无
**stream** ### stream
+ 类型:*tcpObject* / *kcpObject* / *wsObject* / *h2Object* / *quicObject* / *grpcObject* + 类型:[*tcpObject*](#tcpobject) / [*kcpObject*](#kcpobject) / [*wsObject*](#wsobject) / [*h2Object*](#h2object) / [*quicObject*](#quicobject) / [*grpcObject*](#grpcobject)
+ 说明:Trojan底层传输方式 + 说明:Trojan传输方式
+ 缺省:tcpObject + 缺省:`tcpObject`
+ 可选值:不 + 限制:无
### tcpObject ## tcpObject
``` ```
{ {
'type': 'tcp', 'type': 'tcp',
'obfs': ..., 'obfs': ---,
'secure': ... 'secure': ---,
} }
``` ```
**obfs** ### obfs
+ 类型:*None* / *obfsObject* + 类型:*None* / [*obfsObject*](#obfsobject)
+ 说明:http伪装 + 说明:http伪装选项
+ 缺省:None + 缺省:`None`
+ 可选值:不 + 限制:无
**secure** ### secure
+ 类型:*None* / *tlsObject* / *xtlsObject* + 类型:*None* / [*tlsObject*](#tlsobject) / [*xtlsObject*](#xtlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### kcpObject ## kcpObject
``` ```
{ {
'type': 'kcp', 'type': 'kcp',
'seed': ..., 'seed': ---,
'obfs': ..., 'obfs': ---,
'secure': ... 'secure': ---,
} }
``` ```
**seed** ### seed
+ 类型:*None* / *str* + 类型:*None* / *str*
+ 说明:mKCP混淆密码 + 说明:mKCP混淆密码
+ 缺省:None + 缺省:`None`
+ 可选值:不 + 限制:无
**obfs** ### obfs
+ 类型:*str* + 类型:*str*
+ 说明:数据包头部伪装类型 + 说明:数据包头部伪装类型
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard` + 限制:`none`, `srtp`, `utp`, `wechat-video`, `dtls`, `wireguard`
**secure** ### secure
+ 类型:*None* / *tlsObject* / *xtlsObject* + 类型:*None* / [*tlsObject*](#tlsobject) / [*xtlsObject*](#xtlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### wsObject ## wsObject
``` ```
{ {
'type': 'ws', 'type': 'ws',
'host': ..., 'host': ---,
'path': ..., 'path': ---,
'ed': ..., 'ed': ---,
'secure': ... 'secure': ---,
} }
``` ```
**host** ### host
+ 类型:*str* + 类型:*str*
+ 说明:Websocket连接域名 + 说明:Websocket连接域名
+ 缺省:'' + 缺省:`空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名
**path** ### path
+ 类型:*str* + 类型:*str*
+ 说明:Websocket连接路径 + 说明:Websocket连接路径
+ 缺省:'/' + 缺省:`/`
+ 可选值:不限 + 限制:无
+ 建议值:以`/`开头的合法路径
**ed** ### ed
+ 类型:*None* / *int* + 类型:*None* / *int*
+ 说明:`Early Data`长度阈值 + 说明:Early Data长度阈值
+ 缺省:None + 缺省:`None`
+ 可选值:>0 + 限制:>0
+ 建议值:2048
**secure** ### secure
+ 类型:*None* / *tlsObject* + 类型:*None* / [*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### h2Object ## h2Object
``` ```
{ {
'type': 'h2', 'type': 'h2',
'host': ..., 'host': ---,
'path': ..., 'path': ---,
'secure': ... 'secure': ---,
} }
``` ```
**host** ### host
+ 类型:*str* + 类型:*str*
+ 说明:HTTP/2通讯域名 + 说明:HTTP/2连接域名
+ 缺省:'' + 缺省:`空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名列表(逗号隔开)
**path** ### path
+ 类型:*str* + 类型:*str*
+ 说明:HTTP/2通讯路径 + 说明:HTTP/2连接路径
+ 缺省:'/' + 缺省:`/`
+ 可选值:不限 + 限制:无
+ 建议值:以`/`开头的合法路径
**secure** ### secure
+ 类型:*tlsObject* + 类型:[*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### quicObject ## quicObject
``` ```
{ {
'type': 'quic', 'type': 'quic',
'method': ..., 'method': ---,
'passwd': ..., 'passwd': ---,
'obfs': ..., 'obfs': ---,
'secure': ... 'secure': ---,
} }
``` ```
**method** ### method
+ 类型:*str* + 类型:*str*
+ 说明:QUIC加密方式 + 说明:QUIC加密方式
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none`,`aes-128-gcm`,`chacha20-poly1305` + 限制:`none`, `aes-128-gcm`, `chacha20-poly1305`
**passwd** ### passwd
+ 类型:*str* + 类型:*str*
+ 说明:QUIC连接密码 + 说明:QUIC连接密码
+ 缺省:'' + 缺省:`空`
+ 可选值:不 + 限制:无
**obfs** ### obfs
+ 类型:*str* + 类型:*str*
+ 说明:数据包头部伪装类型 + 说明:数据包头部伪装类型
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard` + 限制:`none`, `srtp`, `utp`, `wechat-video`, `dtls`, `wireguard`
**secure** ### secure
+ 类型:*tlsObject* + 类型:[*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### grpcObject ## grpcObject
``` ```
{ {
'type': 'grpc', 'type': 'grpc',
'service': ..., 'service': ---,
'mode': ..., 'mode': ---,
'secure': ... 'secure': ---,
} }
``` ```
**service** ### service
+ 类型:*str* + 类型:*str*
+ 说明:gRPC服务名称 + 说明:gRPC服务名称
+ 缺省:必选 + 缺省:必选
+ 可选值:不限 + 限制:无
+ 建议值:英文大小写字母、数字、下划线及英文句号组成
**mode** ### mode
+ 类型:*str* + 类型:*str*
+ 说明:gRPC传输模式 + 说明:gRPC传输模式
+ 缺省:'gun' + 缺省:`gun`
+ 可选值:`gun`,`multi` + 限制:`gun`, `multi`
+ 建议值:'multi'
**secure** ### secure
+ 类型:*None* / *tlsObject* + 类型:*None* / [*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### obfsObject ## obfsObject
``` ```
{ {
'host': ..., 'host': ---,
'path': ... 'path': ---,
} }
``` ```
**host** ### host
+ 类型:*str* + 类型:*str*
+ 说明:http伪装域名 + 说明:http伪装域名
+ 缺省:'' + 缺省:`空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名列表(逗号隔开)
**path** ### path
+ 类型:*str* + 类型:*str*
+ 说明:http伪装路径 + 说明:http伪装路径
+ 缺省:'/' + 缺省:`/`
+ 可选值:不限 + 限制:无
+ 建议值:以`/`开头的合法路径
### tlsObject ## tlsObject
``` ```
{ {
'type': 'tls', 'type': 'tls',
'sni': ..., 'sni': ---,
'alpn': ..., 'alpn': ---,
'verify': ... 'verify': ---,
} }
``` ```
**sni** ### sni
+ 类型:*str* + 类型:*str*
+ 说明:TLS握手SNI字段 + 说明:TLS握手SNI字段
+ 缺省:obfsObject.host[0] / wsObject.host / h2Object.host[0] / '' + 缺省:`obfsObject.host[0]` / `wsObject.host` / `h2Object.host[0]` / `空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名
**alpn** ### alpn
+ 类型:*None* / *str* + 类型:*None* / *str*
+ 说明:TLS握手协商协议 + 说明:TLS握手协商协议
+ 缺省:None + 缺省:`None`
+ 可选值:`h2`,`http/1.1`,`h2,http/1.1` + 限制:`h2`, `http/1.1`, `h2,http/1.1`
+ 建议值:'h2,http/1.1'
**verify** ### verify
+ 类型:*bool* + 类型:*bool*
+ 说明:是否验证服务端证书 + 说明:是否验证服务端证书
+ 缺省:True + 缺省:`True`
+ 可选值:不限 + 限制:无
+ 建议值:True
### xtlsObject ## xtlsObject
``` ```
{ {
'type': 'xtls', 'type': 'xtls',
'sni': ..., 'sni': ---,
'alpn': ..., 'alpn': ---,
'verify': ... 'verify': ---
'flow': ..., 'flow': ---,
'udp443': ... 'udp443': ---,
} }
``` ```
**sni** ### sni
+ 类型:*str* + 类型:*str*
+ 说明:TLS握手SNI字段 + 说明:TLS握手SNI字段
+ 缺省:obfsObject.host[0] / wsObject.host / h2Object.host[0] / '' + 缺省:`obfsObject.host[0]` / `wsObject.host` / `h2Object.host[0]` / `空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名
**alpn** ### alpn
+ 类型:*None* / *str* + 类型:*None* / *str*
+ 说明:TLS握手协商协议 + 说明:TLS握手协商协议
+ 缺省:None + 缺省:`None`
+ 可选值:`h2`,`http/1.1`,`h2,http/1.1` + 限制:`h2`, `http/1.1`, `h2,http/1.1`
+ 建议值:'h2,http/1.1'
**verify** ### verify
+ 类型:*bool* + 类型:*bool*
+ 说明:是否验证服务端证书 + 说明:是否验证服务端证书
+ 缺省:True + 缺省:`True`
+ 可选值:不限 + 限制:无
+ 建议值:True
**flow** ### flow
+ 类型:*str* + 类型:*str*
+ 说明:XTLS流控算法 + 说明:XTLS流控算法
+ 缺省:'xtls-direct' + 缺省:`xtls-direct`
+ 可选值:`xtls-origin`,`xtls-direct`,`xtls-splice` + 限制:`xtls-origin`, `xtls-direct`, `xtls-splice`
+ 建议值:'xtls-direct' (Linux平台建议`xtls-splice`)
**udp443** ### udp443
+ 类型:*bool* + 类型:*bool*
+ 说明:是否放行UDP/443端口流量 + 说明:是否放行UDP/443端口流量
+ 缺省:False + 缺省:`False`
+ 可选值:不限 + 限制:无
+ 建议值:False

353
docs/ProxyObject/VLESS.md

@ -1,376 +1,349 @@
## VLESS ## vlessObject
> **remark**
>
> + 类型:*str*
> + 说明:节点备注名称
> + 缺省:''
> + 可选值:不限
``` ```
{ {
'type': 'vless', 'server': ---,
'server': ..., 'port': ---,
'port': ..., 'method': ---,
'method': ..., 'id': ---,
'id': ..., 'stream': ---,
'stream': ...
} }
``` ```
**server** ### server
+ 类型:*str* + 类型:*str*
+ 说明:服务地址 + 说明:VLESS服务地址
+ 缺省:必选 + 缺省:必选
+ 可选值:合法的IP地址或域名 + 限制:IP地址或域名
**port** ### port
+ 类型:*int* + 类型:*int*
+ 说明:服务端口 + 说明:VLESS服务端口
+ 缺省:必选 + 缺省:必选
+ 可选值:1 ~ 65535 + 限制:1 ~ 65535
**method** ### method
+ 类型:*str* + 类型:*str*
+ 说明:VLESS加密方式 + 说明:VLESS加密方式
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none` + 限制:`none`
+ 建议值:'none'
**id** ### id
+ 类型:*str* + 类型:*str*
+ 说明:VLESS认证ID + 说明:VLESS认证ID
+ 缺省:必选 + 缺省:必选
+ 可选值:不限 + 限制:无
+ 建议值:小于30字节的字符串
**stream** ### stream
+ 类型:*tcpObject* / *kcpObject* / *wsObject* / *h2Object* / *quicObject* / *grpcObject* + 类型:[*tcpObject*](#tcpobject) / [*kcpObject*](#kcpobject) / [*wsObject*](#wsobject) / [*h2Object*](#h2object) / [*quicObject*](#quicobject) / [*grpcObject*](#grpcobject)
+ 说明:VLESS底层传输方式 + 说明:VLESS传输方式
+ 缺省:tcpObject + 缺省:`tcpObject`
+ 可选值:不 + 限制:无
### tcpObject ## tcpObject
``` ```
{ {
'type': 'tcp', 'type': 'tcp',
'obfs': ..., 'obfs': ---,
'secure': ... 'secure': ---,
} }
``` ```
**obfs** ### obfs
+ 类型:*None* / *obfsObject* + 类型:*None* / [*obfsObject*](#obfsobject)
+ 说明:http伪装 + 说明:http伪装选项
+ 缺省:None + 缺省:`None`
+ 可选值:不 + 限制:无
**secure** ### secure
+ 类型:*None* / *tlsObject* / *xtlsObject* + 类型:*None* / [*tlsObject*](#tlsobject) / [*xtlsObject*](#xtlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### kcpObject ## kcpObject
``` ```
{ {
'type': 'kcp', 'type': 'kcp',
'seed': ..., 'seed': ---,
'obfs': ..., 'obfs': ---,
'secure': ... 'secure': ---,
} }
``` ```
**seed** ### seed
+ 类型:*None* / *str* + 类型:*None* / *str*
+ 说明:mKCP混淆密码 + 说明:mKCP混淆密码
+ 缺省:None + 缺省:`None`
+ 可选值:不 + 限制:无
**obfs** ### obfs
+ 类型:*str* + 类型:*str*
+ 说明:数据包头部伪装类型 + 说明:数据包头部伪装类型
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard` + 限制:`none`, `srtp`, `utp`, `wechat-video`, `dtls`, `wireguard`
**secure** ### secure
+ 类型:*None* / *tlsObject* / *xtlsObject* + 类型:*None* / [*tlsObject*](#tlsobject) / [*xtlsObject*](#xtlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### wsObject ## wsObject
``` ```
{ {
'type': 'ws', 'type': 'ws',
'host': ..., 'host': ---,
'path': ..., 'path': ---,
'ed': ..., 'ed': ---,
'secure': ... 'secure': ---,
} }
``` ```
**host** ### host
+ 类型:*str* + 类型:*str*
+ 说明:Websocket连接域名 + 说明:Websocket连接域名
+ 缺省:'' + 缺省:`空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名
**path** ### path
+ 类型:*str* + 类型:*str*
+ 说明:Websocket连接路径 + 说明:Websocket连接路径
+ 缺省:'/' + 缺省:`/`
+ 可选值:不限 + 限制:无
+ 建议值:以`/`开头的合法路径
**ed** ### ed
+ 类型:*None* / *int* + 类型:*None* / *int*
+ 说明:`Early Data`长度阈值 + 说明:Early Data长度阈值
+ 缺省:None + 缺省:`None`
+ 可选值:>0 + 限制:>0
+ 建议值:2048
**secure** ### secure
+ 类型:*None* / *tlsObject* + 类型:*None* / [*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### h2Object ## h2Object
``` ```
{ {
'type': 'h2', 'type': 'h2',
'host': ..., 'host': ---,
'path': ..., 'path': ---,
'secure': ... 'secure': ---,
} }
``` ```
**host** ### host
+ 类型:*str* + 类型:*str*
+ 说明:HTTP/2通讯域名 + 说明:HTTP/2连接域名
+ 缺省:'' + 缺省:`空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名列表(逗号隔开)
**path** ### path
+ 类型:*str* + 类型:*str*
+ 说明:HTTP/2通讯路径 + 说明:HTTP/2连接路径
+ 缺省:'/' + 缺省:`/`
+ 可选值:不限 + 限制:无
+ 建议值:以`/`开头的合法路径
**secure** ### secure
+ 类型:*tlsObject* + 类型:[*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### quicObject ## quicObject
``` ```
{ {
'type': 'quic', 'type': 'quic',
'method': ..., 'method': ---,
'passwd': ..., 'passwd': ---,
'obfs': ..., 'obfs': ---,
'secure': ... 'secure': ---,
} }
``` ```
**method** ### method
+ 类型:*str* + 类型:*str*
+ 说明:QUIC加密方式 + 说明:QUIC加密方式
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none`,`aes-128-gcm`,`chacha20-poly1305` + 限制:`none`, `aes-128-gcm`, `chacha20-poly1305`
**passwd** ### passwd
+ 类型:*str* + 类型:*str*
+ 说明:QUIC连接密码 + 说明:QUIC连接密码
+ 缺省:'' + 缺省:`空`
+ 可选值:不 + 限制:无
**obfs** ### obfs
+ 类型:*str* + 类型:*str*
+ 说明:数据包头部伪装类型 + 说明:数据包头部伪装类型
+ 缺省:'none' + 缺省:`none`
+ 可选值:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard` + 限制:`none`, `srtp`, `utp`, `wechat-video`, `dtls`, `wireguard`
**secure** ### secure
+ 类型:*tlsObject* + 类型:[*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### grpcObject ## grpcObject
``` ```
{ {
'type': 'grpc', 'type': 'grpc',
'service': ..., 'service': ---,
'mode': ..., 'mode': ---,
'secure': ... 'secure': ---,
} }
``` ```
**service** ### service
+ 类型:*str* + 类型:*str*
+ 说明:gRPC服务名称 + 说明:gRPC服务名称
+ 缺省:必选 + 缺省:必选
+ 可选值:不限 + 限制:无
+ 建议值:英文大小写字母、数字、下划线及英文句号组成
**mode** ### mode
+ 类型:*str* + 类型:*str*
+ 说明:gRPC传输模式 + 说明:gRPC传输模式
+ 缺省:'gun' + 缺省:`gun`
+ 可选值:`gun`,`multi` + 限制:`gun`, `multi`
+ 建议值:'multi'
**secure** ### secure
+ 类型:*None* / *tlsObject* + 类型:*None* / [*tlsObject*](#tlsobject)
+ 说明:TLS加密 + 说明:TLS加密选项
+ 缺省:tlsObject + 缺省:`tlsObject`
+ 可选值:不 + 限制:无
### obfsObject ## obfsObject
``` ```
{ {
'host': ..., 'host': ---,
'path': ... 'path': ---,
} }
``` ```
**host** ### host
+ 类型:*str* + 类型:*str*
+ 说明:http伪装域名 + 说明:http伪装域名
+ 缺省:'' + 缺省:`空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名列表(逗号隔开)
**path** ### path
+ 类型:*str* + 类型:*str*
+ 说明:http伪装路径 + 说明:http伪装路径
+ 缺省:'/' + 缺省:`/`
+ 可选值:不限 + 限制:无
+ 建议值:以`/`开头的合法路径
### tlsObject ## tlsObject
``` ```
{ {
'type': 'tls', 'type': 'tls',
'sni': ..., 'sni': ---,
'alpn': ..., 'alpn': ---,
'verify': ... 'verify': ---,
} }
``` ```
**sni** ### sni
+ 类型:*str* + 类型:*str*
+ 说明:TLS握手SNI字段 + 说明:TLS握手SNI字段
+ 缺省:obfsObject.host[0] / wsObject.host / h2Object.host[0] / '' + 缺省:`obfsObject.host[0]` / `wsObject.host` / `h2Object.host[0]` / `空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名
**alpn** ### alpn
+ 类型:*None* / *str* + 类型:*None* / *str*
+ 说明:TLS握手协商协议 + 说明:TLS握手协商协议
+ 缺省:None + 缺省:`None`
+ 可选值:`h2`,`http/1.1`,`h2,http/1.1` + 限制:`h2`, `http/1.1`, `h2,http/1.1`
+ 建议值:'h2,http/1.1'
**verify** ### verify
+ 类型:*bool* + 类型:*bool*
+ 说明:是否验证服务端证书 + 说明:是否验证服务端证书
+ 缺省:True + 缺省:`True`
+ 可选值:不限 + 限制:无
+ 建议值:True
### xtlsObject ## xtlsObject
``` ```
{ {
'type': 'xtls', 'type': 'xtls',
'sni': ..., 'sni': ---,
'alpn': ..., 'alpn': ---,
'verify': ... 'verify': ---
'flow': ..., 'flow': ---,
'udp443': ... 'udp443': ---,
} }
``` ```
**sni** ### sni
+ 类型:*str* + 类型:*str*
+ 说明:TLS握手SNI字段 + 说明:TLS握手SNI字段
+ 缺省:obfsObject.host[0] / wsObject.host / h2Object.host[0] / '' + 缺省:`obfsObject.host[0]` / `wsObject.host` / `h2Object.host[0]` / `空`
+ 可选值:不限 + 限制:无
+ 建议值:合法域名
**alpn** ### alpn
+ 类型:*None* / *str* + 类型:*None* / *str*
+ 说明:TLS握手协商协议 + 说明:TLS握手协商协议
+ 缺省:None + 缺省:`None`
+ 可选值:`h2`,`http/1.1`,`h2,http/1.1` + 限制:`h2`, `http/1.1`, `h2,http/1.1`
+ 建议值:'h2,http/1.1'
**verify** ### verify
+ 类型:*bool* + 类型:*bool*
+ 说明:是否验证服务端证书 + 说明:是否验证服务端证书
+ 缺省:True + 缺省:`True`
+ 可选值:不限 + 限制:无
+ 建议值:True
**flow** ### flow
+ 类型:*str* + 类型:*str*
+ 说明:XTLS流控算法 + 说明:XTLS流控算法
+ 缺省:'xtls-direct' + 缺省:`xtls-direct`
+ 可选值:`xtls-origin`,`xtls-direct`,`xtls-splice` + 限制:`xtls-origin`, `xtls-direct`, `xtls-splice`
+ 建议值:'xtls-direct' (Linux平台建议`xtls-splice`)
**udp443** ### udp443
+ 类型:*bool* + 类型:*bool*
+ 说明:是否放行UDP/443端口流量 + 说明:是否放行UDP/443端口流量
+ 缺省:False + 缺省:`False`
+ 可选值:不限 + 限制:无
+ 建议值:False

4
docs/ProxyObject/VMess.md

@ -212,7 +212,7 @@
+ 类型:*str* + 类型:*str*
+ 说明:数据包头部伪装类型 + 说明:数据包头部伪装类型
+ 缺省:`none` + 缺省:`none`
+ 限制:`none`,`srtp`,`utp`,`wechat-video`,`dtls`,`wireguard` + 限制:`none`, `srtp`, `utp`, `wechat-video`, `dtls`, `wireguard`
### secure ### secure
@ -244,7 +244,7 @@
+ 类型:*str* + 类型:*str*
+ 说明:gRPC传输模式 + 说明:gRPC传输模式
+ 缺省:`gun` + 缺省:`gun`
+ 限制:`gun`,`multi` + 限制:`gun`, `multi`
### secure ### secure

Loading…
Cancel
Save