Skip to content

Commit 077e24d

Browse files
authored
Merge pull request #270 from chobits/for_pull_request
updated readme: new nginx version supported and example for websocket
2 parents ab99ab5 + bc64b28 commit 077e24d

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Table of Contents
1515
* [example for curl (CONNECT request in https)](#example-for-curl-connect-request-in-https)
1616
* [example for browser](#example-for-browser)
1717
* [example for basic authentication](#example-for-basic-authentication)
18+
* [example for proxying WebSocket](#example-for-proxying-websocket)
1819
* [Install](#install)
1920
* [select patch](#select-patch)
2021
* [build nginx](#build-nginx)
@@ -327,6 +328,13 @@ We can do access control on CONNECT request using nginx auth basic module.
327328
See [this guide](https://github.com/chobits/ngx_http_proxy_connect_module/issues/42#issuecomment-502985437) for more details.
328329

329330

331+
Example for proxying WebSocket
332+
------------------------------
333+
334+
* Note that nginx has its own WebSocket reverse proxy module, which is is not limited to the CONNECT tunnel, see [nginx.org doc: Nginx WebSocket proxying](https://nginx.org/en/docs/http/websocket.html) and [nginx.com blog: NGINX as a WebSocket Proxy](https://www.nginx.com/blog/websocket-nginx/).
335+
* This module enables the WebSocket protocol to work over the CONNECT tunnel, see https://github.com/chobits/ngx_http_proxy_connect_module/issues/267#issuecomment-1575449174
336+
337+
330338
Install
331339
=======
332340

@@ -348,6 +356,7 @@ Select patch
348356
| 1.19.x ~ 1.21.0 | YES | [proxy_connect_rewrite_1018.patch](patch/proxy_connect_rewrite_1018.patch) |
349357
| 1.21.1 ~ 1.22.x | YES | [proxy_connect_rewrite_102101.patch](patch/proxy_connect_rewrite_102101.patch) |
350358
| 1.23.x ~ 1.24.0 | YES | [proxy_connect_rewrite_102101.patch](patch/proxy_connect_rewrite_102101.patch) |
359+
| 1.25.0 ~ 1.25.x | YES | [proxy_connect_rewrite_102101.patch](patch/proxy_connect_rewrite_102101.patch) |
351360

352361
| OpenResty version | enable REWRITE phase | patch |
353362
| --: | --: | --: |
@@ -714,7 +723,8 @@ Nginx Compatibility
714723

715724
The latest module is compatible with the following versions of nginx:
716725

717-
* 1.23.4 (version of 1.23.x)
726+
* 1.25.0 (mainline version of 1.25.x)
727+
* 1.24.0 (version of 1.24.x)
718728
* 1.22.1 (version of 1.22.x)
719729
* 1.20.2 (version of 1.20.x)
720730
* 1.18.0 (version of 1.18.x)
@@ -731,11 +741,11 @@ OpenResty Compatibility
731741

732742
The latest module is compatible with the following versions of OpenResty:
733743

734-
* 1.13.6 (version: 1.13.6.2)
735-
* 1.15.8 (version: 1.15.8.1)
736-
* 1.17.8 (version: 1.17.8.2)
744+
* 1.21.4 (version: 1.21.4.2 RC1)
737745
* 1.19.3 (version: 1.19.3.1)
738-
* 1.21.4 (version: 1.21.4.1)
746+
* 1.17.8 (version: 1.17.8.2)
747+
* 1.15.8 (version: 1.15.8.1)
748+
* 1.13.6 (version: 1.13.6.2)
739749

740750
Tengine Compatibility
741751
---------------------

0 commit comments

Comments
 (0)