Skip to main content

Bandwidth Limit

Limit forwarded bandwidth per tunnel. Configure it under transport on [[tunnels]].

  • bandwidthLimitSide = "client": limit on the client
  • bandwidthLimitSide = "server": limit on the server

bandwidth is a number in Mbps (e.g. 2, 0.5). 0 means unlimited.

Example: Limit on the client

# orbien.toml
[[tunnels]]
name = "web"
protocol = "tcp"
service = "127.0.0.1:80"
remotePort = 9000
transport.bandwidth = 2
transport.bandwidthLimitSide = "client"

Example: Limit on the server

# orbien.toml
[[tunnels]]
name = "web"
protocol = "tcp"
service = "127.0.0.1:80"
remotePort = 9000
transport.bandwidth = 0.5
transport.bandwidthLimitSide = "server"

Parameters

ParameterRequiredDefaultDescription
transport.bandwidthNo0Bandwidth cap (Mbps); 0 means unlimited
transport.bandwidthLimitSideNoclientLimit side: client / server