Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rui.zheng committed Jan 7, 2017
1 parent 2508491 commit fb3796e
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ gost - GO Simple Tunnel
* 支持HTTP 2.0 (2.2+)
* 实验性支持QUIC (2.3+)
* 支持KCP协议 (2.3+)
* 透明代理 (2.3+)

二进制文件下载:https://github.com/ginuerzh/gost/releases

Expand Down Expand Up @@ -55,6 +56,8 @@ protocol: 代理协议类型(http, socks5, shadowsocks), transport: 数据传输
> kcp - 作为KCP代理,kcp://:8388或kcp://aes:123456@:8388
> redirect - 作为透明代理,redirect://:12345
#### 端口转发

适用于-L参数
Expand Down Expand Up @@ -238,6 +241,13 @@ gost -L=kcp://:8388?c=/path/to/conf/file
**注:** 客户端若要开启KCP转发,当且仅当代理链不为空且首个代理节点(第一个-F参数)为kcp类型。
当KCP转发开启,代理链中的其他代理节点将被忽略。

#### 透明代理
基于iptables的透明代理。

```bash
gost -L=redirect://:12345 -F=http2://server_ip:443
```

加密机制
------
#### HTTP
Expand Down
43 changes: 43 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Features
* HTTP 2.0 support (2.2+)
* Experimental QUIC support (2.3+)
* KCP protocol support (2.3+)
* Transparent proxy (2.3+)

Binary file download:https://github.com/ginuerzh/gost/releases

Expand Down Expand Up @@ -55,6 +56,8 @@ transport: data transmission mode (ws, wss, tls, http2, quic, kcp), may be used
> kcp - standard KCP tunnel,kcp://:8388 or kcp://aes:123456@:8388
> redirect - transparent proxy,redirect://:12345
#### Port forwarding

Effective for the -L parameter
Expand All @@ -68,6 +71,26 @@ scheme://[bind_address]:port/[host]:hostport
> host:hostport - target address
#### Configuration file

> -C : specifies the configuration file path
The configuration file is in standard JSON format:
```json
{
"ServeNodes": [
":8080",
"ss://chacha20:12345678@:8338"
],
"ChainNodes": [
"http://192.168.1.1:8080",
"https://10.0.2.1:443"
]
}
```

ServeNodes is equivalent to the -L parameter, ChainNodes is equivalent to the -F parameter.

#### Logging

> -logtostderr : log to console
Expand All @@ -92,6 +115,19 @@ gost -L=:8080
gost -L=admin:123456@localhost:8080
```

* Multiple sets of authentication information
```bash
gost -L=localhost:8080?secrets=secrets.txt
```

The secrets parameter allows you to set multiple authentication information for HTTP/SOCKS5 proxies, the format is:
```plain
# username password
test001 123456
test002 12345678
```

* Listen on multiple ports
```bash
gost -L=http2://:443 -L=socks://:1080 -L=ss://aes-128-cfb:123456@:8338
Expand Down Expand Up @@ -206,6 +242,13 @@ gost -L=kcp://:8388?c=/path/to/conf/file
**NOTE:** KCP will be enabled if and only if the proxy chain is not empty and the first proxy node (the first -F parameter) is of type KCP.
When KCP is enabled, other proxy nodes are ignored.

#### Transparent proxy
Iptables-based transparent proxy

```bash
gost -L=redirect://:12345 -F=http2://server_ip:443
```

Encryption Mechanism
------
#### HTTP
Expand Down

0 comments on commit fb3796e

Please sign in to comment.