Skip to content

Commit 1405356

Browse files
authored
Merge pull request alibaba#328 from alibaba/ws-docs
add docs about turning on websocket proxy in command
2 parents 4d0a820 + 4244abe commit 1405356

File tree

4 files changed

+17
-0
lines changed

4 files changed

+17
-0
lines changed

docs-src/cn/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* [其他命令](README.md#其他命令)
99
* [作为npm模块启动](README.md#作为npm模块使用)
1010
* [代理HTTPS](README.md#代理https)
11+
* [代理WebSocket](README.md#代理websocket)
1112
* [rule模块](README.md#rule模块)
1213
* [开发示例](README.md#开发示例)
1314
* [处理流程](README.md#处理流程)

docs-src/cn/src_doc.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,14 @@ anyproxy --intercept #启动AnyProxy,并解析所有https请求
200200

201201
* [附录:如何信任CA证书](#证书配置)
202202

203+
# 代理WebSocket
204+
205+
```bash
206+
anyproxy --ws-intercept
207+
```
208+
209+
> 当启用`HTTPS`代理时,`wss`也会被代理,但是不会被AnyProxy记录。需要开启`--ws-intercept`后才会从界面上看到相应内容。
210+
203211
# rule模块
204212

205213
AnyProxy提供了二次开发的能力,你可以用js编写自己的规则模块(rule),来自定义网络请求的处理逻辑。

docs-src/en/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Options](README.md#options)
88
* [As Node Module](README.md#use-anyproxy-as-an-npm-module)
99
* [Proxy HTTPS](README.md#proxy-https)
10+
* [Proxy WebSocket](README.md#proxy-websocket)
1011
* [Rule Introduction](README.md#rule-introduction)
1112
* [Sample](README.md#sample)
1213
* [How Does It Work](README.md#how-does-it-work)

docs-src/en/src_doc.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,13 @@ anyproxy --intercept #launch anyproxy and intercept all https traffic
200200

201201
* [Appendix:how to trust CA](#config-certification)
202202

203+
# Proxy WebSocket
204+
205+
```bash
206+
anyproxy --ws-intercept
207+
```
208+
> The `wss` requests will be handled automatically when the `HTTPS` intercept is turned on, but AnyProxy will not record the data by default. You need to specify the `--ws-intercept` to tell AnyProxy to record it.
209+
203210
# Rule Introduction
204211

205212
AnyProxy provides the ability to load your own rules written in javascript. With rule module, you could customize the logic to handle requests.

0 commit comments

Comments
 (0)