A:更新README

This commit is contained in:
jimmy committed 2025-08-13 11:22:02 +08:00
1 parent 57e7432169
commit 707b7dd679
11 files changed
+235 -159

No files matched your search

+235 -159
View File
@@ -3,25 +3,17 @@
<div align="center">
<img src="logo.png" alt="NetVizor Logo" width="128" height="128">
[![License](https://img.shields.io/github/license/duyl328/NetVizor)](LICENSE)
[![Stars](https://img.shields.io/github/stars/duyl328/NetVizor)](https://github.com/duyl328/NetVizor/stargazers)
[![Issues](https://img.shields.io/github/issues/duyl328/NetVizor)](https://github.com/duyl328/NetVizor/issues)
[![Release](https://img.shields.io/github/v/release/duyl328/NetVizor)](https://github.com/duyl328/NetVizor/releases)
[![License](https://img.shields.io/github/license/duyl328/NetVizor)](LICENSE)
[![Stars](https://img.shields.io/github/stars/duyl328/NetVizor)](https://github.com/duyl328/NetVizor/stargazers)
[![Issues](https://img.shields.io/github/issues/duyl328/NetVizor)](https://github.com/duyl328/NetVizor/issues)
[![Release](https://img.shields.io/github/v/release/duyl328/NetVizor)](https://github.com/duyl328/NetVizor/releases)
<h3>A Modern Windows Network Monitoring and Firewall Management Tool</h3>
<h3>现代化的 Windows 网络监控与防火墙管理工具</h3>
<h3>A Modern Windows Network Monitoring and Firewall Management Tool</h3>
<h3>现代化的 Windows 网络监控与防火墙管理工具</h3>
[English](#english) | [中文](#chinese)
[English](#english) | [中文](#chinese)
</div>
<p style="color: red; font-weight: bold;">
🚧 当前项目正在积极开发阶段,在 <code>1.0</code> 版本前不保证项目可用性。
</p>
<p style="color: red; font-weight: bold;">
🚧 The project is currently in active development, and there is no guarantee of project availability until the <code>1.0</code> release.
</p>
---
<a name="english"></a>
@@ -29,108 +21,146 @@
### 🚀 Overview
NetVizor is a modern, lightweight Windows network monitoring and firewall management tool that combines the simplicity of TinyWall with the visualization capabilities of GlassWire. Built with performance and user experience in mind, it provides real-time network insights and intuitive firewall control.
NetVizor is a modern, lightweight Windows network monitoring and firewall management tool that combines TinyWall's simplicity with GlassWire's visualization capabilities. Designed with performance and user experience at its core, it provides real-time network insights and intuitive firewall control.
### ✨ Features
### ✨ Key Features
#### Core Monitoring
- **Real-time Process Monitoring** - Track network connections for each process
- **Live Traffic Statistics** - Monitor upload/download speeds per process
#### Real-time Process Network Monitoring
- **Live Process Tracking** - Monitor network connections for every process
- **Real-time Traffic Statistics** - Track upload/download speeds for each process
- **Connection Details** - View protocols, ports, and connection states
- **DNS Resolution** - Map IP addresses to domain names
- **Historical Data** - Track network usage over time
- **Historical Data** - Track network usage history over time
#### Firewall Management
- **Easy Rule Creation** - Quick wizards for creating firewall rules
- **One-click Block/Allow** - Instantly control application access
- **Easy Rule Creation** - Quick wizard for creating firewall rules
- **One-click Block/Allow** - Instant control over application access
- **Rule Templates** - Pre-configured rules for common applications
- **Windows Firewall Integration** - Built on Windows Firewall APIs
#### Visualization
- **Real-time Charts** - Beautiful traffic graphs powered by ECharts
#### Network Usage History & Analytics
- **Real-time Charts** - Traffic graphs powered by ECharts
- **Process Traffic Distribution** - Visual breakdown of bandwidth usage
- **Connection Maps** - Geographic visualization of connections
- **Modern UI** - Clean, responsive interface built with Vue 3
#### Smart Features
- **Learning Mode** - Automatically suggest rules based on behavior
- **Anomaly Detection** - Alert on suspicious network activity
- **Gaming Mode** - Temporary rule relaxation for gaming
- **Bandwidth Predictions** - Forecast future usage trends
### Interface Overview
- **Floating Window**
![Floating Window](./docs/imgs/readme/FloatingWindow.png)
- **Top Speed List**
![Top List](./docs/imgs/readme/TopList.png)
- **Real-time Monitoring**
![Real-time Analysis](./docs/imgs/readme/analyse.gif)
<details>
<summary>Click to expand GIF demonstrations</summary>
- **Firewall Management**
![Firewall Management](./docs/imgs/readme/firewall.gif)
- **Historical Data Analysis**
![Data Analysis](./docs/imgs/readme/data.gif)
</details>
### 🚀 Quick Start
1. Download the latest version from [Releases](https://github.com/duyl328/NetVizor/releases)
2. Extract the archive to your preferred directory and run `Shell.exe` (Administrator privileges required for ETW and Firewall API access)
3. After startup, a network speed floating window will appear in the top-right corner of your screen, and the application will be available in the system tray
4. Right-click the floating window to access settings, or navigate to "Traffic Statistics & Analysis" for detailed monitoring and configuration
### 🔧 Building from Source
```bash
# Clone the repository
git clone https://github.com/duyl328/NetVizor.git
cd NetVizor
# Build backend
cd src/NetVizor.Backend
dotnet build
# Build frontend
cd ../NetVizor.Frontend
npm install
npm run build
# Run the application
cd ../NetVizor.Backend
dotnet run
```
### 📋 System Requirements
- Windows 10/11 (x64)
- .NET 8.0 Runtime
- WebView2 Runtime
- Administrator privileges (required for firewall management and ETW data collection)
### 🛠️ Technology Stack
- **Backend**: C# (.NET 6+)
- ETW (Event Tracing for Windows) for network monitoring
- Windows Firewall with Advanced Security APIs
- High-performance data processing
#### Backend
- **Framework**: .NET 8.0 + WPF
- **Data Collection**: ETW (Event Tracing for Windows)
- **Database**: SQLite
- **Communication**: HTTP + WebSocket
- **Frontend**: Vue 3 + TypeScript
- WebView2 for native integration
- ECharts for data visualization
- Tailwind CSS for modern styling
#### Frontend
- **UI Framework**: Vue 3 + TypeScript
- **Build Tool**: Vite
- **Charts**: ECharts
- **UI Components**: NaiveUI
- **Rendering**: WebView2
- **Communication**: WebSocket for real-time updates
### 🗺️ Roadmap
### 📋 Requirements
- **Network Access Detection & Alerts**
- User-configurable detection rules
- Popup/sound/log alerts when applications trigger rules
- Filtering by process, port, IP, protocol, and more
- Windows 10 version 1809 or later
- .NET 6.0 Runtime
- WebView2 Runtime (auto-installed if missing)
- Administrator privileges (for firewall management)
- **Taskbar Network Speed Display**
- Real-time network speed display in taskbar/control bar
- Alternative to floating window display
[//]: # (### 🚀 Quick Start)
- **Bandwidth Limiting**
- Bandwidth throttling before network requests complete
- Per-application or global upload/download speed limits
[//]: # ()
[//]: # (1. Download the latest release from [Releases]&#40;https://github.com/duyl328/NetVizor/releases&#41;)
- **Enhanced Firewall Management**
- Comprehensive rule creation, editing, and batch management
- Multi-condition rules (application, IP, port, protocol, direction)
- Rule templates and quick-apply functionality
[//]: # (2. Run the installer as Administrator)
- **GeoIP Mapping**
- Map connection IPs to geographic locations
- Map visualization of connection distribution
[//]: # (3. Launch NetVizor from the Start Menu)
- **Custom Alerts**
- Notify users when:
- Network speed anomalies occur
- Unknown programs connect to network
- Connections to blacklisted IPs
[//]: # (4. Follow the initial setup wizard)
- **DNS Resolution**
- Resolve remote IPs to domain names
- Easy identification of connection targets
[//]: # ()
[//]: # (### 🔧 Building from Source)
- **Multi-language Support**
- Support for English, Chinese, and other languages
- Internationalized UI
[//]: # ()
[//]: # (```bash)
[//]: # (# Clone the repository)
[//]: # (git clone https://github.com/duyl328/NetVizor.git)
[//]: # (cd NetVizor)
[//]: # ()
[//]: # (# Build backend)
[//]: # (cd src/NetVizor.Backend)
[//]: # (dotnet build)
[//]: # ()
[//]: # (# Build frontend)
[//]: # (cd ../NetVizor.Frontend)
[//]: # (npm install)
[//]: # (npm run build)
[//]: # ()
[//]: # (# Run the application)
[//]: # (cd ../NetVizor.Backend)
[//]: # (dotnet run)
[//]: # (```)
- **Behavior-based Automatic Rule Suggestions**
- Analyze application network behavior patterns
- Automatically suggest appropriate firewall rules
### 🤝 Contributing
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
@@ -139,14 +169,32 @@ We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for deta
### 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the GPL 3.0 License - see the [LICENSE](LICENSE) file for details.
### 🙏 Acknowledgments
- Inspired by TinyWall and GlassWire
- Built with Windows ETW and Firewall APIs
- Built on Windows ETW and Firewall APIs
- UI powered by Vue.js and ECharts
### 🌟 Star History
[![Star History Chart](https://api.star-history.com/svg?repos=duyl328/NetVizor&type=Date)](https://star-history.com/#duyl328/NetVizor&Date)
### 📞 Contact
- Issues: [GitHub Issues](https://github.com/duyl328/NetVizor/issues)
- Discussions: [GitHub Discussions](https://github.com/duyl328/NetVizor/discussions)
- Email: yylyou333@gmail.com
### 💖 Support the Project
If you find this project helpful, please consider:
- ⭐ **Starring the project**
- 🐛 Reporting bugs
- 💡 Suggesting new features
- 🤝 Contributing code
---
<a name="chinese"></a>
@@ -158,102 +206,141 @@ NetVizor 是一个现代化、轻量级的 Windows 网络监控和防火墙管
### ✨ 功能特性
#### 核心监控
- **实时进程监控** - 追踪每个进程的网络连接
#### 实时进程网络监控
- **实时进程追踪** - 监控每个进程的网络连接
- **实时流量统计** - 监控每个进程的上传/下载速度
- **连接详情** - 查看协议、端口和连接状态
- **DNS 解析** - 将 IP 地址映射为域名
- **历史数据** - 追踪网络使用历史
- **历史数据** - 追踪网络使用历史记录
#### 防火墙管理
- **便捷规则创建** - 快速向导创建防火墙规则
- **一键阻止/允许** - 即时控制应用程序访问
- **一键阻止/允许** - 即时控制应用程序网络访问
- **规则模板** - 常见应用程序的预配置规则
- **Windows 防火墙集成** - 基于 Windows 防火墙 API 构建
#### 可视化
- **实时图表** - 由 ECharts 驱动的精美流量图
#### 网络使用历史与分析
- **实时图表** - 由 ECharts 驱动的流量图表
- **进程流量分布** - 带宽使用的可视化分解
- **连接地图** - 连接的地理位置可视化
- **现代化 UI** - 使用 Vue 3 构建的简洁、响应式界面
#### 智能功能
- **学习模式** - 基于行为自动建议规则
- **异常检测** - 对可疑网络活动发出警报
- **游戏模式** - 游戏时临时放松规则
- **带宽预测** - 预测未来使用趋势
### 界面概览
### 🛠️ 技术栈
- **悬浮窗**
![悬浮窗](./docs/imgs/readme/FloatingWindow.png)
- **后端**: C# (.NET 6+)
- ETW (Windows 事件跟踪) 用于网络监控
- Windows 高级安全防火墙 API
- 高性能数据处理
- **网速排行榜**
![网速排行榜](./docs/imgs/readme/TopList.png)
- **前端**: Vue 3 + TypeScript
- WebView2 原生集成
- ECharts 数据可视化
- Tailwind CSS 现代化样式
- **实时监控**
![实时分析](./docs/imgs/readme/analyse.gif)
- **通信**: WebSocket 实时更新
<details>
<summary>点击展开 GIF 演示</summary>
### 📋 系统要求
- **防火墙管理**
![防火墙管理](./docs/imgs/readme/firewall.gif)
- Windows 10 版本 1809 或更高版本
- .NET 6.0 运行时
- WebView2 运行时(如果缺失会自动安装)
- 管理员权限(用于防火墙管理)
- **历史数据分析**
![数据分析](./docs/imgs/readme/data.gif)
</details>
### 🚀 快速开始
[//]: # ()
[//]: # (1. 从 [Releases]&#40;https://github.com/duyl328/NetVizor/releases&#41; 下载最新版本)
1. 从 [Releases](https://github.com/duyl328/NetVizor/releases) 下载最新版本
[//]: # (2. 以管理员身份运行安装程序)
2. 将压缩包解压至指定目录,运行 `Shell.exe` 即可(软件启动需要管理员权限,ETW 与防火墙 API 均需管理员权限)
[//]: # (3. 从开始菜单启动 NetVizor)
3. 软件启动后会在电脑右上角显示网速悬浮窗,右下角系统托盘也会同时显示软件图标
[//]: # (4. 按照初始设置向导操作)
4. 您可以右击悬浮窗进入设置页面,或者进入"流量统计与分析"来进行详细查看和设置
[//]: # (### 🔧 从源码构建)
### 🔧 从源码构建
[//]: # ()
[//]: # (```bash)
```bash
# 克隆仓库
git clone https://github.com/duyl328/NetVizor.git
cd NetVizor
[//]: # (# 克隆仓库)
# 构建后端
cd src/NetVizor.Backend
dotnet build
[//]: # (git clone https://github.com/duyl328/NetVizor.git)
# 构建前端
cd ../NetVizor.Frontend
npm install
npm run build
[//]: # (cd NetVizor)
# 运行应用程序
cd ../NetVizor.Backend
dotnet run
```
[//]: # ()
[//]: # (# 构建后端)
### 📋 系统要求
[//]: # (cd src/NetVizor.Backend)
- Windows 10/11 (x64)
- .NET 8.0 Runtime
- WebView2 Runtime
- 管理员权限(用于防火墙管理和 ETW 数据收集)
[//]: # (dotnet build)
### 🛠️ 技术栈
[//]: # ()
[//]: # (# 构建前端)
#### 后端技术
- **框架**: .NET 8.0 + WPF
- **数据收集**: ETW (Event Tracing for Windows)
- **数据库**: SQLite
- **通信**: HTTP + WebSocket
[//]: # (cd ../NetVizor.Frontend)
#### 前端技术
- **UI 框架**: Vue 3 + TypeScript
- **构建工具**: Vite
- **图表库**: ECharts
- **UI 组件**: NaiveUI
- **渲染**: WebView2
[//]: # (npm install)
### 🗺️ 开发路线图
[//]: # (npm run build)
- **网络访问检测与报警**
- 支持用户自定义检测规则
- 当软件触发规则时可进行弹窗/声音/日志报警
- 可按进程、端口、IP、协议等条件设置
[//]: # ()
[//]: # (# 运行应用程序)
- **任务栏网速显示**
- 在悬浮窗外,提供任务栏/控制栏的实时网速显示
- 作为悬浮窗显示的替代方案
[//]: # (cd ../NetVizor.Backend)
- **网速限制功能**
- 在网络请求完成前进行带宽限制
- 可针对单个应用或全局限制上传/下载速度
[//]: # (dotnet run)
- **防火墙管理增强**
- 更加全面的规则创建、编辑和批量管理能力
- 支持按应用、IP、端口、协议、方向等多条件组合规则
- 提供规则模板和快速应用功能
[//]: # (```)
- **GeoIP 地理映射**
- 将连接的 IP 地址映射到地理位置
- 地图可视化展示连接分布
### 🤝 贡献
- **自定义报警系统**
- 当出现以下情况时通知用户:
- 网速异常波动
- 未知程序联网
- 连接到黑名单 IP
我们欢迎贡献!请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详情。
- **DNS 域名解析**
- 将远程 IP 解析为域名
- 便于快速识别连接目标
- **多语言支持**
- 支持英文、中文等多语言切换
- 国际化用户界面
- **基于行为的自动规则建议**
- 分析程序的联网行为模式
- 自动推荐相应的防火墙规则
### 🤝 贡献指南
1. Fork 本仓库
2. 创建您的功能分支 (`git checkout -b feature/AmazingFeature`)
@@ -263,7 +350,7 @@ NetVizor 是一个现代化、轻量级的 Windows 网络监控和防火墙管
### 📝 许可证
本项目采用 GPL3.0 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
本项目采用 GPL 3.0 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
### 🙏 致谢
@@ -281,21 +368,10 @@ NetVizor 是一个现代化、轻量级的 Windows 网络监控和防火墙管
- Discussions: [GitHub Discussions](https://github.com/duyl328/NetVizor/discussions)
- Email: yylyou333@gmail.com
### 🗺️ 路线图
- [ ] 基础网络监控功能
- [ ] Windows 防火墙集成
- [ ] 实时流量可视化
- [ ] 学习模式和智能规则建议
- [ ] 多语言支持
- [ ] 插件系统
- [ ] 云同步功能
- [ ] 移动端配套应用
### 💖 支持项目
如果您觉得这个项目有帮助,请考虑:
- ⭐ 给项目加星
- ⭐ **给项目加星**
- 🐛 报告问题
- 💡 建议新功能
- 🤝 贡献代码
Binary file not shown.

After

Width:  |  Height:  |  Size: 135 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 219 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 236 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 365 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 MiB