How musixal/backhaul works
Backhaul is a reverse-tunneling application with client and server roles. The main workflow loads TOML configuration, selects a role and transport, then establishes tunnel connections that carry traffic between configured local ports and the remote side. The README also documents UDP forwarding, multiplexing, WebSocket/TLS transports, traffic monitoring, and configuration reload. Transport internals are only partly excerpted, so links inferred solely from the source index are limited to its recorded module references.
Main entry points: client.go Client dispatcher · server.go Server dispatcher · cmd.go Config loading · tcp_handler.go TCP relay
Components 23
Application runtime
- Process and reload
main.go - Config loading
cmd/cmd.go - Config schema
config/config.go - Client dispatcher
internal/client/client.go - Server dispatcher
internal/server/server.go
Client transports
- Client TCP
internal/client/transport/tcp.go - Client TCP mux
internal/client/transport/tcpmux.go - Client UDP
internal/client/transport/udp.go - Client WebSocket
internal/client/transport/ws.go - Client WS mux
internal/client/transport/wsmux.go - Client UDP accept
internal/client/transport/accept_udp.go
Server transports
- Server TCP
internal/server/transport/tcp.go - Server TCP mux
internal/server/transport/tcpmux.go - Server UDP
internal/server/transport/udp.go - Server WebSocket
internal/server/transport/ws.go - Server WS mux
internal/server/transport/wsmux.go - Server UDP accept
internal/server/transport/accept_udp.go
Shared services
- TCP relay
internal/utils/handlers/tcp_handler.go - WebSocket relay
internal/utils/handlers/ws_handler.go - Network dialers
internal/utils/network - Traffic monitor
internal/web/sniffer.go
Other components
- Operator
- TOML configuration
Connections 31
- Operator → Process and reload: starts
main.go - Process and reload → Config loading: runs
main.go - Process and reload → Config loading: reloads
main.go - TOML configuration → Config loading: provides settings
cmd/cmd.go - Config loading → Config schema: decodes into
cmd/cmd.go - Config loading → Client dispatcher: starts client
cmd/cmd.go - Config loading → Server dispatcher: starts server
cmd/cmd.go - Client dispatcher → Client TCP: selects TCP
internal/client/client.go - Client dispatcher → Client TCP mux: selects TCP mux
internal/client/client.go - Client dispatcher → Client UDP: selects UDP
internal/client/client.go - Client dispatcher → Client WebSocket: selects WS
internal/client/client.go - Client dispatcher → Client WS mux: selects WS mux
internal/client/client.go - Server dispatcher → Server TCP: selects TCP
internal/server/server.go - Server dispatcher → Server TCP mux: selects TCP mux
internal/server/server.go - Server dispatcher → Server UDP: selects UDP
internal/server/server.go - Server dispatcher → Server WebSocket: selects WS
internal/server/server.go - Server dispatcher → Server WS mux: selects WS mux
internal/server/server.go - Client TCP → Network dialers: uses dialing
internal/client/transport/tcp.go - Client TCP mux → Network dialers: uses dialing
internal/client/transport/tcpmux.go - Client UDP → Client UDP accept: delegates UDP handling
- Server UDP → Server UDP accept: delegates UDP handling
- Client TCP → TCP relay: uses relay
internal/client/transport/tcp.go - Client TCP mux → TCP relay: uses relay
internal/client/transport/tcpmux.go - Client WebSocket → WebSocket relay: uses relay
internal/client/transport/ws.go - Client WS mux → WebSocket relay: uses relay
internal/client/transport/wsmux.go - Server TCP → TCP relay: uses relay
internal/server/transport/tcp.go - Server TCP mux → TCP relay: uses relay
internal/server/transport/tcpmux.go - Server WebSocket → WebSocket relay: uses relay
internal/server/transport/ws.go - Server WS mux → WebSocket relay: uses relay
internal/server/transport/wsmux.go - TCP relay → Traffic monitor: updates usage
internal/utils/handlers/tcp_handler.go - WebSocket relay → Traffic monitor: updates usage
internal/utils/handlers/ws_handler.go