mirror of
https://github.com/bytedance/g3.git
synced 2026-04-28 03:30:31 +00:00
update doc
This commit is contained in:
parent
3d50b176ea
commit
c319979e21
8 changed files with 35 additions and 8 deletions
|
|
@ -75,6 +75,8 @@ HTTP 1.x、HTTP 2、HTTP 3、TLSハンドシェイク、DNS、Cloudflare Keyless
|
|||
|
||||
g3proxyのための偽の証明書ジェネレーター。
|
||||
|
||||
[詳細な紹介](g3fcgen/README.md)
|
||||
|
||||
### g3iploc
|
||||
|
||||
g3proxyのGeoIPサポートのためのIPロケーションルックアップサービス。
|
||||
|
|
|
|||
|
|
@ -76,6 +76,8 @@ A tool to make root CA / intermediate CA / TLS server / TLS client certificates.
|
|||
|
||||
Fake certificate generator for g3proxy.
|
||||
|
||||
[README](g3fcgen/README.md)
|
||||
|
||||
### g3iploc
|
||||
|
||||
IP location lookup service for g3proxy GeoIP support.
|
||||
|
|
|
|||
|
|
@ -73,6 +73,8 @@ StatsD兼容的监控打点指标聚合服务。
|
|||
|
||||
适用于g3proxy TLS劫持功能的伪造证书生成服务应用。
|
||||
|
||||
[详细介绍](g3fcgen/README.md)
|
||||
|
||||
### g3iploc
|
||||
|
||||
适用于g3proxy GeoIP功能的IP Location查找服务应用。
|
||||
|
|
|
|||
|
|
@ -2,6 +2,22 @@
|
|||
|
||||
Benchmark tool for HTTP 1.x / HTTP 2 / HTTP 3 / TLS Handshake / DNS / Cloudflare Keyless.
|
||||
|
||||
## How to build
|
||||
|
||||
To build debug binaries:
|
||||
|
||||
```shell
|
||||
cargo build -p g3bench
|
||||
```
|
||||
|
||||
To build release binaries:
|
||||
|
||||
```shell
|
||||
cargo build --profile release-lto -p g3bench
|
||||
```
|
||||
|
||||
See [Build and Package](../doc/build_and_package.md) if you want to build binary packages or docker images.
|
||||
|
||||
## Features
|
||||
|
||||
### General
|
||||
|
|
|
|||
|
|
@ -1,29 +1,34 @@
|
|||
# g3fcgen
|
||||
|
||||
g3fcgen is a server certificate generator/issuer to be used with g3proxy to enable TLS interception.
|
||||
The protocol is defined [here](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/protocol/helper/cert_generator.html).
|
||||
The protocol is
|
||||
defined [here](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/protocol/helper/cert_generator.html).
|
||||
|
||||
g3fcgen is designed to run with g3proxy on the same host.
|
||||
It is recommended to write you own implementation if you need to:
|
||||
|
||||
- serve a cluster of g3proxy instances
|
||||
- cache the generated server certificate for a much longer time
|
||||
- add custom certificate issue methods
|
||||
- serve a cluster of g3proxy instances
|
||||
- cache the generated server certificate for a much longer time
|
||||
- add custom certificate issue methods
|
||||
|
||||
## How to build
|
||||
|
||||
To build debug binaries:
|
||||
|
||||
```shell
|
||||
cargo build -p g3fcgen
|
||||
```
|
||||
|
||||
To build release binaries:
|
||||
|
||||
```shell
|
||||
cargo build --profile release-lto -p g3fcgen
|
||||
```
|
||||
|
||||
To support SM2 certificates, you need to use *Tongsuo* by adding `--features vendored-tongsuo`.
|
||||
|
||||
See [Build and Package](../doc/build_and_package.md) if you want to build binary packages or docker images.
|
||||
|
||||
## How to run
|
||||
|
||||
### Example
|
||||
|
|
@ -43,7 +48,7 @@ There are two ways to change the UDP listen port:
|
|||
You can set **-G port<port>** or **--group-name port<port>** to change the UDP listen port,
|
||||
the final listen address will be **[::]:<port>**.
|
||||
|
||||
You can set the systemd instance name to *port<port>*, so when you run `systemctl start g3fcgen@port<port>`,
|
||||
You can set the systemd instance name to *port<port>*, so when you run `systemctl start g3fcgen@port<port>`,
|
||||
it will listen to the correct port automatically.
|
||||
|
||||
- Via environment variables
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ To build release binaries:
|
|||
cargo build --profile release-lto -p g3keymess -p g3keymess-ctl
|
||||
```
|
||||
|
||||
See [Packaging](../doc/packaging.md) if you want to build binary packages or docker images.
|
||||
See [Build and Package](../doc/build_and_package.md) if you want to build binary packages or docker images.
|
||||
|
||||
## Features
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ To build release binaries:
|
|||
cargo build --profile release-lto -p g3proxy -p g3proxy-ctl
|
||||
```
|
||||
|
||||
See [Packaging](../doc/packaging.md) if you want to build binary packages or docker images.
|
||||
See [Build and Package](../doc/build_and_package.md) if you want to build binary packages or docker images.
|
||||
|
||||
## Documents
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ To build release binaries:
|
|||
cargo build --profile release-lto -p g3statsd -p g3statsd-ctl
|
||||
```
|
||||
|
||||
See [Packaging](../doc/packaging.md) if you want to build binary packages or docker images.
|
||||
See [Build and Package](../doc/build_and_package.md) if you want to build binary packages or docker images.
|
||||
|
||||
## Supported Metric Types
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue