vrr/g3
2
0
Fork 0
mirror of https://github.com/bytedance/g3.git synced 2026-04-28 11:40:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

add user guide

Browse source
This commit is contained in:
zhangjingqiang 2023-04-04 11:05:51 +08:00
parent d303359fe6
commit caae0c8c03
7 changed files with 555 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

14
g3proxy/README.md
View file

@ -3,6 +3,10 @@
The g3proxy is an enterprise level forward proxy, but still with basic support for
tcp streaming / tls streaming / transparent proxy / reverse proxy.
## User Guide
[中文版](UserGuide.zh_CN.md)
## Features
### Server
@ -64,7 +68,7 @@ tcp streaming / tls streaming / transparent proxy / reverse proxy.
- TCP Port
- TLS Port
* mTLS
- Intelli Proxy Port
- Intelli Proxy
* Multiple protocol: Http Proxy / Socks Proxy
### Escaper
@ -183,13 +187,7 @@ tcp streaming / tls streaming / transparent proxy / reverse proxy.
## Documents
The detailed docs are resided in the [doc](doc) directory, which describes the configuration & metrics & logs.
To view the docs:
1. [install sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
2. run `make html` in the doc directory
3. open *_build/html/index.html* with your favourite browser
The detailed docs are resided in the [doc](doc) directory.
## Examples