ngrok搭建全过程

最近想把自己在家里的服务暴露到外网上,但是家里的宽带是移动,没有固定ip。就考虑用端口映射来实现。

本来开始打算用花生壳,但是看了下太贵,并且自己有域名挂上去更贵。腾讯和华为等云主机也不过几十元一年。最后决定花74元在腾讯云购买了个云服务器,在上面部署ngrok。

需求

在家本地运行的app1能够通过外网访问,同时还希望app2在另一个域名下也能够对外提供服务。

准备

各个云平台针对首单,都会有非常大的活动力度。买一个耍耍很划算。 部署了操作系统为Ubuntu20.04(64位)

准备编译环境

因为我的工作环境也是ubuntu,所以我选择在本地工作环境进行编译。安装后续编译ngrok需要的软件

sudo apt-get install golang
sudo apt-get install git

当然,也可以选择在云服务器上自己编译。

准备好域名

我有个域名XXX.com,但是这个域名还有其他用处,不打算dns都解析到这台服务器,所以采用二级域名 ngrok.XXX.com 来作为ngrok的域名

编译ngrok

下面整合和优化了脚本

  • 把所有的脚步都合并在一起,直接复制粘贴就可以直接使用
  • 因为编译过程中要访问github去下载一些项目的源代码,但是国内太慢,甚至无法下载。搞得我非常恼怒,索性把需要的github项目都monitor到中国的gitee,或者在gitee上寻找已经有的镜像。

这样一来编译速度 太爽了!!!

直接复制下面的脚步,不过要改NGROK_DOMAIN的变量为你的域名

我的域名是XXX.com,但是这个域名还有其他用处,不打算dns都解析到这台服务器,所以采用二级域名 ngrok.XXX.com 来作为ngrok的域名

export NGROK_DOMAIN="ngrok.XXX.com"
git clone https://gitee.com/OtherCopy/ngrok.git
cd ngrok

# 为域名生成证书
openssl genrsa -out rootCA.key 2048
openssl req -x509 -new -nodes -key rootCA.key -subj "/CN=$NGROK_DOMAIN" -days 5000 -out rootCA.pem
openssl genrsa -out server.key 2048
openssl req -new -key server.key -subj "/CN=$NGROK_DOMAIN" -out server.csr
openssl x509 -req -in server.csr -CA rootCA.pem -CAkey rootCA.key -CAcreateserial -out server.crt -days 5000

# copy生成的证书到指定目录,编译需要
cp rootCA.pem assets/client/tls/ngrokroot.crt
cp server.crt assets/server/tls/snakeoil.crt
cp server.key assets/server/tls/snakeoil.key


# 生成客户端配置文件
mkdir bin
echo server_addr: "$NGROK_DOMAIN:4443" > bin/ngrok.cfg
echo trust_host_root_certs: false>> bin/ngrok.cfg

# 采用国内gitee镜像,提升编译速度
git clone -- https://gitee.com/mirrors/log4go.git src/github.com/alecthomas/log4go
git clone -- https://gitee.com/ngrok-install/websocket.git src/github.com/gorilla/websocket
git clone -- https://gitee.com/ngrok-install/go-vhost.git src/github.com/inconshreveable/go-vhost
git clone -- https://gitee.com/ngrok-install/mousetrap.git src/github.com/inconshreveable/mousetrap
git clone -- https://gitee.com/ngrok-install/go-bindata.git src/github.com/jteeuwen/go-bindata
git clone -- https://gitee.com/mirrors_addons/osext.git src/github.com/kardianos/osext
git clone -- https://gitee.com/ngrok-install/binarydist.git src/github.com/kr/binarydist
git clone -- https://gitee.com/GoLibs/go-runewidth.git src/github.com/mattn/go-runewidth
git clone -- https://gitee.com/ngrok-install/termbox-go.git src/github.com/nsf/termbox-go
git clone -- https://gitee.com/mirrors/go-metrics.git src/github.com/rcrowley/go-metrics

#linux server
GOOS=linux GOARCH=amd64 make release-server

#linux client
GOOS=linux GOARCH=amd64 make release-client
#window client
GOOS=windows GOARCH=amd64 make release-client

下面是编译GOOS和GOARCH的对照表,如果上面生成的还不满足,请自行修改

Linux 平台 32 位系统:GOOS=linux GOARCH=386
Linux 平台 64 位系统:GOOS=linux GOARCH=amd64
Windows 平台 32 位系统:GOOS=windows GOARCH=386
Windows 平台 64 位系统:GOOS=windows GOARCH=amd64
MAC 平台 32 位系统:GOOS=darwin GOARCH=386
MAC 平台 64 位系统:GOOS=darwin GOARCH=amd64
ARM 平台:GOOS=linux GOARCH=arm

可以看到编译非常快速的完成了,只花了20多秒,之前用github的卡死了10多次都没搞定。

image-20210821205935924.png

ngrokd: 服务端程序
ngrok: linux客户端
windwos_amd65目录下的自然就是windows客户端

部署

同步ngrok程序

因为我是在本地进行编译的,需要把服务器端程序(ngrokd)上传到服务器端。
如果是在云服务器编译的,需要把客户端应用程序下载下来。

配置域名解析

添加A记录到这台云服务器

image-20210821212636257.png

这里注意是两个域名解析

ngrok这个是对应ngrok.XXX.com的。主要目的对外提供ngrok服务,客户端通过这儿域名于ngrok服务进行通讯。

*.ngrok是各个客户端可以设置的子域名。譬如这里的app1

启动服务端

sudo ./ngrokd -log=stdout -domain="ngrok.XXX.com" -httpAddr=":80"
image-20210821213716589.png

80,443分别是http,https端口

4443这个是ngrok服务端提供的端口,于客户端进行通讯

启动客户端app1

客户端运行下面命令,就会试图于服务端进行链接

./ngrok -config=./ngrok.cfg -subdomain=app1 3080

其中ngrok.cfg,就是在在上面构建的。里面的内容就2行。指定了服务器地址和端口

server_addr: ngrok.XXX.com:4443
trust_host_root_certs: false

执行后会显示下面信息,表示已经成功

image-20210821214305284.png

这个时候我们就可以通过 https://app1.ngrok.XXX.com/来访问内网本机3080端口上的应用了

启动客户端app2@另一个域名下

这个应用app2要在另一个域名YYY.com下的。

首先配置配置域名解析,增加A记录指向这台云服务器

然后在客户端执行下面命令,注意参数上有域名

./ngrok -config=./ngrok.cfg -hostname app2.YYY.com 4080

后台运行

之前都是前台运行,直观,但是只能用在调试。调试完成后,要把服务端和客户端都作为服务,后台运行

这里只以服务端为例

sudo vi /usr/lib/systemd/system/ngrokd.service

[Unit]
Description=ngrokd
After=network.target

[Service]
ExecStart=/opt/ngrokd -log=ngrok.log  -domain=ngrok.XXX.com
ExecStop=/usr/bin/killall ngrokd
Restart=always
RestartSec=10
Type=simple

[Install]
WantedBy=multi-user.target

大功告成,收工

注意客户端和服务器是匹配的,要一起编译,然后拷贝到服务端和客户端。

你可能感兴趣的:(ngrok搭建全过程)