sing-box/docs/configuration/inbound/vmess.md

55 lines
994 B
Markdown
Raw Normal View History

2022-08-01 09:02:13 +00:00
### Structure
```json
{
2022-08-31 04:50:26 +00:00
"type": "vmess",
"tag": "vmess-in",
... // Listen Fields
"users": [
2022-08-01 09:02:13 +00:00
{
2022-08-31 04:50:26 +00:00
"name": "sekai",
"uuid": "bf000d23-0752-40b4-affe-68f7707a9661",
"alterId": 0
2022-08-01 09:02:13 +00:00
}
2022-08-31 04:50:26 +00:00
],
"tls": {},
"multiplex": {},
2022-08-31 04:50:26 +00:00
"transport": {}
2022-08-01 09:02:13 +00:00
}
```
2022-08-31 04:50:26 +00:00
### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details.
### Fields
2022-08-23 15:15:56 +00:00
#### users
==Required==
2022-08-23 15:15:56 +00:00
VMess users.
| Alter ID | Description |
|----------|-------------------------|
| 0 | Disable legacy protocol |
| > 0 | Enable legacy protocol |
!!! warning ""
Legacy protocol support (VMess MD5 Authentication) is provided for compatibility purposes only, use of alterId > 1 is not recommended.
#### tls
TLS configuration, see [TLS](/configuration/shared/tls/#inbound).
2022-08-23 15:15:56 +00:00
#### multiplex
See [Multiplex](/configuration/shared/multiplex#inbound) for details.
2022-08-23 15:15:56 +00:00
#### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport).