github.com/sagernet/sing-box@v1.9.0-rc.20/docs/configuration/outbound/vmess.md (about)

     1  ### Structure
     2  
     3  ```json
     4  {
     5    "type": "vmess",
     6    "tag": "vmess-out",
     7    
     8    "server": "127.0.0.1",
     9    "server_port": 1080,
    10    "uuid": "bf000d23-0752-40b4-affe-68f7707a9661",
    11    "security": "auto",
    12    "alter_id": 0,
    13    "global_padding": false,
    14    "authenticated_length": true,
    15    "network": "tcp",
    16    "tls": {},
    17    "packet_encoding": "",
    18    "transport": {},
    19    "multiplex": {},
    20  
    21    ... // Dial Fields
    22  }
    23  ```
    24  
    25  ### Fields
    26  
    27  #### server
    28  
    29  ==Required==
    30  
    31  The server address.
    32  
    33  #### server_port
    34  
    35  ==Required==
    36  
    37  The server port.
    38  
    39  #### uuid
    40  
    41  ==Required==
    42  
    43  The VMess user id.
    44  
    45  #### security
    46  
    47  Encryption methods:
    48  
    49  * `auto`
    50  * `none`
    51  * `zero`
    52  * `aes-128-gcm`
    53  * `chacha20-poly1305`
    54  
    55  Legacy encryption methods:
    56  
    57  * `aes-128-ctr`
    58  
    59  #### alter_id
    60  
    61  | Alter ID | Description         |
    62  |----------|---------------------|
    63  | 0        | Use AEAD protocol   |
    64  | 1        | Use legacy protocol |
    65  | > 1      | Unused, same as 1   |
    66  
    67  #### global_padding
    68  
    69  Protocol parameter. Will waste traffic randomly if enabled (enabled by default in v2ray and cannot be disabled).
    70  
    71  #### authenticated_length
    72  
    73  Protocol parameter. Enable length block encryption.
    74  
    75  #### network
    76  
    77  Enabled network
    78  
    79  One of `tcp` `udp`.
    80  
    81  Both is enabled by default.
    82  
    83  #### tls
    84  
    85  TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
    86  
    87  #### packet_encoding
    88  
    89  UDP packet encoding.
    90  
    91  | Encoding   | Description           |
    92  |------------|-----------------------|
    93  | (none)     | Disabled              |
    94  | packetaddr | Supported by v2ray 5+ |
    95  | xudp       | Supported by xray     |
    96  
    97  #### multiplex
    98  
    99  See [Multiplex](/configuration/shared/multiplex#outbound) for details.
   100  
   101  #### transport
   102  
   103  V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
   104  
   105  ### Dial Fields
   106  
   107  See [Dial Fields](/configuration/shared/dial/) for details.