ngrok环境搭建

ngrok环境搭建

ngrok 是一个反向代理，通过在公共的端点和本地运行的 Web 服务器之间建立一个安全的通道。ngrok 可捕获和分析所有通道上的流量，便于后期分析和重放。

简单来说就是可以让你的本地服务暴露在外网上面，可以通过外网访问，这是我们经常需要用到的功能。

适用场景：

• 微信本地开发
• 支付宝接口本地调试
• 将本地的网站，可以让其他人通过外网访问，作为展示

准备工作：

1.安装git

2.安装go环境
ubuntu系统： apt-get install golang
centos系统：yum intall golang
按教程安装，是将 go 安装到了 ‘~/go’，以后我们将其安装在 ‘/usr/local/go’，需要的操作有：
1.mv ~/go /usr/local/
2.修改go相关环境变量

mkdir $HOME/go 		// 使用$HOME/go 作为go的工作目录
echo 'export GOROOT=/usr/local/go'>> ~/.bashrc  
echo 'export GOPATH=$HOME/go'>> ~/.bashrc  
echo 'export PATH=$PATH:$GOROOT/bin'>> ~/.bashrc  
source  $HOME/.bashrc 

3.安装ngrok

	cd /usr/local/
	// 获取代码
	git clone https://github.com/inconshreveable/ngrok.git
	cd ngrok
	// 导入环境变量
	export NGROK_DOMAIN="ngrok.自己的域名.com"

	// 生成自签名ssl证书
	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

	// 应该是日志相关(感觉都是github上的，应该不存在说的翻墙之类的)
	vim /usr/local/ngrok/src/ngrok/log/logger.go
	log "github.com/keepeye/log4go"
	/*
		import (
	        "fmt"
	        log "github.com/alecthomas/log4go"		// 将这里替换下
		)
	 */

4.利用go开始编译ngrok客户端和服务端(利用Go的交叉编译，注意设置平台参数)

		// 服务端，用的是64位centos
			cd /usr/local/go/src
			GOOS=linux GOARCH=amd64 ./make.bash
			cd /usr/local/ngrok/
			GOOS=linux GOARCH=amd64 make release-server

		// 客户端，用的是64位mac
			cd /usr/local/go/src
			GOOS=darwin GOARCH=amd64 ./make.bash
			cd /usr/local/ngrok/
			GOOS=darwin GOARCH=amd64 make release-client

		// 客户端，windows 64位
			cd /usr/local/go/src
			GOOS=windows GOARCH=amd64 ./make.bash
			cd /usr/local/ngrok/
			GOOS=windows GOARCH=amd64 make release-client

		最终生成的路径，都在 /usr/local/ngrok/bin
			服务端：ngrokd
			linux客户端：ngrok
			mac64位客户端：darwin_amd64/ngork
			win64位客户端：windows_amd64/ngork

5.ngrokd服务端

1>启动ngrokd服务端
		/usr/local/ngrok/bin/ngrokd -domain="$NGROK_DOMAIN" -httpAddr=":8000"
 
2>ngrokd后台运行
			nohup /usr/local/ngrok/bin/ngrokd -domain="$NGROK_DOMAIN" -httpAddr=":8000" &

3>结束后台运行
			ps -A 	// 找到PID
			kill PID
			---
			pkill ngrokd
			killall ngrokd
			忘记了进城相关命令，以后有时间复习
			---

6.启动ngrok客户端
1>下载服务端生成的客户端软件
2>创建 ngrok.conf 配置文件

server_addr: "ngrok.ipxjy.com:8000"
trust_host_root_certs: false

3>启动客户端
.

/ngrok -config=./ngrok.cfg -subdomain=blog 80
setsid ./ngrok -config=./ngrok.cfg -subdomain=test 80 #在linux下如果想后台运行


	需要注意：
		1.ngrok服务端，按照上面的步骤，并不在 $PATH 中，我们可以选择性添加
			echo 'export PATH=$PATH:/usr/local/ngrok/bin' >> ~/.bashrc  
			source ~/.bashrc
		2.启动时，指定的 $NGROK_DOMAIN，并未永久添加到 个人配置，也可以选择性添加
			echo 'export NGROK_DOMAIN=ngrok.pxjy.com' >> ~/.bashrc  
			source ~/.bashrc

上面的搭建步骤是之前的笔记，今天重新配置一遍：
1.安装 git

yum -y install git

2.安装 go

yum -y install golang

3.下载 ngrok 源码

mkdir ~/ngrok//内网穿透
cd ~/ngrok//内网穿透
git clone https://github.com/inconshreveable/ngrok.git

4.导入 ngrok 我们配置的域名

