From 63e6e0dc92938343d0d7b9e26b4308272106504e Mon Sep 17 00:00:00 2001 From: fatedier Date: Thu, 18 Jan 2018 16:43:03 +0800 Subject: [PATCH] doc: update --- README.md | 7 ++++++- README_zh.md | 9 +++++++-- conf/frpc_full.ini | 7 +++++++ 3 files changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a61c980..93ee895 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ frp is a fast reverse proxy to help you expose a local server behind a NAT or fi * [Authentication](#authentication) * [Encryption and Compression](#encryption-and-compression) * [Hot-Reload frpc configuration](#hot-reload-frpc-configuration) + * [Get proxy status from client](#get-proxy-status-from-client) * [Privilege Mode](#privilege-mode) * [Port White List](#port-white-list) * [TCP Stream Multiplexing](#tcp-stream-multiplexing) @@ -386,10 +387,14 @@ admin_addr = 127.0.0.1 admin_port = 7400 ``` -Then run command `frpc -c ./frpc.ini --reload` and wait for about 10 seconds to let frpc create or update or delete proxies. +Then run command `frpc reload -c ./frpc.ini` and wait for about 10 seconds to let frpc create or update or delete proxies. **Note that parameters in [common] section won't be modified except 'start' now.** +### Get proxy status from client + +Use `frpc status -c ./frpc.ini` to get status of all proxies. You need to set admin port in frpc's configure file. + ### Privilege Mode Privilege mode is the default and only mode support in frp since v0.10.0. All proxy configurations are set in client. diff --git a/README_zh.md b/README_zh.md index 9335dc8..e119a4f 100644 --- a/README_zh.md +++ b/README_zh.md @@ -27,6 +27,7 @@ frp 是一个可用于内网穿透的高性能的反向代理应用,支持 tcp * [身份验证](#身份验证) * [加密与压缩](#加密与压缩) * [客户端热加载配置文件](#客户端热加载配置文件) + * [客户端查看代理状态](#客户端查看代理状态) * [特权模式](#特权模式) * [端口白名单](#端口白名单) * [TCP 多路复用](#tcp-多路复用) @@ -396,7 +397,7 @@ use_compression = true ### 客户端热加载配置文件 -当修改了 frpc 中的代理配置,可以通过 `frpc --reload` 命令来动态加载配置文件,通常会在 10 秒内完成代理的更新。 +当修改了 frpc 中的代理配置,可以通过 `frpc reload` 命令来动态加载配置文件,通常会在 10 秒内完成代理的更新。 启用此功能需要在 frpc 中启用 admin 端口,用于提供 API 服务。配置如下: @@ -409,12 +410,16 @@ admin_port = 7400 之后执行重启命令: -`frpc -c ./frpc.ini --reload` +`frpc reload -c ./frpc.ini` 等待一段时间后客户端会根据新的配置文件创建、更新、删除代理。 **需要注意的是,[common] 中的参数除了 start 外目前无法被修改。** +### 客户端查看代理状态 + +frpc 支持通过 `frpc status -c ./frpc.ini` 命令查看代理的状态信息,此功能需要在 frpc 中配置 admin 端口。 + ### 特权模式 由于从 v0.10.0 版本开始,所有 proxy 都在客户端配置,原先的特权模式是目前唯一支持的模式。 diff --git a/conf/frpc_full.ini b/conf/frpc_full.ini index bcb61d2..78992c8 100644 --- a/conf/frpc_full.ini +++ b/conf/frpc_full.ini @@ -66,6 +66,13 @@ use_compression = false # remote port listen by frps remote_port = 6001 +[ssh_random] +type = tcp +local_ip = 127.0.0.1 +local_port = 22 +# if remote_port is 0, frps will assgin a random port for you +remote_port = 0 + [dns] type = udp local_ip = 114.114.114.114