Skip to content

Packages

Package map

PackageRoleUse it when
reverseMounted reverse HTTP proxy handlerYou expose a path like /proxy and forward to a resolved upstream target
forwardAbsolute-URI HTTP forward proxy handlerYou need classic HTTP proxying for clients that speak forward-proxy semantics
connectPlain CONNECT tunneling handlerYou need raw tunnel establishment for HTTPS or arbitrary TCP-over-CONNECT
wsproxyWebSocket proxy handlerYou need full-duplex WS proxying with frame hooks
proxyruntimeListener lifecycle managerYour app enables, disables, or restarts proxy listeners dynamically
observeShared hooks and neutral structsYou want a stable extension surface for capture, metrics, or app adapters
cookiesReverse-proxy cookie isolation helpersYou need mounted reverse proxies without browser-cookie collisions
proxyhttpTransport and header helpersYou want shared transport policy, hop-header stripping, and forwarded headers
socketioSocket.IO text packet parserYou want to decode event-style Socket.IO frames from WS traffic
mitmOptional CA and interception helpersYou need development-grade TLS interception building blocks

Typical compositions

Reverse proxy app

Use:

  • reverse
  • cookies
  • observe
  • optionally proxyhttp

Forward proxy app

Use:

  • forward
  • connect
  • proxyruntime
  • observe

WebSocket debugger

Use:

  • wsproxy
  • observe
  • optionally socketio

Proxy control service

Use:

  • proxyruntime
  • your own config repository and REST handlers

What not to import first

If you are new to the module, do not start by importing every package.

Start with the smallest set that matches your use case. This keeps your app architecture clearer and avoids dragging in policies you do not need yet.

Released under the Apache 2.0 License.