dnomd343
/
ProxyC
mirror of https://github.com/dnomd343/ProxyC
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

docs: update describe of TrojanGo, Brook and Hysteria

master
dnomd343 2 years ago
parent
e8dce9f565
commit
dadc731e95
4 changed files with 162 additions and 173 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 83
      docs/ProxyObject/Brook.md
  2. 92
      docs/ProxyObject/Hysteria.md
  3. 4
      docs/ProxyObject/Shadowsocks.md
  4. 156
      docs/ProxyObject/TrojanGo.md

83
docs/ProxyObject/Brook.md
View File

@ -1,95 +1,84 @@
## Brook ## brookObject
> **remark**
>
> + 类型：*str*
> + 说明：节点备注名称
> + 缺省：''
> + 可选值：不限
``` ```
{ {
'type': 'brook', 'server': ---,
'server': ..., 'port': ---,
'port': ..., 'passwd': ---,
'passwd': ..., 'ws': ---,
'ws': ...
} }
``` ```
**server** ### server
+ 类型：*str* + 类型：*str*
+ 说明：服务器地址 + 说明：Brook服务地址
+ 缺省：必选 + 缺省：必选
+ 可选值：合法的IP地址或域名 + 限制：IP地址或域名
**port** ### port
+ 类型：*int* + 类型：*int*
+ 说明：服务器端口 + 说明：Brook服务端口
+ 缺省：必选 + 缺省：必选
+ 可选值：1 ～ 65535 + 限制：1 ～ 65535
**passwd** ### passwd
+ 类型：*str* + 类型：*str*
+ 说明：Brook连接密码 + 说明：Brook连接密码
+ 缺省：必选 + 缺省：必选
+ 可选值：不限 + 限制：无
**ws** ### ws
+ 类型：*None* / *wsObject* + 类型：*None* / [*wsObject*](#wsobject)
+ 说明：WebSocket传输配置 + 说明：WebSocket传输配置
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
### wsObject ## wsObject
``` ```
{ {
'host': ..., 'host': ---,
'path': ..., 'path': ---,
'secure': ... 'secure': ---,
} }
``` ```
**host** ### host
+ 类型：*str* + 类型：*str*
+ 说明：Websocket连接域名 + 说明：Websocket连接域名
+ 缺省：'' + 缺省：`空`
+ 可选值：不限 + 限制：无
+ 建议值：合法域名
**path** ### path
+ 类型：*str* + 类型：*str*
+ 说明：Websocket连接路径 + 说明：Websocket连接路径
+ 缺省：'/' + 缺省：`/`
+ 可选值：不限 + 限制：无
+ 建议值：以`/`开头的合法路径
**secure** ### secure
+ 类型：*None* / *secureObject* + 类型：*None* / [*secureObject*](#secureobject)
+ 说明：TLS加密配置 + 说明：TLS加密配置
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
### secureObject ## secureObject
``` ```
{ {
'verify': ... 'verify': ---,
} }
``` ```
**verify** ### verify
+ 类型：*bool* + 类型：*bool*
+ 说明：是否验证服务端证书 + 说明：是否验证服务端证书
+ 缺省：True + 缺省：`True`
+ 可选值：不限 + 限制：无
+ 建议值：True

92
docs/ProxyObject/Hysteria.md
View File

@ -1,80 +1,86 @@
## Hysteria ## hysteriaObject
> **remark**
>
> + 类型：*str*
> + 说明：节点备注名称
> + 缺省：''
> + 可选值：不限
``` ```
{ {
'type': 'hysteria', 'server': ---,
'server': ..., 'port': ---,
'port': ..., 'protocol': ---,
'protocol': ..., 'upMbps': ---,
'obfs': ..., 'downMbps': ---,
'auth': ..., 'obfs': ---,
'sni': ..., 'auth': ---,
'alpn': ..., 'sni': ---,
'verify': ... 'alpn': ---,
'verify': ---,
} }
``` ```
**server** ### server
+ 类型：*str* + 类型：*str*
+ 说明：服务器地址 + 说明：Hysteria服务地址
+ 缺省：必选 + 缺省：必选
+ 可选值：合法的IP地址或域名 + 限制：IP地址或域名
**port** ### port
+ 类型：*int* + 类型：*int*
+ 说明：服务器端口 + 说明：Hysteria服务端口
+ 缺省：必选 + 缺省：必选
+ 可选值：1 ～ 65535 + 限制：1 ～ 65535
**protocol** ### protocol
+ 类型：*str* + 类型：*str*
+ 说明：Hysteria连接方式 + 说明：Hysteria连接方式
+ 缺省：'udp' + 缺省：`udp`
+ 可选值：`udp`,`wechat-video`,`faketcp` + 限制：`udp`, `wechat-video`, `faketcp`
### upMbps
+ 类型：*int*
+ 说明：Hysteria最大上行速率
+ 缺省：`10`
+ 限制：>0
### downMbps
+ 类型：*int*
+ 说明：Hysteria最大下行速率
+ 缺省：`50`
+ 限制：>0
**obfs** ### obfs
+ 类型：*None* / *str* + 类型：*None* / *str*
+ 说明：Hysteria混淆密码 + 说明：Hysteria混淆密码
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
**auth** ### auth
+ 类型：*None* / *str* + 类型：*None* / *str*
+ 说明：Hysteria验证密码 + 说明：Hysteria验证密码
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
**sni** ### sni
+ 类型：*str* + 类型：*str*
+ 说明：TLS握手SNI字段 + 说明：TLS握手SNI字段
+ 缺省： '' + 缺省：`无`
+ 可选值：不限 + 限制：无
+ 建议值：合法域名
**alpn** ### alpn
+ 类型：*None* / *str* + 类型：*None* / *str*
+ 说明：TLS握手协商协议 + 说明：TLS握手协商协议
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
**verify** ### verify
+ 类型：*bool* + 类型：*bool*
+ 说明：是否验证服务端证书 + 说明：是否验证服务端证书
+ 缺省：True + 缺省：`True`
+ 可选值：不限 + 限制：无
+ 建议值：True

4
docs/ProxyObject/Shadowsocks.md
View File

@ -101,7 +101,7 @@
### type ### type
+ 类型：*str* + 类型：*str*
+ 说明：插件名称 + 说明：SIP003插件名称
+ 缺省：必选 + 缺省：必选
+ 限制：（以下12种插件名称） + 限制：（以下12种插件名称）
@ -116,6 +116,6 @@
### param ### param
+ 类型：*str* + 类型：*str*
+ 说明：插件参数 + 说明：SIP003插件参数
+ 缺省：`空` + 缺省：`空`
+ 限制：无 + 限制：无

156
docs/ProxyObject/TrojanGo.md
View File

@ -1,161 +1,155 @@
## Trojan-Go ## trojanGoObject
> **remark**
>
> + 类型：*str*
> + 说明：节点备注名称
> + 缺省：''
> + 可选值：不限
``` ```
{ {
'type': 'trojan-go', 'server': ---,
'server': ..., 'port': ---,
'port': ..., 'passwd': ---,
'passwd': ..., 'sni': ---,
'sni': ..., 'alpn': ---,
'alpn': ..., 'verify': ---,
'verify': ..., 'ws': ---,
'ws': ..., 'ss': ---,
'ss': ..., 'plugin': ---,
'plugin': ...
} }
``` ```
**server** ### server
+ 类型：*str* + 类型：*str*
+ 说明：服务器地址 + 说明：TrojanGo服务地址
+ 缺省：必选 + 缺省：必选
+ 可选值：合法的IP地址或域名 + 限制：IP地址或域名
**port** ### port
+ 类型：*int* + 类型：*int*
+ 说明：服务器端口 + 说明：TrojanGo服务端口
+ 缺省：必选 + 缺省：必选
+ 可选值：1 ～ 65535 + 限制：1 ～ 65535
**passwd** ### passwd
+ 类型：*str* + 类型：*str*
+ 说明：Trojan连接密码 + 说明：TrojanGo连接密码
+ 缺省：必选 + 缺省：必选
+ 可选值：不限 + 限制：无
**sni** ### sni
+ 类型：*str* + 类型：*str*
+ 说明：TLS握手SNI字段 + 说明：TLS握手SNI字段
+ 缺省： '' + 缺省：`无`
+ 可选值：不限 + 限制：无
+ 建议值：合法域名
**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
**ws** ### ws
+ 类型：*None* / *wsObject* + 类型：*None* / [*wsObject*](#wsobject)
+ 说明：WebSocket连接配置 + 说明：WebSocket连接配置
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
**ss** ### ss
+ 类型：*None* / *ssObject* + 类型：*None* / [*ssObject*](#ssobject)
+ 说明：Shadowsocks加密配置 + 说明：Shadowsocks加密配置
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
**plugin** ### plugin
+ 类型：*None* / *pluginObject* + 类型：*None* / [*pluginObject*](#pluginobject)
+ 说明：SIP003插件 + 说明：SIP003插件选项
+ 缺省：None + 缺省：`None`
+ 可选值：不限 + 限制：无
### wsObject ## wsObject
``` ```
{ {
'host': ..., 'host': ---,
'path': ... 'path': ---,
} }
``` ```
**host** ### host
+ 类型：*str* + 类型：*str*
+ 说明：Websocket连接域名 + 说明：Websocket连接域名
+ 缺省：'' + 缺省：`空`
+ 可选值：不限 + 限制：无
+ 建议值：合法域名
**path** ### path
+ 类型：*str* + 类型：*str*
+ 说明：Websocket连接路径 + 说明：Websocket连接路径
+ 缺省：'/' + 缺省：`/`
+ 可选值：不限 + 限制：无
+ 建议值：以`/`开头的合法路径
### ssObject ## ssObject
``` ```
{ {
'method': ..., 'method': ---,
'passwd': ... 'passwd': ---,
} }
``` ```
**method** ### method
+ 类型：*str* + 类型：*str*
+ 说明：Shadowsocks流加密方式 + 说明：Shadowsocks流加密方式
+ 缺省：'AES-128-GCM' + 缺省：`aes-128-gcm`
+ 可选值：`AES-128-GCM`,`AES-256-GCM`,`CHACHA20-IETF-POLY1305` + 限制：`aes-128-gcm`, `aes-256-gcm`, `chacha20-ietf-poly1305`
+ 建议值：x86平台使用AES方式，ARM平台使用CHACHA20方式
**passwd** ### passwd
+ 类型：*str* + 类型：*str*
+ 说明：Shadowsocks密码 + 说明：Shadowsocks密码
+ 缺省：'' + 缺省：`空`
+ 可选值：不限 + 限制：无
### pluginObject ## pluginObject
``` ```
{ {
'type': ..., 'type': ---,
'param': ... 'param': ---,
} }
``` ```
**type** ### type
+ 类型：*str* + 类型：*str*
+ 说明：SIP003插件名称 + 说明：SIP003插件名称
+ 缺省：必选 + 缺省：必选
+ 可选值：`obfs-local`,`simple-tls`,`v2ray-plugin`,`xray-plugin`,`kcptun-client`,`gost-plugin`,`ck-client`,`gq-client`,`mtt-client`,`rabbit-plugin`,`qtun-client`,`gun-plugin` + 限制：（以下12种插件名称）
`obfs-local`, `simple-tls`
`kcptun-client`, `qtun-client`, `gun-plugin`
`v2ray-plugin`, `xray-plugin`, `gost-plugin`
`ck-client`, `gq-client`, `mtt-client`, `rabbit-plugin`
**param** ### param
+ 类型：*str* + 类型：*str*
+ 说明：SIP003插件参数 + 说明：SIP003插件参数
+ 缺省：'' + 缺省：`空`
+ 可选值：不限 + 限制：无

Write Preview
Loading…
Cancel
Save