Documentation
¶
Overview ¶
Command unbounded-rig runs freddie (signaling), the broflake egress (SOCKS5 over QUIC-over-WebSocket), and a native broflake widget in a single process. It exists to provide the server-side topology for a live-machine e2e test of lantern-box's unbounded outbound.
The binary is deployed to an ephemeral VM (currently a DigitalOcean droplet, see .github/workflows/e2e.yaml). A CI-side lantern-box then points its unbounded outbound at the VM's public IP. This validates the full chain — real TLS, real STUN, real NAT traversal, a real quic-go QUIC transport between two distinct processes — which the in-process test at test/e2e/unbounded_test.go cannot.
Wire-compatible knobs:
FREDDIE_ADDR listen address for the signaling server (default :9000)
EGRESS_ADDR listen address for the egress server (default :8000)
STUN_SERVER STUN server URL for widget's ICE batch
(default stun:stun.l.google.com:19302)
TLS_CERT_FILE PEM path; used by both freddie and egress TLS
TLS_KEY_FILE PEM path; used by both freddie and egress TLS
The egress wraps a go-socks5 server so SOCKS5 CONNECT requests exit to the public internet. The widget is configured with ClientType=widget and connects to freddie as a volunteer; it pairs with whichever consumer arrives first.
Source Files