</s><i> </i>所有服务的访问全链路加密，具有ssh2相当的安全级别。 流量走向：被穿透设备->服务器->客户端设备->服务器->被穿透设备。<i> </i><e>
# 快速开始
下载对应操作系统的二进制文件，然后运行相应命令。
最新版本：[https://github.com/sometiny/overfrp/releases/latest](https://github.com/sometiny/overfrp/releases/latest)
### 1、启动穿透服务端
```bash
./overfrp-server server --listen "127.0.0.1:7659" --allow-register
#输出：server started at: 127.0.0.1:7659
```
### 2、向服务端注册通道标识，用于发布服务，通道标识可复用，注册一次即可。
```bash
./overfrp-client register --server "127.0.0.1:7659"
#通道标识非固定，每次注册输出的都不一样：
#注册成功，穿透标识：jAY+fOaqmUusiHICNZ5mhQ==
#标识已保存至：/xxxxx/.identifier
```
### 3、发布服务
```bash
./overfrp-client publish --server "127.0.0.1:7659" --identifier "jAY+fOaqmUusiHICNZ5mhQ=="
#输出
#[]frp server: 127.0.0.1:7659
#[]frp publishing…
#[*]frp publish success
```
### 4、访问已发布的服务
```bash
./overfrp-client tunnel \
--listen "127.0.0.1:7660" \
--server "127.0.0.1:7659" \
--identifier "jAY+fOaqmUusiHICNZ5mhQ==" \
--target "www.baidu.com:443" \
--ssl-off-loading \
--keep-http-host
#输出
#port proxy started at: ‘127.0.0.1:7660’ for ‘www.baidu.com:443’ via ‘127.0.0.1:7659’
浏览器访问 http://127.0.0.1:7660 可正常打开baidu页面（注意：用http协议，不是https协议）
*要用http地址去访问baidu的443端口，所以需要指定–ssl-off-loading来卸载baidu的ssl。
*浏览器默认发送的host头不是www.baidu.com，需要指定–keep-http-host保持–target中指定的host。
#命令中有四个角色：
127.0.0.1:7660 本机
127.0.0.1:7659 服务器
jAY+fOaqmUusiHICNZ5mhQ== 发布服务的设备
www.baidu.com:443 要访问的目标
#本机（127.0.0.1:7660）通过服务器（127.0.0.1:7659）利用发布服务的设备去访问目标（www.baidu.com:443）
```
### 5、访问已发布的服务-纯TCP（不能指定任何HTTP相关的参数）
```bash
./overfrp-client tunnel \
--listen "127.0.0.1:2222" \
--server "127.0.0.1:7659" \
--identifier "jAY+fOaqmUusiHICNZ5mhQ==" \
--target "127.0.0.1:22"
#输出
#port proxy started at: ‘127.0.0.1:2222’ for ‘127.0.0.1:22’ via ‘127.0.0.1:7659’
#使用命令，会将本地2222端口转发到发布服务机器的22端口。
ssh [email protected]:2222
#命令中有三个角色：
127.0.0.1:2222 本机
127.0.0.1:7659 服务器
127.0.0.1:22 发布服务的设备，即jAY+fOaqmUusiHICNZ5mhQ==
```
以上为本地测试。
实际应用时，应该将 `overfrp-server` 部署在其他设备可以访问的服务器上。
在需要被穿透的设备上运行 `overfrp-client publish` ，将设备暴露到穿透服务端。
用 `overfrp-client tunnel` 命令通过穿透服务端，利用被穿透的设备去访问目标服务。
# 命令详细介绍
## 1、启动服务端
```bash
./overfrp-server server --listen [ip:port] --allow-register
```### 参数
```--listen [ip:port]```指定监听IP(0.0.0.0代表监听所有ip，公网可访问)和端口
```--allow-register```可选参数，允许用户注册
## 2、注册通道
```bash
./overfrp-client register --server [host:port] --authentication [name]
```### 参数
```--server [host:port]```指定通道使用的服务器
```--authentication [name]```如果服务器要求登录，需要提供公钥，公钥可使用命令“./overfrp-client newkey [name]”生成，服务器需要导入公钥
## 3、发布通道
```bash
./overfrp-client publish --server [host:port] --identifier [identifier] --authentication [name]
```### 参数
```--server [host:port]```指定通道使用的服务器
```--identifier [identifier]```指定通道标识
```--authentication [name]```可选参数，如果服务器要求登录，需要提供公钥，公钥可使用命令“./overfrp-client newkey [name]”生成，服务器需要导入公钥
## 4、使用通道
```bash
./overfrp-client tunnel \
--listen [host:port] \
--server [host:port] \
--authentication [name] \
--identifier [identifier] \
--target [target]
```### 参数
```--listen [host:port]```本地监听地址
```--server [host:port]```指定通道使用的服务器
```--authentication [name]```可选参数，如果服务器要求登录，需要提供公钥，公钥可使用命令“./overfrp-client newkey [name]”生成，服务器需要导入公钥
```--identifier [identifier]```指定通道标识
```--target [host:port]```指定远程目标，对远程目标的请求永远是由`--identifier`关联的发布服务的设备发起。
```--ssl-off-loading```可选参数，如果指定的目标为HTTPS，需要指定本参数，纯TCP端口转发时，必须忽略本参数。
```--keep-http-host```可选参数，默认HTTP请求头中的Host是浏览器访问的域名，若指定本参数，则HTTP请求头的Host字段将被修改为`--target`中的主机。纯TCP端口转发时，必须忽略本参数。
## 5、服务端管理面板模式
控制面板有更丰富的配置功能，例如鉴权、域名绑定、服务期迁移、通道持久化等。
</s><i> </i>强烈建议线上运行使用控制面板管理，并启用鉴权，要求设备公钥登录才能使用穿透服务。<i> </i><e>
bash</s><i> </i># 配置管理面板 ./overfrp-server manage --local [ip:port] --user [username:password]<i> </i><e>
### 参数
```--local [ip:port]```指定监听IP(0.0.0.0代表监听所有ip，公网可访问)和端口
```--user [username:password]```指定登录用户和密码，不指定则允许所有人访问，可进入控制面板重新设置密码
例如：
```bash
# 配置管理面板
./overfrp-server manage --local 127.0.0.1:12568 --user “admin:admin”
不添加任何参数，直接运行，启动管理面板。
./overfrp-server
```
管理面板启动后，访问 https://127.0.0.1:12568 登录控制面板。