一、什么是 frp

1.1 內(nèi)網(wǎng)穿透

如下圖所示, 一般情況下, 公網(wǎng)內(nèi)的設(shè)備都能夠被任意一臺(tái)設(shè)備訪問到!! 而不同局域網(wǎng)內(nèi)的設(shè)備是相互隔離的, 局域網(wǎng) A 的設(shè)備是無法訪問到局域網(wǎng) B 內(nèi)的設(shè)備

而內(nèi)網(wǎng)穿透技術(shù), 顧名思義就是能讓公網(wǎng)、或者當(dāng)前局域網(wǎng)外的任意設(shè)備訪問到局域網(wǎng)內(nèi)某個(gè)設(shè)備! 如下圖, 設(shè)備 C 實(shí)現(xiàn)了內(nèi)網(wǎng)穿透技術(shù), 所以局域網(wǎng)內(nèi)任意設(shè)備都能夠訪問到當(dāng)前設(shè)備

那么有了內(nèi)網(wǎng)穿透我們可以做啥呢?

遠(yuǎn)程訪問和管理: 內(nèi)網(wǎng)穿透允許您從任何地方通過互聯(lián)網(wǎng)連接到位于其他局域網(wǎng)內(nèi)中的設(shè)備或服務(wù)器, 舉個(gè)最簡單的例子就是, 當(dāng)你在家里想遠(yuǎn)程訪問公司的電腦時(shí), 因?yàn)槟愕膬蓚€(gè)設(shè)備是處于不同局域網(wǎng)內(nèi), 默認(rèn)情況下是無法相互訪問的, 這時(shí)就可以通過內(nèi)網(wǎng)穿透來實(shí)現(xiàn)

游戲娛樂: 比如你在家用電腦開游戲服, 想邀請(qǐng)朋友加入聯(lián)機(jī), 因?yàn)槟慵依锏木W(wǎng)絡(luò)與朋友的網(wǎng)絡(luò)處于不同的局域網(wǎng), 當(dāng)朋友想要聯(lián)機(jī)加入你的游戲服時(shí), 就需要你的電腦使用內(nèi)網(wǎng)穿透技術(shù)將設(shè)備訪問權(quán)暴露出去

共享本地服務(wù): 實(shí)現(xiàn)文件共享, 如文件共享、打印機(jī)訪問或監(jiān)控?cái)z像頭; 通過內(nèi)網(wǎng)穿透技術(shù), 我們可以隨時(shí)隨地訪問家里設(shè)備的資源、服務(wù)

測(cè)試和開發(fā)環(huán)境: 開發(fā)人員可以使用內(nèi)網(wǎng)穿透將本地開發(fā)環(huán)境暴露給外部世界; 比如我們要本地測(cè)試 github webhooks 就可以通過內(nèi)網(wǎng)穿透來讓外部的服務(wù)訪問到我們本地服務(wù)

1.2 frp 簡介 & 原理簡述

簡單地說, frp 就是一個(gè)反向代理軟件, 它的作用是將內(nèi)網(wǎng)中的服務(wù)器暴露到互聯(lián)網(wǎng)上, 它體積輕量但功能很強(qiáng)大!!! 通過它我們可以很方便實(shí)現(xiàn)內(nèi)網(wǎng)穿透功能!!!

它其實(shí)有兩個(gè)服務(wù):

客戶端 frpc, 安裝在我們內(nèi)網(wǎng)中某臺(tái)物理機(jī)上

服務(wù)端 frps, 安裝在一個(gè)公網(wǎng)服務(wù)器上

如下圖:

首先公網(wǎng)上先部署了 frps 服務(wù), 并設(shè)置了連接端口

然后在內(nèi)網(wǎng)中運(yùn)行 frpc 服務(wù), 啟動(dòng)時(shí)會(huì)連接到公網(wǎng)上的 frpc 服務(wù), 并保持保持住這個(gè)長連接(如果斷開了會(huì)進(jìn)行重試)

當(dāng)用戶公網(wǎng)地址時(shí), 會(huì)先在本地看是否有可用的連接, 如果沒有， 那么 frps 服務(wù)就會(huì)將請(qǐng)求轉(zhuǎn)發(fā)到 frpc 服務(wù)上

再由 frpc 將請(qǐng)求轉(zhuǎn)發(fā)到內(nèi)網(wǎng)中任意一個(gè)服務(wù)上

FRP的優(yōu)點(diǎn): 它可以隱藏內(nèi)網(wǎng)中的服務(wù)器, 避免因直接暴露內(nèi)網(wǎng)服務(wù)器導(dǎo)致的安全問題。此外, FRP還支持動(dòng)態(tài)端口映射, 可以方便地實(shí)現(xiàn)內(nèi)網(wǎng)的服務(wù)器負(fù)載均衡

