socks remote_server

The socks remote_server binding accepts inbound streams and forwards them to the appropriate exit based on the bound address established by a paired remote_client.

socks_remote_server:
  type: socks
  kind: remote_server
  entry: socks_server
  routes:
    - exit: app_server
      when:
        - bind: 0.0.0.0:0

Configuration (* required)

entry*

string | Pattern: ^[a-zA-Z]+[a-zA-Z0-9\\._\\-]*$

The name of the binding that will be the entry point for inbound streams.

socks_remote_server:
  type: socks
  kind: remote_server
  entry: socks_server

routes

array

Conditional socks specific routes.

routes[].guarded

object as map of named array of string

List of roles required by each named guard to authorize this route.

routes[].when

array

List of conditions (any match) to match this route. Read more: When a route matches

when[].bind

string

Remote address to bind for the SOCKS5 connection.

routes[].with

object

Route with override configuration.

routes[].exit

string

Next binding when following this route.

telemetry

object

Defines the desired telemetry for the binding.

telemetry.metrics

array

Telemetry metrics to track

telemetry:
  metrics:
    - stream.*

telemetry.attributes

object as map of named string properties

Telemetry attributes to add to the binding metrics.

exit

string

Default exit binding when no conditional routes are viable.

exit: echo_server

telemetry.attributes

object as map of named string properties

Telemetry attributes for this binding.