Skip to content

Commit fb61987

Browse files
committed
chore: update README.md
1 parent 9bddc01 commit fb61987

File tree

2 files changed

+38
-20
lines changed

2 files changed

+38
-20
lines changed

README.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="center">
2+
<img src="peermap/ui/src/assets/logo.png" width="180" />
3+
</p>
4+
15
# PeerGuard
26

37
Another p2p network library in Go. Committed to direct communication between devices.
@@ -16,16 +20,16 @@ Another p2p network library in Go. Committed to direct communication between dev
1620
## Get Started
1721

1822
> [!NOTE]
19-
> Time synchronization between nodes is crucial; the difference should not exceed 5 seconds
23+
> Time synchronization between nodes is crucial; the difference should not exceed 10 seconds
2024
2125
```sh
2226
# node1
23-
pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24
27+
pgcli vpn -s wss://openpg.in/pg -4 100.64.0.1/24
2428
```
2529

2630
```sh
2731
# node2
28-
pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.2/24
32+
pgcli vpn -s wss://openpg.in/pg -4 100.64.0.2/24
2933
```
3034

3135
## Advanced
@@ -36,26 +40,26 @@ pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.2/24
3640

3741
```sh
3842
$ pgmap -l 127.0.0.1:9987 --secret-key 5172554832d76672d1959a5ac63c5ab9 \
39-
--stun stun.miwifi.com:3478 --stun stunserver.stunprotocol.org:3478
43+
--stun 111.206.174.2:3478 --stun 106.13.249.54:3478 --stun 106.12.251.52:3478 --stun 106.12.251.31:3478
4044
```
4145

4246
#### 2. wrap pgmap as an https server
4347

4448
```sh
45-
$ caddy reverse-proxy --from https://open.privpkg.in/pg --to 127.0.0.1:9987
49+
$ caddy reverse-proxy --from https://openpg.in --to 127.0.0.1:9987
4650
```
4751

4852
### P2P file sharing
4953

5054
```sh
5155
# share
52-
$ pgcli share -s wss://open.privpkg.in/pg ~/my-show.pptx
56+
$ pgcli share -s wss://openpg.in/pg ~/my-show.pptx
5357
ShareURL: pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx
5458
```
5559

5660
```sh
5761
# download
58-
$ pgcli download -s wss://open.privpkg.in/pg pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx
62+
$ pgcli download -s wss://openpg.in/pg pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx
5963
```
6064

6165
### Shortcut pgvpn
@@ -75,7 +79,7 @@ pgvpn --peers
7579
### Rootless mode VPN
7680

7781
```sh
78-
pgvpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 --proxy-listen 127.0.0.1:4090 --forward tcp://127.0.0.1:80 --forward udp://8.8.8.8:53
82+
pgvpn -s wss://openpg.in/pg -4 100.64.0.1/24 --proxy-listen 127.0.0.1:4090 --forward tcp://127.0.0.1:80 --forward udp://8.8.8.8:53
7983
```
8084

8185
### Uses pre-shared secret file instead of OIDC auth
@@ -84,14 +88,14 @@ pgvpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 --proxy-listen 127.0.0.1:4090
8488

8589
```sh
8690
$ export PG_SECRET_KEY=5172554832d76672d1959a5ac63c5ab9
87-
$ export PG_SERVER=wss://open.privpkg.in/pg
91+
$ export PG_SERVER=wss://openpg.in/pg
8892
$ pgcli admin secret --network "<email>" --duration 24h > psns.json
8993
```
9094

9195
**then**
9296

9397
```sh
94-
sudo pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 -f psns.json
98+
sudo pgcli vpn -s wss://openpg.in/pg -4 100.64.0.1/24 -f psns.json
9599
```
96100

97101
## License
@@ -104,3 +108,8 @@ Contributions welcome! Have an improvement? Submit a pull request.
104108

105109
> [!NOTE]
106110
> I also maintain a closed-source version, and contributions to the open-source project may be included in the closed-source version.
111+
112+
## Contact
113+
114+
- Telegram Group: https://t.me/+-S5L6ZCBxlxkMTRl
115+
- QQ Group: 1039776116

README_zh_CN.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="center">
2+
<img src="peermap/ui/src/assets/logo.png" width="180" />
3+
</p>
4+
15
# PeerGuard
26

