Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
wlh320 committed Jun 2, 2022
1 parent c6b8b56 commit f52dd99
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ remote1 <-> client <-> server <-> remote2
3. Run `portguard server -c config.toml` on server side.

4. Run generated binary on client side without any configs
(local port or server address can be customized with `pgcli -p port -s saddr:sport` if you like).
(local port or server address can be customized with `portguard client -p port -s saddr:sport` if you like).

Suggestions:
- (since v0.3.1) When generating clients, use `pgcli` as input file to reduce file size (size of client is about 2MB).
Expand Down
4 changes: 2 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,12 @@

3. 服务端运行 `portguard server -c config.toml`

4. 客户端只需直接运行生成的客户端文件,无需任何配置 (如果非要配置,可以配置本地端口和服务端地址,运行 `pgcli -p port -s saddr:sport`).
4. 客户端只需直接运行生成的客户端文件,无需任何配置 (如果非要配置,可以配置本地端口和服务端地址,运行 `portguard client -p port -s saddr:sport`).

5. 所有的 TCP 流量都会被加密转发.

使用建议:
- (since v0.3.1) 生成客户端时,用只有客户端功能的二进制 `pgcli` 作为输入,以减小体积 (客户端大小约 2M)
- (since v0.3.1) 生成客户端时,用只有客户端最小功能的二进制 `pgcli` 作为输入,以减小体积 (客户端大小约 2M)
- 生成后的客户端可以用 `upx` 压缩进一步减小体积,但压缩后配置无法再更改. (大小约 700kB)

## TODO
Expand Down

0 comments on commit f52dd99

Please sign in to comment.