假设我们想要给 ngrok 配置的外网域名是：ngrok.test.com
echo 'export NGROK_DOMAIN=ngrok.test.com' >> ~/.bashrc
source ~/.bashrc

5.生成自签名ssl证书

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

6.编译安装 ngrok 客户端和服务端
服务端，我们编译64位 linux 版：

GOOS=linux GOARCH=amd64 make release-server

客户端，我们编译64位 mac 和 windows 版：

GOOS=darwin GOARCH=amd64 make release-client
GOOS=windows GOARCH=amd64 make release-client

从服务器端下载编译好的客户端到本地

scp root@xxx:~/ngrok内网穿透/ngrok/bin/darwin_amd64/ngork ./
scp root@xxx:~/ngrok内网穿透/ngrok/bin/windows_amd64/ngork.exe ./

7.启动 ngrokd 服务

	// 前台启动
	ngrokd -domain="$NGROK_DOMAIN" -httpAddr=":8001" -httpsAddr=":8002"

	// 后台启动
	TODO(等有时间再整下这里，写个 service 脚本)

8.客户端连接

// 创建 ngrok.conf 配置文件	
vim ngrok.conf
server_addr: "ngrok.test.com:4443"
trust_host_root_certs: false


// 启动 ngrok 客户端，8000 端口(所以我们需要在本地按端口来配置虚拟主机)
ngrok -config=./ngork.conf -subdomain=dongxuemin 8000

9.阿里云服务器配置
域名解析
假设我们的域名是： test.com

		我们一般配置一个 'ngrok' 的二级域名
			ngrok.test.com - 指向到我们 ngrokd 所在的服务器地址

		还需要配置一个泛域名
			*.ngrok.test.com - 也指向到我们 ngrokd 所在的服务器地址 

	开放端口	
		ngrokd 默认在服务器上会监听(以下 3 个端口都可以自定义)：
			4443 - ngrok 客户端监听地址
			80 - http 监听地址
			443 - https 监听地址

		这 3 个端口，我们都需要放开：
			1>阿里云安全策略组
			2>ECS 服务器防火墙

10.相关命令
ngrokd - 服务端命令(没找到文档说明，我们运行 ngrokd --help 查看命令帮助)：

	    -domain string
				托管隧道的域名(默认是 "ngrok.com")
 
		-httpAddr string
			HTTP 连接的公共地址，空字符串表示禁用(默认是 ":80")

		-httpsAddr string
			监听 HTTPS 连接的公共地址，空字符串表示禁用(默认是 ":443")

		-log string
			将日志消息写入此文件。'stdout' 和 'none' 有特殊含义(默认是 "stdout")

		-log-level string
			要记录的消息级别。DEBUG、INFO、WARNING、ERROR 之一(默认是 "DEBUG")

		-tlsCrt string
			TLS 证书文件的路径

		-tlsKey string
			TLS 秘钥文件

		-tunnelAddr string
			ngrok 客户端监听的公共地址(默认是 ":4443")

	ngrok - 客户端命令(1.x 版本可能跟我们在官网看到的文档是不同的，我们运行 ngrok --help 查看命令帮助)：
		使用：./ngrok [选项] <本地端口或地址>

		选项：
			-authtoken string
				标识 ngrok.com 账号的身份认证 token

			-config string
				ngrok 配置文件路径（默认是：$HOME/.ngrok）

			-hostname string
				从 ngrok 服务器上请求一个自定义主机名。(仅限于 HTTP)(需要我们的 DNS 的 CNAME)

			-httpauth string
				用户名:密码 的 HTTP 基础身份认证用于保护公共隧道端点

			-log string
				将日志消息写入此文件。'stdout' 和 'none' 有特殊含义(默认是 "none")

			-log-level string
				要记录的消息级别。DEBUG、INFO、WARNING、ERROR 之一(默认是 "DEBUG")

			-proto string
				隧道的流量协议 {'http', 'https', 'tcp'}(默认是：'http+https')

			-subdomain string
				从ngrok 服务器上请求一个自定义子域名

		示例：
			ngrok 80
			ngrok -subdomain=example 8080 		// 最终的访问域名为：example.ngrok.xxx.com
			ngrok -proto=tcp 22
			ngrok -hostname="example.com" -httpauth="用户名:密码" 10.0.0.1

		高级用法：ngrok [选项] <命令> [命令参数] [...]
			ngrok start [隧道名] [...]
				根据配置文件中的隧道名来启用隧道

			ngrok start-all
				启动定义在配置文件中的所有隧道

			ngrok list
				列出定义在配置文件中的所有隧道

			ngrok help
				帮助

			ngrok version
				ngrok 版本

		示例：
			ngork start www api blog pubsub
			ngork -log=stdout -config=ngrok.yml start ssh
			ngrok start-all
			ngrok version