Skip to content

Socks server

Socks inbound configuration

Example:

tag: proxy
type: socks
bind-addr: "0.0.0.0:1089" # or "[::]:1089" for dualstack
users:
 - username: "username"
   password: "password"

Fields

tag

  • Type: string
  • Required: yes

Required label for this endpoint.

default-outbound

  • Type: string (optional)
  • Required: no

Outbound this inbound prefers, stamped on every accepted request as UserContext::preferred_outbound. A router script may honor or override it; without a router it selects the outbound, and unset falls back to the global default.

bind-addr

  • Type: SocketAddr
  • Required: yes

Server binding address. e.g. 0.0.0.0:1089, [::1]:1089

users

  • Type: list of AuthUser
  • Required: no
  • Default: Vec::new()

Socks5 username, optional Left empty to disable authentication