You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1.8 KiB

Socks

The Socks protocol is a standard protocol implementation that is compatible with Socks 5.

::: danger The Socks protocol does not provide encryption for transmission and is not suitable for transmitting data over public networks. :::

OutboundConfigurationObject

{
  "servers": [
    {
      "address": "127.0.0.1",
      "port": 1234,
      "users": [
        {
          "user": "test user",
          "pass": "test pass",
          "level": 0
        }
      ]
    }
  ]
}

servers: [ ServerObject ]

An array representing a list of Socks servers, where each item is a server configuration.

ServerObject

{
  "address": "127.0.0.1",
  "port": 1234,
  "users": [
    {
      "user": "test user",
      "pass": "test pass",
      "level": 0
    }
  ]
}

address: address

The server address. Required.

::: tip Only connections to Socks 5 servers are supported. :::

port: number

The server port. Required.

users: [ UserObject ]

An array representing a list of users. Each item in the array is a user configuration.

When the list is not empty, the Socks client will authenticate using the user information. If not specified, no authentication is performed.

The default value is an empty array.

UserObject

{
  "user": "test user",
  "pass": "test pass",
  "level": 0
}

user: string

The username. Required.

pass: string

The password. Required.

level: number

The user level. Connections will use the corresponding local policy associated with this user level.

The level value corresponds to the level value in the policy. If not specified, the default value is 0.