37
另一个 Go 实现的 p2p 类库。致力于设备之间直接通信。
@@ -15,16 +19,16 @@
1519
## 快速开始
1620

1721
> [!NOTE]
18-
> 节点间时间同步非常重要,通常相差不能超过 5
22+
> 节点间时间同步非常重要,通常相差不能超过 10
1923
2024
```sh
2125
# 节点1
22-
pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24
26+
pgcli vpn -s wss://openpg.in/pg -4 100.64.0.1/24
2327
```
2428

2529
```sh
2630
# 节点2
27-
pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.2/24
31+
pgcli vpn -s wss://openpg.in/pg -4 100.64.0.2/24
2832
```
2933

3034
> [!NOTE]
@@ -38,28 +42,28 @@ pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.2/24
3842

3943
```sh
4044
$ pgmap -l 127.0.0.1:9987 --secret-key 5172554832d76672d1959a5ac63c5ab9 \
41-
--stun stun.miwifi.com:3478 --stun stunserver.stunprotocol.org:3478
45+
--stun 111.206.174.2:3478 --stun 106.13.249.54:3478 --stun 106.12.251.52:3478 --stun 106.12.251.31:3478
4246
```
4347

4448
> [!NOTE] >`pgmap`支持配置文件([查看所有配置项](https://github.com/sigcn/pg/blob/main/peermap/config.go#L20))。另外,命令行参数会覆盖配置文件参数
4549
4650
#### 2. 上 https 更安全
4751

4852
```sh
49-
$ caddy reverse-proxy --from https://open.privpkg.in/pg --to 127.0.0.1:9987
53+
$ caddy reverse-proxy --from https://openpg.in --to 127.0.0.1:9987
5054
```
5155

5256
### P2P 文件分享
5357

5458
```sh
5559
# 分享
56-
$ pgcli share -s wss://open.privpkg.in/pg ~/my-show.pptx
60+
$ pgcli share -s wss://openpg.in/pg ~/my-show.pptx
5761
ShareURL: pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx
5862
```
5963

6064
```sh
6165
# 下载
62-
$ pgcli download -s wss://open.privpkg.in/pg pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx
66+
$ pgcli download -s wss://openpg.in/pg pg://DJX2csRurJ3DvKeh63JebVHFDqVhnFjckdVhToAAiPYf/0/my-show.pptx
6367
```
6468

6569
### 快捷方式 pgvpn
@@ -79,7 +83,7 @@ pgvpn --peers
7983
### 去 root 权限的 VPN
8084

8185
```sh
82-
pgvpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 --proxy-listen 127.0.0.1:4090 --forward tcp://127.0.0.1:80 --forward udp://8.8.8.8:53
86+
pgvpn -s wss://openpg.in/pg -4 100.64.0.1/24 --proxy-listen 127.0.0.1:4090 --forward tcp://127.0.0.1:80 --forward udp://8.8.8.8:53
8387
```
8488

8589
### 使用预共享密钥文件代替 OIDC 认证
@@ -88,14 +92,14 @@ pgvpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 --proxy-listen 127.0.0.1:4090
8892

8993
```sh
9094
$ export PG_SECRET_KEY=5172554832d76672d1959a5ac63c5ab9
91-
$ export PG_SERVER=wss://open.privpkg.in/pg
95+
$ export PG_SERVER=wss://openpg.in/pg
9296
$ pgcli admin secret --network "<email>" --duration 24h > psns.json
9397
```
9498

9599
**然后**
96100

97101
```sh
98-
sudo pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 -f psns.json
102+
sudo pgcli vpn -s wss://openpg.in/pg -4 100.64.0.1/24 -f psns.json
99103
```
100104

101105
## 许可证
@@ -108,3 +112,8 @@ sudo pgcli vpn -s wss://open.privpkg.in/pg -4 100.64.0.1/24 -f psns.json
108112

109113
> [!NOTE]
110114
> 我维护了一个功能更强的专业版本,是闭源的。任何贡献在开源版本的代码都可能被闭源版本采用,如果介意请不要参与贡献。
115+
116+
## 交流
117+
118+
- Telegram 群组: https://t.me/+-S5L6ZCBxlxkMTRl
119+
- QQ 群组: 1039776116

0 commit comments

Comments
 (0)