二、公網(wǎng)服務(wù)器 frps 部署

上文提到, frp 其實(shí)是有兩個(gè)服務(wù)的, 一個(gè)存在于公網(wǎng)的 frp 服務(wù)端, 也是就 frps; 一個(gè)就是部署在局域網(wǎng)物理機(jī)上的 frp 客戶端, 也就是 frpc

那么本節(jié)將介紹下 frps 的一個(gè)部署, 這里使用到的 docker 鏡像是 snowdreamtech/frps, 需要注意的是本文使用的是最新的版本, 所以配置文件和目前網(wǎng)上大部分教程是有所出入的!!!

如下圖, 從 docker 鏡像的詳細(xì)信息可以看出, 該鏡像發(fā)布時(shí)間的一個(gè)時(shí)間, 以及使用的配置文件路徑, 配置文件具體信息可以看 frp 官網(wǎng)

下面開始正式部署 frps 服務(wù)...

2.1 添加配置文件

首先找個(gè)位置, 添加一個(gè)配置文件 frps.toml, 我這里配置文件完整路徑為 /home/moyuanjun/frp/frps.toml, 配置文件內(nèi)容如下, 具體每個(gè)配置項(xiàng)參考注釋, 更多配置可查閱 frp 官網(wǎng)

bindPort = 7000         
log.to = "console"      
vhostHTTPPort = 7100    
vhostHTTPSPort = 7200   

auth.method = "token"   
auth.token = "password" 

webServer.port = 7300        
webServer.addr = "0.0.0.0"   
webServer.user = "admin"     
webServer.password = "admin" 

2.2 Docker 容器部署

配置文件整完, 下面我們開始部署 docker!!!

首先先拉取下最新的 docker 鏡像 snowdreamtech/frps

sudo docker pull snowdreamtech/frps

這里提前拉取了下鏡像, 主要目的就是要確認(rèn)下拉取下來的 snowdreamtech/frps 鏡像的版本是否是最新的, 這里我就是簡單看下鏡像的創(chuàng)建時(shí)間(沒辦法, 不同的 docker 源上最新版本可能存在差異, 我這次就被坑慘了!!!)

docker 運(yùn)行: 如下命令, 運(yùn)行 snowdreamtech/frps, 這里唯一要調(diào)整的是 -v /home/moyuanjun/frp/frps.toml:/etc/frp/frps.toml, 要將前面我本地配置文件路徑改成你自己的

sudo docker run -d 
--network host 
-v /home/moyuanjun/frp/frps.toml:/etc/frp/frps.toml 
--name frps 
snowdreamtech/frps

2.3 日志查看

上文我們已經(jīng)完成了 frps docker 容器的部署, 但實(shí)際上我們只看到容器起來了!! 但是 frps 具體運(yùn)行情況我們是無法知道得知的!!

其實(shí)我們?cè)?frps.toml 中配置了 log.to = "console", 日志實(shí)際上已經(jīng)輸出了, 這里我們直接通過 docker logs frps 就可以查看到日志信息了:

當(dāng)然如果我們想要查看實(shí)時(shí)的日志, 可以使用 docker logs -f frps 來開啟一個(gè)實(shí)時(shí)的終端進(jìn)程, 就能夠?qū)崟r(shí)監(jiān)控到日志的輸出:

2.4 frps 儀表盤

我自己的服務(wù)器是阿里云的, 默認(rèn)情況下防火墻只開啟了幾個(gè)常用端口, 所以在開始前, 我這邊還需要設(shè)置下阿里云的防火墻, 為 frp 開放了一批端口出來

還記得我們?cè)?frps.toml 中配置了儀表盤信息嘛, 下面我們可以通過 ip/域名:[webServer.port] 來訪問儀表盤頁面!!!

首次需要登錄, 用戶名密碼就是 frps.toml 設(shè)置的內(nèi)容:

如下圖, 就是儀表盤的界面了:

三、內(nèi)網(wǎng) frpc 部署

下面我們還需要一個(gè) frpc 客戶端, 當(dāng)我們運(yùn)行 frpc 服務(wù)時(shí)將和公網(wǎng)上的 frps 建立一個(gè)長連接, 當(dāng)我們?cè)L問公網(wǎng)不存在的服務(wù)時(shí)會(huì)轉(zhuǎn)發(fā)到 frpc, 然后 frpc 再做一個(gè)二次轉(zhuǎn)發(fā)

