参考资料】
注:编译最好在Linux环境下进行,我用的是VMware搭建的Ubuntu 16.04虚拟机。
〇、准备条件
- Linux系统
- 云主机
- 需要一个域名,最好ICP备案成功,否则80端口不能用(如果用不到80端口也无妨)
关于怎么安装Ubuntu虚拟机此处略过。。。因为这个不在本文范围内。
一、安装编译环境
以root
身份执行如下命令:
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install build-essential golang mercurial git --yes
然后获取源码:
git clone https://github.com/inconshreveable/ngrok.git ngrok
二、更改域名并生成证书
2.1 添加域名解析记录
将自己的域名添加解析A记录
,解析到自己的服务器IP地址。
需要添加两条记录:
记录类型 | 主机记录 | 记录值 |
---|---|---|
A | *.ngrok | 你的主机IP |
A | ngrok | 你的主机IP |
然后在步骤一的终端中,进入ngrok
目录,并设置环境变量:
cd ngrok/
export NGROK_DOMAIN="ngrok.***.com"
其中***.com
替换成你自己的域名,注意前缀ngrok
必须加。
另外,上文中的前缀
ngrok
可以替换成自己想要的任意名称,但是要跟域名的解析记录中对应起来。
2.2 为域名生成证书
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
然后将证书拷贝到指定位置
cp rootCA.pem assets/client/tls/ngrokroot.crt
cp server.crt assets/server/tls/snakeoil.crt
cp server.key assets/server/tls/snakeoil.key
三、编译
3.1 Windows版
- 服务端x86:
GOOS=windows GOARCH=386 make release-server
- 客户端x86:
GOOS=windows GOARCH=386 make release-client
- 服务端x64:
GOOS=windows GOARCH=amd64 make release-server
- 客户端x64:
GOOS=windows GOARCH=amd64 make release-client
3.2 Linux版
- 服务端x86:
GOOS=linux GOARCH=386 make release-server
- 客户端x86:
GOOS=linux GOARCH=386 make release-client
- 服务端x64:
GOOS=linux GOARCH=amd64 make release-server
- 客户端x64:
GOOS=linux GOARCH=amd64 make release-client
3.3 MacOS版
- 服务端x86:
GOOS=darwin GOARCH=386 make release-server
- 客户端x86:
GOOS=darwin GOARCH=386 make release-client
- 服务端x64:
GOOS=darwin GOARCH=amd64 make release-server
- 客户端x64:
GOOS=darwin GOARCH=amd64 make release-client
注:编译过程需要联网下载一部分库,如果一直停留在
go get gopkg.in/yaml.v1
,根据搭建ngrok服务详解一文中的说明,是因为git版本太低,需要>=1.7.9.5
。
编译完成后,在ngrok/bin/
目录下就会生成对应的可执行文件目录,里面放着每个平台的编译结果。
其中ngrokd
是服务器端,ngrok
是客户端。
四、使用
将所需平台的ngrokd
和刚开始生成的server.key
、server.crt
拷贝到服务器上。
注:Windows版本是
ngrokd.exe
。
4.1 服务端
- Linux平台
./ngrokd -tlsKey="server.key" -tlsCrt="server.crt" -domain="ngrok.你的域名.com" -httpAddr=":80" -httpsAddr=":443"
此处端口可以修改为自己的端口。
2019/03/05 记录:
如果服务器是通过终端SSH远程登录的,当退出终端时可能会使ngrok服务也退出,解决方法如下:
新建一个.sh
脚本文件,将开启服务器的命令放到里面,然后后台执行脚本。具体操作如下:vi startup.sh #创建文件 输入./ngrokd -tlsKey="server.key" -tlsCrt="server.crt" -domain="ngrok.你的域名.com" -httpAddr=":80" -httpsAddr=":443" :wq #保存退出 chmod +x startup.sh #添加可执行权限 nohup ./startup.sh & #后台执行脚本
- Windows平台
ngrokd.exe -tlsKey="server.key" -tlsCrt="server.crt" -domain="ngrok.你的域名.com" -httpAddr=":80" -httpsAddr=":443"
一键部署ngrok服务器**
如果嫌编译太麻烦,你可以选择网友写的工具,支持一键部署到安装平台:CentOS、Debian、Ubuntu。
https://github.com/clangcn/ngrok-one-key-install
4.2 客户端
在客户端目录添加文件ngrok.cfg
,内容如下:
server_addr: "ngrok.你的域名.com:4443"
trust_host_root_certs: false
端口
4443
默认为ngrok服务器对外开放的端口。
添加批处理start.bat,如果只运行一次直接在命令行下输入命令也是一样的效果,内容如下:
ngrok.exe -subdomain lfy -config=ngrok.cfg 8080
subdomain
代表子域名,如果不设置,外网地址会生成:
随机字符串.ngrok.你的域名.com
,而且每次都不固定。
通过设置此参数,可指定子域名为固定地址,上文中生成的域名为:lfy.ngrok.你的域名.com
。
此处的8080
是本地网络服务的端口号。
- Linux平台及Mac平台
这两个平台都跟Windows平台的用法大同小异:
./ngrok -subdomain lfy -config=ngrok.cfg 8080
Mac
最新系统Mojave
如果提示权限问题,则需要添加可执行权限,不需要root账户:
chmod +x ngrok