peerguard/README_zh_CN.md

PeerGuard

另一个 Go 实现的 p2p 类库。致力于设备之间直接通信。

特性

• 简洁架构
• 极高的 NAT(防火墙) 穿越成功率，并支持失败时回退到 websocket
• 完全的 ipv4/ipv6 双栈支持
• 很容易入手的 API （针对开发者）
• 端到端加密
• 用于可靠数据传输的 RDT 协议
• 跨平台

快速开始

Note

节点间时间同步非常重要，通常相差不能超过 5 秒

p2p vpn

# 节点1
sudo pgcli vpn -s wss://synf.in/pg --ipv4 100.64.0.1/24 --ipv6 fd00::1/64

# 节点2
sudo pgcli vpn -s wss://synf.in/pg --ipv4 100.64.0.2/24 --ipv6 fd00::2/64

Note

使用github认证时要求帐号绑定已验证的邮箱 (https://github.com/settings/emails)

p2p 文件分享

# 分享
$ PG_SERVER=wss://synf.in/pg pgcli share ~/my-show.pptx
ShareURL: pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx

# 下载
$ PG_SERVER=wss://synf.in/pg pgcli download pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx

高级用法

部署 peermap 服务器

1. 启动 pgmap 守护进程

$ pgmap -l 127.0.0.1:9987 --secret-key 5172554832d76672d1959a5ac63c5ab9 \
    --stun stun.miwifi.com:3478 --stun stunserver.stunprotocol.org:3478

Note

pgmap支持配置文件（查看所有配置项）。另外，命令行参数会覆盖配置文件参数

2. 上 https 更安全

$ caddy reverse-proxy --from https://synf.in/pg --to 127.0.0.1:9987

使用预共享密钥文件代替 OIDC 认证

首先

$ export PG_SECRET_KEY=5172554832d76672d1959a5ac63c5ab9
$ export PG_SERVER=wss://synf.in/pg
$ pgcli admin secret --network "<email>" --duration 24h > psns.json

然后

sudo pgcli vpn -s wss://synf.in/pg -4 100.64.0.1/24 -f psns.json

许可证

GNU General Public License v3.0

参与贡献

非常欢迎参与项目的开发，如果有任何改善本项目的意图，请立即提交 PR

Note

我维护了一个功能更强的专业版本，是闭源的。任何贡献在开源版本的代码都可能被闭源版本采用，如果介意请不要参与贡献。