github.com/inazumav/sing-box@v0.0.0-20230926072359-ab51429a14f1/docs/configuration/outbound/socks.md (about)

     1  `socks` outbound is a socks4/socks4a/socks5 client.
     2  
     3  ### Structure
     4  
     5  ```json
     6  {
     7    "type": "socks",
     8    "tag": "socks-out",
     9    
    10    "server": "127.0.0.1",
    11    "server_port": 1080,
    12    "version": "5",
    13    "username": "sekai",
    14    "password": "admin",
    15    "network": "udp",
    16    "udp_over_tcp": false | {},
    17  
    18    ... // Dial Fields
    19  }
    20  ```
    21  
    22  ### Fields
    23  
    24  #### server
    25  
    26  ==Required==
    27  
    28  The server address.
    29  
    30  #### server_port
    31  
    32  ==Required==
    33  
    34  The server port.
    35  
    36  #### version
    37  
    38  The SOCKS version, one of `4` `4a` `5`.
    39  
    40  SOCKS5 used by default.
    41  
    42  #### username
    43  
    44  SOCKS username.
    45  
    46  #### password
    47  
    48  SOCKS5 password.
    49  
    50  #### network
    51  
    52  Enabled network
    53  
    54  One of `tcp` `udp`.
    55  
    56  Both is enabled by default.
    57  
    58  #### udp_over_tcp
    59  
    60  UDP over TCP protocol settings.
    61  
    62  See [UDP Over TCP](/configuration/shared/udp-over-tcp) for details.
    63  
    64  ### Dial Fields
    65  
    66  See [Dial Fields](/configuration/shared/dial) for details.