那么本節(jié)將介紹下 frpc 的一個(gè)部署, 這里使用到的 docker 鏡像是 snowdreamtech/frpc, 需要注意的是本文使用的是最新的版本, 所以配置文件和目前網(wǎng)上大部分教程是有所出入的!!!

如下圖, 從 docker 鏡像的詳細(xì)信息可以看到, 該鏡像的一個(gè)發(fā)布時(shí)間, 以及使用的配置文件路徑, 配置文件具體信息可以看 frp 官網(wǎng)

下面開始正式部署 frpc 服務(wù)...

3.1 添加配置文件

還是一樣, 我們需要先找個(gè)位置, 添加一個(gè)配置文件 frpc.toml, 我這里配置文件完整路徑為 /Users/qianyin/frp/frpc.toml, 配置文件最簡內(nèi)容如下, 具體每個(gè)配置項(xiàng)參考注釋, 更多配置可查閱 frp 官網(wǎng)

serverPort = 7000                
serverAddr = "www.kunlunxu.cc"   
log.to = "console"               
auth.token = "password"

3.2 Docker 容器部署

配置文件整完, 下面我們開始部署 docker!!!

首先先拉取下最新的 docker 鏡像 snowdreamtech/frpc

docker pull snowdreamtech/frpc

這里提前拉取了下鏡像, 主要目的就是要確認(rèn)下拉取下來的 snowdreamtech/frpc 鏡像的版本是否是最新的, 這里我就是簡單看下鏡像的創(chuàng)建時(shí)間(沒辦法, 不同的 docker 源上最新版本可能存在差異, 我這次就被坑慘了!!!)

docker 運(yùn)行: 如下命令, 運(yùn)行 snowdreamtech/frpc, 這里唯一要調(diào)整的是 -v /Users/qianyin/frp/frpc.toml:/etc/frp/frpc.toml, 要將前面我本地配置文件路徑改成你自己的

docker run -d 
--network host 
-v /Users/qianyin/frp/frpc.toml:/etc/frp/frpc.toml 
--name frpc 
snowdreamtech/frpc

同樣的, 這里我們可以通過 docker logs frpc 來查看啟動(dòng)日志

當(dāng)然我們也可以通過查看 frps 儀表板中客戶端連接數(shù), 來確定 frpc 的連接情況

3.3 將內(nèi)網(wǎng)上本地 html 服務(wù)暴露到公網(wǎng)(tcp 版本)

首先本地我們先起一個(gè)服務(wù), 我這里直接使用 vscode 插件 Live Server 起了一個(gè)靜態(tài)服務(wù)

下面我們修改 frpc 配置文件, 添加一個(gè)代理配置, 我們希望的是, 當(dāng)訪問公網(wǎng) ip/域名:7001 能夠通過 frps 轉(zhuǎn)發(fā)到內(nèi)網(wǎng)上的 frpc 服務(wù)上, 然后再通過 fprc 代理到內(nèi)網(wǎng)的 192.168.0.108:5500 上; 配置完整內(nèi)容如下, 參數(shù)介紹看注釋, 主要就是加了 [[proxies]] 配置:

# frpc.toml
serverPort = 7000                # [必選] 要連接的 frps 端口
serverAddr = "www.kunlunxu.cc"   # [必選] 要連接的 frps 地址
log.to = "console"               # [可選] 日志配置, 通過打印的方式輸出日志
auth.token = "password"          # [可選] token 設(shè)置, frps 設(shè)置的 token, 其實(shí)就是密碼


+ [[proxies]]                      
+ name = "web"                     # 代理名稱(隨便填)
+ type = "tcp"                     # 代理類型
+ localIP = "192.168.0.108"        # 代理地址, 要轉(zhuǎn)發(fā)到哪個(gè)地址
+ localPort = 5500                 # 代理端口, 要轉(zhuǎn)發(fā)到哪個(gè)端口
+ remotePort = 7001                # 遠(yuǎn)程端口(和遠(yuǎn)程 frps 哪個(gè)端口綁定在一起, 訪問對(duì)應(yīng)端口將使用該代理)

重啟 frpc: 其實(shí)就是重啟 docker 容器

docker stop frpc
docker start frpc

訪問 http://www.kunlunxu.cc:7001 將正常展示內(nèi)網(wǎng)上本地項(xiàng)目:

下面是一個(gè)簡易流程圖:

3.4 將內(nèi)網(wǎng)上本地 html 服務(wù)暴露到公網(wǎng)(html 版本)

