update README.md and README-ZH.md (#152)

This commit is contained in:
coutps
2025-10-11 16:18:29 +08:00
committed by GitHub
parent 2275620060
commit 4daeeaab1a
10 changed files with 22 additions and 22 deletions
+11 -11
View File
@@ -19,7 +19,7 @@
[查看详细](#安全性) [查看详细](#安全性)
### 4. 轻量 ### 4. 轻量
文件大小2MB+,运行内存2MB+;它可以仅跑在应用层,或者配合wintun驱动使用组网功能 文件大小不到10MBcpu占用极低;它可以仅跑在应用层,或者配合kmod-tun/wintun驱动使用组网功能
### 5. 跨平台 ### 5. 跨平台
因为轻量,所以很容易支持各个平台。支持主流的操作系统:Windows,Linux,MacOS;和主流的cpu架构:386、amd64、arm、arm64、mipsle、mipsle64、mips、mips64、s390x、ppc64le 因为轻量,所以很容易支持各个平台。支持主流的操作系统:Windows,Linux,MacOS;和主流的cpu架构:386、amd64、arm、arm64、mipsle、mipsle64、mips、mips64、s390x、ppc64le
### 6. 高效 ### 6. 高效
@@ -33,11 +33,11 @@ P2P直连可以让你的设备跑满带宽。不论你的设备在任何网络
下面是一个远程办公例子:在家里连入办公室Windows电脑。 下面是一个远程办公例子:在家里连入办公室Windows电脑。
(另外一个快速入门视频 <https://www.bilibili.com/video/BV1Et4y1P7bF/> (另外一个快速入门视频 <https://www.bilibili.com/video/BV1Et4y1P7bF/>
### 1.注册 ### 1.注册
前往<https://console.openp2p.cn> 注册新用户,暂无需任何认证 前往<https://console.openp2p.cn> 使用邮箱注册新用户,暂无需任何认证
![image](/doc/images/register.png) ![image](/doc/images/register.png)
### 2.安装 ### 2.安装
分别在本地和远程电脑下载后双击运行,一键安装 分别在本地和远程电脑下载后双击运行,一键安装(如果是windows用户,在浏览器下载后请勿修改文件名!!!)
![image](/doc/images/install.png) ![image](/doc/images/install.png)
@@ -46,7 +46,7 @@ Windows默认会阻止没有花钱买它家证书签名过的程序,选择“
![image](/doc/images/win10warn.png) ![image](/doc/images/win10warn.png)
![image](/doc/images/stillrun.png) ![image](/doc/images/stillrun.png)
### 3.新建P2P应用 ### 3.新建端口转发(P2PApp)
![image](/doc/images/devices.png) ![image](/doc/images/devices.png)
@@ -54,12 +54,12 @@ Windows默认会阻止没有花钱买它家证书签名过的程序,选择“
![image](/doc/images/newappedit.png) ![image](/doc/images/newappedit.png)
### 4.使用P2P应用 ### 4.使用端口转发(P2PApp)
在“MyHomePC”设备上能看到刚才创建的P2P应用,连接下图显示的“本地监听端口”即可。 在“MyHomePC2”设备上能看到刚才创建的端口转发(P2PApp),连接下图显示的“本地监听端口”即可。
![image](/doc/images/p2pappok.png) ![image](/doc/images/p2pappok.png)
家里Windows电脑,按Win+R输入mstsc打开远程桌面,输入127.0.0.1:23389 /admin MyHomePC2电脑,按Win+R输入mstsc打开远程桌面,输入127.0.0.1:23389 /admin
![image](/doc/images/mstscconnect.png) ![image](/doc/images/mstscconnect.png)
@@ -82,8 +82,8 @@ Windows默认会阻止没有花钱买它家证书签名过的程序,选择“
![image](/doc/images/prototype.png) ![image](/doc/images/prototype.png)
### 客户端架构 ### 客户端架构
![image](/doc/images/architecture.png) ![image](/doc/images/architecture.png)
### P2PApp ### 端口转发(P2PApp)
它是项目里最重要的概念,一个P2PApp就是把远程的一个服务(mstsc/ssh等)通过P2P网络映射到本地监听。二次开发或者我们提供的Restful API,主要工作就是管理P2PApp 它是项目里最重要的概念,一个端口转发(P2PApp)就是把远程的一个服务(mstsc/ssh等)通过P2P网络映射到本地监听。二次开发或者我们提供的Restful API,主要工作就是管理端口转发(P2PApp)
![image](/doc/images/appdetail.png) ![image](/doc/images/appdetail.png)
## 安全性 ## 安全性
加入OpenP2P共享网络的节点,只能凭授权访问。共享节点只会中转数据,别人无法访问内网任何资源。 加入OpenP2P共享网络的节点,只能凭授权访问。共享节点只会中转数据,别人无法访问内网任何资源。
@@ -123,8 +123,8 @@ CGO_ENABLED=0 env GOOS=linux GOARCH=amd64 go build -o openp2p --ldflags '-s -w '
1. ~~支持IPv6~~(100%) 1. ~~支持IPv6~~(100%)
2. ~~支持随系统自动启动,安装成系统服务~~(100%) 2. ~~支持随系统自动启动,安装成系统服务~~(100%)
3. ~~提供一些免费服务器给特别差的网络,如广电网络~~(100%) 3. ~~提供一些免费服务器给特别差的网络,如广电网络~~(100%)
4. ~~建立网站,用户可以在网站管理所有P2PApp和设备。查看设备在线状态,升级,增删查改重启P2PApp等~~(100%) 4. ~~建立网站,用户可以在网站管理所有端口转发(P2PApp)和设备。查看设备在线状态,升级,增删查改重启端口转发(P2PApp)等~~(100%)
5. 建立公众号,用户可在微信公众号管理所有P2PApp和设备 5. 建立公众号,用户可在微信公众号管理所有端口转发(P2PApp)和设备
6. 客户端提供WebUI 6. 客户端提供WebUI
7. ~~支持自有服务器,开源服务器程序~~(100%) 7. ~~支持自有服务器,开源服务器程序~~(100%)
8. 共享节点调度模型优化,对不同的运营商优化 8. 共享节点调度模型优化,对不同的运营商优化
+11 -11
View File
@@ -19,7 +19,7 @@ The code is open source, the P2P tunnel uses TLS1.3+AES double encryption, and t
[details](#Safety) [details](#Safety)
### 4. Lightweight ### 4. Lightweight
2MB+ filesize, 2MB+ memory. It could only runs at application layer, or uses wintun driver for SDWAN. 10MB filesize, Extremely low CPU usage. It could only runs at application layer, or uses kmod-tun/wintun driver for SDWAN.
### 5. Cross-platform ### 5. Cross-platform
Benefit from lightweight, it easily supports most of major OS, like Windows, Linux, MacOS, also most of CPU architecture, like 386、amd64、arm、arm64、mipsle、mipsle64、mips、mips64、s390x、ppc64le. Benefit from lightweight, it easily supports most of major OS, like Windows, Linux, MacOS, also most of CPU architecture, like 386、amd64、arm、arm64、mipsle、mipsle64、mips、mips64、s390x、ppc64le.
@@ -35,11 +35,11 @@ Just 4 simple steps to use.
Here's an example of remote work: connecting to an office Windows computer at home. Here's an example of remote work: connecting to an office Windows computer at home.
(Another quick started vedio https://www.bilibili.com/video/BV1Et4y1P7bF/) (Another quick started vedio https://www.bilibili.com/video/BV1Et4y1P7bF/)
### 1.Register ### 1.Register
Go to <https://console.openp2p.cn> register a new user Go to <https://console.openp2p.cn> register a new user using email
![image](/doc/images/register_en.png) ![image](/doc/images/register_en.png)
### 2.Install ### 2.Install
Download on local and remote computers and double-click to run, one-click installation Download on local and remote computers and double-click to run, one-click installation (Windows user, please do not modify the file name after downloading in the browser!!!)
![image](/doc/images/install_en.png) ![image](/doc/images/install_en.png)
@@ -49,7 +49,7 @@ By default, Windows will block programs that have not been signed by the Microso
![image](/doc/images/stillrun_en.png) ![image](/doc/images/stillrun_en.png)
### 3.New P2PApp ### 3.New Port ForWard (P2PApp)
![image](/doc/images/devices_en.png) ![image](/doc/images/devices_en.png)
@@ -57,12 +57,12 @@ By default, Windows will block programs that have not been signed by the Microso
![image](/doc/images/newappedit_en.png) ![image](/doc/images/newappedit_en.png)
### 4.Use P2PApp ### 4.Use Port ForWard (P2PApp)
You can see the P2P application you just created on the "MyHomePC" device, just connect to the "local listening port" shown in the figure below. You can see the P2P application you just created on the "MyHomePC2" device, just connect to the "local listening port" shown in the figure below.
![image](/doc/images/p2pappok_en.png) ![image](/doc/images/p2pappok_en.png)
On MyHomePC, press Win+R and enter MSTSC to open the remote desktop, input `127.0.0.1:23389 /admin` On MyHomePC2, press Win+R and enter MSTSC to open the remote desktop, input `127.0.0.1:23389 /admin`
![image](/doc/images/mstscconnect_en.png) ![image](/doc/images/mstscconnect_en.png)
@@ -86,8 +86,8 @@ Especially suitable for large traffic intranet access.
![image](/doc/images/prototype.png) ![image](/doc/images/prototype.png)
### Client architecture ### Client architecture
![image](/doc/images/architecture.png) ![image](/doc/images/architecture.png)
### P2PApp ### Port ForWard (P2PApp)
P2PAPP is the most import concept in this project, one P2PApp is able to map the remote service(mstsc/ssh) to the local listening. The main job of re-development or restful API we provide is to manage P2PApp. Port ForWard (P2PApp) is the most import concept in this project, one Port ForWard (P2PApp) is able to map the remote service(mstsc/ssh) to the local listening. The main job of re-development or restful API we provide is to manage Port ForWard (P2PApp).
![image](/doc/images/appdetail.png) ![image](/doc/images/appdetail.png)
@@ -131,8 +131,8 @@ Short-Term:
1. ~~Support IPv6.~~(100%) 1. ~~Support IPv6.~~(100%)
2. ~~Support auto run when system boot, setup system service.~~(100%) 2. ~~Support auto run when system boot, setup system service.~~(100%)
3. ~~Provide free servers to some low-performance network.~~(100%) 3. ~~Provide free servers to some low-performance network.~~(100%)
4. ~~Build website, users can manage all P2PApp and devices via it. View devices' online status, upgrade, restart or CURD P2PApp .~~(100%) 4. ~~Build website, users can manage all Port ForWard (P2PApp) and devices via it. View devices' online status, upgrade, restart or CURD Port ForWard (P2PApp) .~~(100%)
5. Provide wechat official account, user can manage P2PApp nodes and deivce as same as website. 5. Provide wechat official account, user can manage Port ForWard (P2PApp) nodes and deivce as same as website.
6. Provide WebUI on client side. 6. Provide WebUI on client side.
7. ~~Support private server, open source server program.~~(100%) 7. ~~Support private server, open source server program.~~(100%)
8. Optimize our share scheduling model for different network operators. 8. Optimize our share scheduling model for different network operators.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 361 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 340 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 190 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 297 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 327 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 247 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 273 KiB