快捷導(dǎo)航

ngrok私有服務(wù)搭建方式(docker交叉編譯)

更新時間：2024年12月19日 11:26:09 作者：Mars'Ares

文章介紹了如何使用Docker環(huán)境進行ngrok的編譯,并提供了一個詳細的Dockerfile和關(guān)鍵編譯腳本

前言

ngrok是golang編寫的開源內(nèi)網(wǎng)穿透工具,1.x是開源 2.x是閉源,目前免費的服務(wù)器也沒有幾個。
ngork的主要配置在于公網(wǎng)服務(wù)器的域名。但是由于遍以后的客戶端和服務(wù)端將ca文件生成在了代碼中一起打包編譯,所有修改域名和ca文件都需要重新編譯。
恰逢雙十一買了服務(wù)器和域名,有使用需求遍把編譯環(huán)境制作成docker環(huán)境,使用docker交叉編譯快速獲得可執(zhí)行的客戶端和服務(wù)端。

docker鏡像介紹

組件	版本	備注
golang	1.16.10	編譯ngrok需要1.16及以上版本
alpine	3.13	3.14有問題,目前可用最新的版本,提供git version 2.30.2
openssl	OpenSSL 1.1.1	用于生成ca證書
ngrok	1.7	fork ngrok代碼掛載docker鏡像減少

ngrok fork代碼實在推送不上去了,dockerfile如下:

FROM golang:1.16.10-alpine3.13
RUN apk add --no-cache git make openssl
ADD . /ngrok
WORKDIR /ngrok
ENV GOPATH=/ngrok
ENV PATH=$PATH:$GOPATH/bin
ENV PATH=$PATH:$GOPATH/bin
RUN go env -w GOPROXY=https://goproxy.cn,direct
RUN go env -w GOSUMDB=off
RUN go env -w GO111MODULE=auto
CMD ["sh","-c","go version && openssl version"]

使用

# 使用進行運行命令
docker run --rm marsbug/go-ngrok-alpine:latest sh -c 'go version && openssl version && git version'
# 輸出版本如下
go version go1.16.10 linux/amd64
OpenSSL 1.1.1l  24 Aug 2021
git version 2.30.2

編譯配置介紹

配置	事例	作用
NGROK_DOMAIN	“xxxx.com”	公網(wǎng)ip的域名,此域名如果錯誤會導(dǎo)致ca證書無法通過,這里最好同部修改dns添加對應(yīng)域名解析記錄
USE_CUSTMER_CA	0表示不使用 1表示使用	公網(wǎng)ip的域名,此域名如果錯誤會導(dǎo)致ca證書無法通過

ngrok鏡像使用例子

目錄結(jié)構(gòu)

bin/     編譯的客戶端和服務(wù)端目錄
ca/      證書掛載目錄
build.sh 交叉編譯腳本
script.sh 交叉編譯例子

沒有證書

# USE_CUSTMER_CA = 0
# NGROK_DOMAIN = 簽發(fā)證書的域名
 ./script.sh NGROK_DOMAIN USE_CUSTMER_CA

有自己域名證書

# USE_CUSTMER_CA = 1 替換ca目錄下的三個文件
cp yourrootCA.key ca/rootCA.key
cp yourrootCA.pem ca/rootCA.pem
cp yourdevice.crt ca/device.crt
# NGROK_DOMAIN = 簽發(fā)證書的域名
 ./script.sh NGROK_DOMAIN USE_CUSTMER_CA

注意：

主域名dns要解析道服務(wù)端,否則客戶端將出現(xiàn) nuknow host
*主域名dns要和ca證書域名一致,否則客戶端將出現(xiàn) *
每次主域名修改需要修改證書
每次證書修改需要重新編譯

關(guān)鍵編譯腳本

腳本主要使用掛載目錄進行交叉編譯,如果存在自己的ca證書,則不會創(chuàng)建ca證書。

如果想要生成ca證書,需要刪除ca目錄文件夾重新執(zhí)行。

script.sh

# $1 自定義域名 $2 是否使用自己的ca（0是 1不是）
docker run --rm  \
-v "$PWD"/ca:/ngrok/ca  \
-v "$PWD"/bin:/ngrok/bin \
--env NGROK_DOMAIN=$1  \
--env USE_CUSTMER_CA=$2  \
marsbug/go-ngrok-alpine:latest sh -c  \
'echo "--------------------- 公網(wǎng) NGROK_DOMAIN : $NGROK_DOMAIN  ---------------------" \
&& if [ $USE_CUSTMER_CA == 1 ];then \
echo "--------------------- 使用自己證書 ... 生成中 ---------------------" \
&& if [ ! -e ca/rootCA.key ]; then
echo "--------------------- rootCA.key不存在,生成中 ---------------------" \
&& openssl genrsa -out ca/rootCA.key 2048; fi  \
&& if [ ! -e ca/rootCA.pem ]; then \
echo "--------------------- rootCA.pem不存在,生成中 ---------------------" \
&& openssl req -x509 -new -nodes -key ca/rootCA.key -subj "/CN=$NGROK_DOMAIN" -days 5000 -out ca/rootCA.pem; fi  \
&& if [ ! -e ca/device.key ]; then  \
echo "--------------------- device.key不存在,生成中 ---------------------" \
&& openssl genrsa -out ca/device.key 2048; fi  \
&& if [ ! -e ca/device.crt ]; then \
echo "--------------------- device.crt不存在,生成中 ---------------------" \
&& openssl req -new -key ca/device.key -subj "/CN=$NGROK_DOMAIN" -out ca/device.csr; fi  \
&& if [ ! -e ca/device.crt ]; then  openssl x509 -req -in ca/device.csr -CA ca/rootCA.pem -CAkey ca/rootCA.key -CAcreateserial -out ca/device.crt -days 5000; fi \
&& echo "--------------------- 證書生成完畢 ... 替換舊證書 ---------------------" \
&& cp ca/rootCA.pem assets/client/tls/ngrokroot.crt \
&& cp ca/device.crt assets/server/tls/snakeoil.crt \
&& cp ca/device.key assets/server/tls/snakeoil.key; fi \
&& echo "--------------------- $NGROK_DOMAIN證書就緒 ...編譯中 ---------------------" \
&& make release-server \
&& make release-client \
&& CGO_ENABLED=0 GOOS=linux GOARCH=arm make release-client  \
&& CGO_ENABLED=0 GOOS=linux GOARCH=amd64 make release-client \
&& CGO_ENABLED=0 GOOS=windows GOARCH=amd64 make release-client \
&& CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 make release-client \
&& echo "--------------------- 編譯完成 ---------------------" '