Home

gwk

Gwk is a tool that helps you expose your local servers or services to the internet, even in a private network.

Feature

• support tcp port expose
• support subdomain expose http server
• support udp port expose
• support stcp expose with two peer

install

npm install -g gwk

usage

serverHost default is gank.75cos.com

# example 1 , detault dispatch to 127.0.0.1:8080
gwk

client more example

# example 2
gwk  --port 8080
# example 3
gwk  --subdomain testabc001 --port 8000
# example 4
gwk  -c client.json

client.json

{
  "serverHost": "gank007.com", // 服务器地址
  "serverPort": 4443, // 服务器端口
  "tunnels": {
    "tcp001": {
      "protocol": "tcp",
      "localPort": 5000,
      "remotePort": 7200
    },
    "tcp002": {
      "protocol": "tcp",
      "localPort": 5000,
      "remotePort": 7500
    },
    "webapp02": {
      "protocol": "web",
      "localPort": 4900,
      "subdomain": "app02"
    },
    "webappmob": {
      "protocol": "web",
      "localPort": 9000,
      "subdomain": "mob"
    }
  }
}

setup a gwk server

gwkd  -c server.json
# start with pm2
pm2 start gwkd --name gwkapp --  -c server.json

server.json

{
  "serverHost": "gwk007.com", // 使用web 隧道时, 需要域名
  "serverPort": 4443, // 隧道监听端口
  "httpAddr": 80, // 启动http服务
  "httpsAddr": 443, // 启动https服务, 需要后面的证书配置
  "tlsCA": "./rootCA/rootCA.crt", // 使用自签名证书用到
  "tlsCrt": "./cert/my.crt",
  "tlsKey": "./cert/my.key.pem"
}

develop

generate CA

node createRootCA.js

generate cert

node createRootByCA.js

start server

export GWK_SERVER=true
npx tsx src/cli.ts -c etc/server.ts

start client

npx tsx src/cli.ts -c etc/client.ts

test dns with custom port

dig @127.0.0.1 -p 6666 bbs.75cos.com