[4.7.0] Add Documentation for WebSocket Proxy Profiles

[hisanhunais]

Purpose

Adds a new documentation page for the WebSocket Proxy Profiles feature introduced in WSO2 API Manager 4.7.0.

The WebSocket proxy profile feature allows the Classic Gateway to route outbound WebSocket connections (gateway → backend) through one or more HTTP CONNECT proxies. This is useful in network environments where backend WebSocket services are not directly reachable from the gateway and must be accessed through a corporate or department-level proxy.

The page covers:

• Overview — what proxy profiles are and when to use them
• How It Works — the profile matching logic: specific profiles evaluated first, catch-all as fallback, bypass_hosts precedence
• Configuration — [[transport.ws.proxy_profile]] and [[transport.wss.proxy_profile]] parameters with a full reference table
• Scenarios — step-by-step examples for:
  • Anonymous proxy
  • Authenticated proxy (Basic auth)
  • Bypassing the proxy for selected hosts
  • Catch-all profile with exclusions
  • Connecting to a wss:// backend through a proxy (including truststore setup)
• Limitations — restart requirement, regex matching behavior, ordering rules, Basic auth only, ws/wss independence

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5bc6eb92-ffef-4337-a504-ce64c3128108

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}