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

108 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2022-08-01 09:02:13 +00:00
### Structure
```json
{
2022-08-31 05:21:29 +00:00
"type": "vmess",
"tag": "vmess-out",
"server": "127.0.0.1",
"server_port": 1080,
"uuid": "bf000d23-0752-40b4-affe-68f7707a9661",
"security": "auto",
"alter_id": 0,
"global_padding": false,
"authenticated_length": true,
"network": "tcp",
"tls": {},
2022-09-23 02:30:07 +00:00
"packet_encoding": "",
2022-08-31 05:21:29 +00:00
"multiplex": {},
"transport": {},
... // Dial Fields
2022-08-01 09:02:13 +00:00
}
```
2022-08-31 05:21:29 +00:00
### Fields
2022-08-01 09:02:13 +00:00
#### server
==Required==
The server address.
#### server_port
==Required==
The server port.
#### uuid
==Required==
The VMess user id.
#### security
Encryption methods:
* `auto`
* `none`
* `zero`
* `aes-128-gcm`
2023-03-01 09:06:31 +00:00
* `chacha20-poly1305`
2022-08-01 09:02:13 +00:00
Legacy encryption methods:
* `aes-128-ctr`
#### alter_id
| Alter ID | Description |
|----------|---------------------|
| 0 | Use AEAD protocol |
| 1 | Use legacy protocol |
| > 1 | Unused, same as 1 |
#### global_padding
Protocol parameter. Will waste traffic randomly if enabled (enabled by default in v2ray and cannot be disabled).
#### authenticated_length
Protocol parameter. Enable length block encryption.
#### network
Enabled network
One of `tcp` `udp`.
Both is enabled by default.
#### tls
TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
2022-08-01 09:02:13 +00:00
2022-09-23 02:30:07 +00:00
#### packet_encoding
2022-08-27 13:32:20 +00:00
2023-02-28 12:27:30 +00:00
UDP packet encoding.
2022-09-23 02:30:07 +00:00
| Encoding | Description |
|------------|-----------------------|
| (none) | Disabled |
| packetaddr | Supported by v2ray 5+ |
| xudp | Supported by xray |
2022-08-27 13:32:20 +00:00
2022-08-04 02:38:20 +00:00
#### multiplex
Multiplex configuration, see [Multiplex](/configuration/shared/multiplex).
2022-08-04 02:38:20 +00:00
2022-08-23 15:15:56 +00:00
#### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport).
2022-08-01 09:02:13 +00:00
### Dial Fields
2022-08-31 05:21:29 +00:00
See [Dial Fields](/configuration/shared/dial) for details.