Home

Awesome

<p align="right"> <strong>中文</strong> | <a href="./README.en.md">English</a> </p> <div align="center">

Go Public

✨ 基于 Go 的本地端口转发工具，开箱即用 ✨

</div> <p align="center"> <a href="https://raw.githubusercontent.com/songquanpeng/go-public/master/LICENSE"> <img src="https://img.shields.io/github/license/songquanpeng/go-public?color=brightgreen" alt="license"> </a> <a href="https://github.com/songquanpeng/go-public/releases/latest"> <img src="https://img.shields.io/github/v/release/songquanpeng/go-public?color=brightgreen&include_prereleases" alt="release"> </a> <a href="https://github.com/songquanpeng/go-public/releases/latest"> <img src="https://img.shields.io/github/downloads/songquanpeng/go-public/total?color=brightgreen&include_prereleases" alt="release"> </a> <a href="https://hub.docker.com/repository/docker/justsong/go-public"> <img src="https://img.shields.io/docker/pulls/justsong/go-public?color=brightgreen" alt="docker pull"> </a> <a href="https://goreportcard.com/report/github.com/songquanpeng/go-public"> <img src="https://goreportcard.com/badge/github.com/songquanpeng/go-public" alt="GoReportCard"> </a> </p>

功能

用法

服务端

# 初始化配置文件
./go-public init server
# 检查并保存生成的令牌
cat go-public-server.yaml
# 启动服务器
./go-public

或者使用 Docker 进行部署：

docker run -d --restart always --name go-public -p 6871:6871 -p 8080:8080 -v /home/ubuntu/data/go-public:/app justsong/go-public

IP 白名单配置示例：

# go-public-server.yaml
whitelist:
  - 123.213.241.5
  - 123.213.242.9
  - 125.216.243.1

客户端

# 初始化配置文件
./go-public init client
# 使用保存的令牌修改配置文件
vim go-public-client.yaml
# 启动客户端
# 注意，远程端口不是配置文件中设置的服务器所监听的端口，
# 而是你想在哪一个端口上映射本地端口
./go-public <本地端口> <远程端口>
# 例如：
./go-public 3000 8080  # 将本地 3000 端口映射到远程服务器上的 8080 端口

流程图

sequenceDiagram
    participant Local Server
    participant Go Public Client
    participant Go Public Server
    participant User
    
    Go Public Client->>Go Public Server: Initialize connection
    User->>Go Public Server: Request
    Go Public Server->>Go Public Client: Assign connection uuid
    Go Public Client->>Go Public Server: Make a new connection with uuid
    Go Public Client->>Local Server: Make a new connection
    Go Public Server->>Go Public Client: Forward request
    Go Public Client->>Local Server: Forward request
    Local Server->>Go Public Client: Response
    Go Public Client->>Go Public Server: Forward response
    Go Public Server->>User: Forward Response