GoodLink 技术文档：P2P直连内网工具使用指南

1. 项目概述

GoodLink是一款基于P2P技术的直连工具，允许用户无需公网IP或第三方服务器中转，直接访问公司内网的WEB、GIT、SSH等资源。项目采用双端架构（Remote端和Local端），支持TUN模式和代理模式两种工作方式。

2. 安装指南

2.1 系统要求

• 支持操作系统：Windows/Linux
• 网络要求：NAT类型1-3（NAT4不保证连通性）
• 需关闭路由器防火墙或设置DMZ主机

2.2 安装方式

Windows安装

1. 从发布页面下载对应版本的可执行文件（goodlink-windows-amd64.exe）
2. 解压到任意目录即可使用（首次运行需管理员权限）

Linux安装

1. 下载对应架构的二进制文件（goodlink-linux-amd64）
2. 添加可执行权限：chmod +x goodlink-linux-amd64

Docker安装（仅Remote端）

docker run -d --name=goodlink --net=host --restart=always \
registry.cn-shanghai.aliyuncs.com/kony/goodlink \
--key=YOUR_RANDOM_KEY --remote

3. 使用说明

3.1 双端配置

Remote端启动方式

# Windows命令行
.\goodlink-windows-amd64.exe --fork --key=YOUR_RANDOM_KEY --remote

# Linux命令行
./goodlink-linux-amd64 --key=YOUR_RANDOM_KEY --remote

Local端启动方式

# Windows命令行
.\goodlink-windows-amd64.exe --fork --key=YOUR_RANDOM_KEY --local

# Linux命令行
./goodlink-linux-amd64 --key=YOUR_RANDOM_KEY --local

3.2 工作模式

TUN模式

• Local端自动创建虚拟网卡
• 连接成功后显示Remote端IP
• 示例：在远程桌面客户端输入Remote端IP即可访问

代理模式

• 代理地址：socks5://Remote端IP:1080
• 支持浏览器/GIT/SSH等工具的代理配置

4. API使用文档

4.1 命令行参数

参数	说明
--key	必填，16-24字节的随机密钥（两端需相同）
--remote	以Remote模式运行
--local	以Local模式运行
--fork	后台运行（仅Windows）

4.2 连接限制

• 一个Local端只能连接一个Remote端
• 一个Remote端可接受多个Local端连接
• 两端必须使用相同密钥

5. 注意事项

1. 密钥安全：务必使用自定义随机密钥，避免使用示例密钥
2. 杀毒软件：Windows Defender可能误报，需添加信任
3. 网络配置：建议将路由器NAT类型改为1-3级
4. 单实例限制：一个PC只能运行一个Local端
5. 移动网络：不支持2G/3G/4G/5G网络环境

6. 故障排查

1. 连接超时：检查防火墙设置，确认NAT类型
2. 代理失效：验证Remote端IP和端口(1080)
3. 虚拟网卡创建失败：以管理员权限重新运行
4. 持续问题：尝试更换密钥或重启两端服务

注意：本项目仅用于合法用途，严禁任何违法行为