Module Apache mod_proxy_wstunnel

Sommaire

Pour utiliser ce module, mod_proxy doit être chargé. Il fournit le support du tunnelling pour les connexions websocket vers un serveur websockets d'arrière-plan. La connexion est automatiquement promue en connexion websocket :

Upgrade: WebSocket
Connection: Upgrade

Le mandatement des requêtes vers un serveur websockets comme echo.websocket.org peut être configuré via la directive ProxyPass :

ProxyPass "/ws2/"  "ws://echo.websocket.org/"
ProxyPass "/wss2/" "wss://echo.websocket.org/"

Il est possible de mandater les websockets et HTTP en même temps, avec un jeu spécifique d'URLs pour les websockets, en définissant la directive ProxyPass concernant les websockets avant celle concernant HTTP :

ProxyPassMatch ^/(myApp/ws)$  ws://backend.example.com:9080/$1
ProxyPass / http://backend.example.com:9080/

Il est possible de mandater les websockets et HTTP en même temps, lorsque les URLs websockets ne concernent pas uniquement les websockets ou ne sont pas connues à l'avance, en utilisant la directive RewriteRule pour configurer le mandatement des websockets :

ProxyPass / http://example.com:9080/
RewriteEngine on
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteCond %{HTTP:Connection} upgrade [NC]
RewriteRule ^/?(.*) "ws://example.com:9080/$1" [P,L]

La répartition de charge entre plusieurs serveurs d'arrière-plan peut être configurée via le module mod_proxy_balancer.

En fait, ce module permet d'accepter d'autres protocoles ; vous pouvez à cet effet utiliser le paramètre upgrade de la directive ProxyPass. La valeur NONE signifie que vous court-circuitez la consultation de l'en-tête, mais que vous autorisez quand-même WebSocket. La valeur ANY signifie que Upgrade va lire les en-têtes de la requête et les utilisera dans l'en-tête Upgrade de la réponse.

Directives

• ProxyWebsocketFallbackToProxyHttp

Traitement des bugs

• Journal des modifications de httpd
• Problèmes connus
• Signaler un bug

Voir aussi

• mod_proxy
• Commentaires