Browse Source

docs: update proxy description

master
dnomd343 2 years ago
parent
commit
736692c21d
  1. 115
      docs/Proxy.md
  2. 22
      docs/ProxyObject.md

115
docs/Proxy.md

@ -0,0 +1,115 @@
# 代理节点格式
## Shadowsocks
```
{
'type': 'ss',
'name': '...',
'info': ssObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [ssObject](./ProxyObject/Shadowsocks.md):节点信息
## ShadowsocksR
```
{
'type': 'ssr',
'name': '...',
'group': '...',
'info': ssrObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ group:节点群组(可选)
+ [ShadowsocksR](./ProxyObject/ShadowsocksR.md):节点信息
## VMess
```
{
'type': 'vmess',
'name': '...',
'info': vmessObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [vmessObject](./ProxyObject/VMess.md):节点信息
## VLESS
```
{
'type': 'vless',
'name': '...',
'info': vlessObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [vlessObject](./ProxyObject/VLESS.md):节点信息
## Trojan
```
{
'type': 'trojan',
'name': '...',
'info': trojanObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [trojanObject](./ProxyObject/Trojan.md):节点信息
## Trojan-Go
```
{
'type': 'trojan-go',
'name': '...',
'info': trojanGoObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [trojanGoObject](./ProxyObject/TrojanGo.md):节点信息
## Brook
```
{
'type': 'brook',
'name': '...',
'info': brookObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [brookObject](./ProxyObject/Brook.md):节点信息
## Hysteria
```
{
'type': 'hysteria',
'name': '...',
'info': hysteriaObject
}
```
+ type:节点类型
+ name:节点名称(可选)
+ [hysteriaObject](./ProxyObject/Hysteria.md):节点信息

22
docs/ProxyObject.md

@ -1,22 +0,0 @@
# 代理节点格式
```
{
'type': ...,
...
}
```
**type**
+ 类型:*str*
+ 说明:节点类型
+ 缺省:必选
+ 可选值:`ss`,`ssr`,`vmess`,`vless`,`trojan`
### [Shadowsocks](./ProxyObject/Shadowsocks.md)
### [ShadowsocksR](./ProxyObject/ShadowsocksR.md)
### [VMess](./ProxyObject/VMess.md)
### [VLESS](./ProxyObject/VLESS.md)
### [Trojan](./ProxyObject/Trojan.md)
### [Trojan-Go](./ProxyObject/TrojanGo.md)
Loading…
Cancel
Save