Merge pull request #328 from alibaba/ws-docs

add docs about turning on websocket proxy in command
This commit is contained in:
Otto Mao 2018-02-05 11:08:49 +08:00 committed by GitHub
commit 1405356292
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 0 deletions

View File

@ -8,6 +8,7 @@
* [其他命令](README.md#其他命令)
* [作为npm模块启动](README.md#作为npm模块使用)
* [代理HTTPS](README.md#代理https)
* [代理WebSocket](README.md#代理websocket)
* [rule模块](README.md#rule模块)
* [开发示例](README.md#开发示例)
* [处理流程](README.md#处理流程)

View File

@ -200,6 +200,14 @@ anyproxy --intercept #启动AnyProxy并解析所有https请求
* [附录如何信任CA证书](#证书配置)
# 代理WebSocket
```bash
anyproxy --ws-intercept
```
> 当启用`HTTPS`代理时,`wss`也会被代理但是不会被AnyProxy记录。需要开启`--ws-intercept`后才会从界面上看到相应内容。
# rule模块
AnyProxy提供了二次开发的能力你可以用js编写自己的规则模块rule来自定义网络请求的处理逻辑。

View File

@ -7,6 +7,7 @@
* [Options](README.md#options)
* [As Node Module](README.md#use-anyproxy-as-an-npm-module)
* [Proxy HTTPS](README.md#proxy-https)
* [Proxy WebSocket](README.md#proxy-websocket)
* [Rule Introduction](README.md#rule-introduction)
* [Sample](README.md#sample)
* [How Does It Work](README.md#how-does-it-work)

View File

@ -200,6 +200,13 @@ anyproxy --intercept #launch anyproxy and intercept all https traffic
* [Appendixhow to trust CA](#config-certification)
# Proxy WebSocket
```bash
anyproxy --ws-intercept
```
> 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.
# Rule Introduction
AnyProxy provides the ability to load your own rules written in javascript. With rule module, you could customize the logic to handle requests.