下面我們換一種配置方式, 下面是完整配置內(nèi)容如下, 參數(shù)介紹看注釋; 因?yàn)槲覀冊(cè)?frps 上設(shè)置了 vhostHTTPPort = 7100 那么當(dāng)我們?cè)L問公網(wǎng)服務(wù)器 7100 端口時(shí), 轉(zhuǎn)發(fā)到 frpc 后會(huì)走 type = "http" 的配置:

# frpc.toml
serverPort = 7000                # [必選] 要連接的 frps 端口
serverAddr = "www.kunlunxu.cc"   # [必選] 要連接的 frps 地址
log.to = "console"               # [可選] 日志配置, 通過打印的方式輸出日志
auth.token = "password"          # [可選] token 設(shè)置, frps 設(shè)置的 token, 其實(shí)就是密碼


[[proxies]]                      
name = "web - tcp"               # 代理名稱(隨便填)
type = "tcp"                     # 代理類型
localIP = "192.168.0.108"        # 代理地址, 要轉(zhuǎn)發(fā)到哪個(gè)地址
localPort = 5500                 # 代理端口, 要轉(zhuǎn)發(fā)到哪個(gè)端口
remotePort = 7001                # 遠(yuǎn)程端口(和遠(yuǎn)程 frps 哪個(gè)端口綁定在一起, 訪問對(duì)應(yīng)端口將使用該代理)


+ [[proxies]]
+ name = "web - html"                   # 代理名稱(隨便填)
+ type = "http"                         # 代理類型
+ localIP = "192.168.0.108"             # 代理地址, 要轉(zhuǎn)發(fā)到哪個(gè)地址
+ localPort = 5500                      # 代理端口, 要轉(zhuǎn)發(fā)到哪個(gè)端口
+ customDomains = ["www.kunlunxu.cc"]   # 限制公網(wǎng)地址, 只有對(duì)應(yīng)地址上

 frps 轉(zhuǎn)發(fā)了 html 才會(huì)走到這里

重啟 frpc: 其實(shí)就是重啟 docker 容器

docker stop frpc
docker start frpc

訪問 http://www.kunlunxu.cc:7100 將正常展示內(nèi)網(wǎng)上本地項(xiàng)目:

下面是一個(gè)簡易流程圖:

四、遇到問題

1、版本問題: 目前網(wǎng)上大部分文章的配置文件還是 frps.ini 或 frpc.ini, 寫法上也是老的寫法, 所以這里如果你安裝的是最新版本那么一定請(qǐng)以 frp 官網(wǎng) 為準(zhǔn)

2、如何確定 Docker 容器使用的配置文件是哪個(gè)? 答案是可直接查看容器的信息來進(jìn)行確認(rèn)

如何查看日志? 正如上文可在配置文件中設(shè)置 log.to = "console" 并配合 docker logs 來查看服務(wù)輸出的日志

上文中 webServer.addr 設(shè)置了 "0.0.0.0", 是因?yàn)槟J(rèn)情況下是該值為 127.0.0.1, 在測(cè)試過程中發(fā)現(xiàn)如果保持默認(rèn)值無法訪問到儀表盤頁面了!!!

在最開始我是跑了一個(gè) React 項(xiàng)目, 然后試圖在 frpc 中將項(xiàng)目暴露出去, 最后發(fā)現(xiàn)一直無法代理成功!!! 經(jīng)排查發(fā)現(xiàn)原來該項(xiàng)目無法通過內(nèi)網(wǎng) IP 進(jìn)行訪問的, 當(dāng)然相對(duì)的解決辦法就是需要調(diào)整 webpack 中的配置!! 后來省方便就直接使用 vscode 插件 Live Server 起了一個(gè)靜態(tài)服務(wù)來進(jìn)行測(cè)試!! 所以這里主要就是想提醒下, 在測(cè)試前請(qǐng)確保你的本地服務(wù)能夠正常通過內(nèi)網(wǎng) IP 進(jìn)行訪問, 同時(shí)配置中盡量不要直接寫 127.0.0.1, 盡量使用具體的內(nèi)網(wǎng) IP

在阿里云上, 拉取 snowdreamtech/frps 鏡像時(shí)總是發(fā)現(xiàn)最新版本和 hub.docker 上對(duì)不上, 經(jīng)排查發(fā)現(xiàn)問題出在 Docker 配置的源上, 由于我這邊使用了 阿里云加速器, 但是由于 Docker Hub 的限制, 導(dǎo)致使用鏡像加速器后無法獲取最新官方鏡像, 暫時(shí)解決辦法就是去掉加速器配置, 直接連接 Docker Hub 進(jìn)行獲取:

rm /etc/docker/daemon.json       
sudo systemctl daemon-reload     
sudosystemctlrestartdocker

編輯：黃飛