Initial commit

2026-06-30 15:14:37 +08:00
commit 15dab96872
311 changed files with 95639 additions and 0 deletions
@@ -0,0 +1,268 @@
+# MeshRay 快速入门指南
+
+## 🚀 快速开始
+
+### 方法一：一键启动（推荐）
+
+**Windows 用户**:
+```bash
+# 双击运行
+start.bat
+```
+
+**Linux/Mac 用户**:
+```bash
+chmod +x start.sh
+./start.sh
+```
+
+---
+
+### 方法二：手动启动
+
+#### 1. 编译后端
+```bash
+go build -o meshray.exe
+```
+
+#### 2. 编译前端
+```bash
+cd web
+npm install      # 首次需要安装依赖
+npm run build
+```
+
+#### 3. 启动服务
+```bash
+./meshray.exe    # Linux/Mac
+.\meshray.exe    # Windows
+```
+
+#### 4. 访问 Web UI
+```
+http://localhost:9531
+```
+
+---
+
+## 📋 首次使用
+
+### 1. 获取管理员账户
+
+首次启动时，系统会自动创建管理员账户：
+
+```
+🎉 首次启动！管理员账户已创建
+用户名：admin
+初始密码：xxxxxx (随机生成)
+```
+
+**重要**: 请记录初始密码，首次登录后建议立即修改！
+
+---
+
+### 2. 配置 DDNS 服务
+
+#### Cloudflare 配置
+1. 登录 [Cloudflare Dashboard](https://dash.cloudflare.com)
+2. 进入域名管理页面
+3. 点击"获取 API Token"
+4. 创建自定义 Token（权限：Zone → DNS → Edit）
+5. 复制 Token 到 MeshRay
+6. 填写 Zone ID 和域名
+
+#### 腾讯云 DNSPod 配置
+1. 登录 [DNSPod 控制台](https://console.dnspod.cn)
+2. 进入"账号管理" → "API 密钥"
+3. 创建 API 密钥
+4. 复制 SecretId 和 SecretKey 到 MeshRay
+
+#### 阿里云配置（待实现）
+⏳ 等待网络恢复后安装 libdns/aliyun
+
+---
+
+### 3. 创建 DDNS 服务
+
+1. 导航到"服务管理"
+2. 点击"新增服务"
+3. 选择"DDNS 全功能模式"
+4. 填写配置信息：
+   ```
+   服务名称：Cloudflare-DDNS-IPv4
+   云服务商：Cloudflare
+   凭证类型：API Token
+   API Token: <从 Cloudflare 获取>
+   Zone ID: <从 Cloudflare 获取>
+   域名：example.com
+   子域名：home
+   记录类型：A
+   ```
+5. 点击"自动检测"IP（可选）
+6. 保存服务
+
+---
+
+### 4. 查看监控面板
+
+1. 导航到"Dashboard"
+2. 查看 DDNS 监控卡片
+3. 查看服务统计和列表
+
+---
+
+## 🔧 常用操作
+
+### 修改密码
+1. 导航到"设置"
+2. 展开"修改密码"面板
+3. 输入原密码和新密码
+4. 点击"确认修改"
+
+### 备份配置
+1. 导航到"设置" → "备份恢复"
+2. 点击"创建备份"
+3. 下载备份文件保存
+
+### 恢复配置
+1. 导航到"设置" → "备份恢复"
+2. 选择备份文件
+3. 点击"恢复"
+4. 确认恢复操作
+
+### 检查更新
+1. 导航到"设置" → "系统更新"
+2. 点击"检查更新"
+3. 查看版本对比
+4. 点击下载链接
+
+---
+
+## 📱 通知中心使用
+
+### 查看通知
+1. 点击右上角铃铛图标 🔔
+2. 查看通知列表
+
+### 标记已读
+- 点击单条通知 → 标记为已读
+- 点击"全部已读" → 标记所有
+
+### 删除通知
+1. 点击删除按钮 🗑️
+2. 确认删除
+
+---
+
+## 🐛 故障排查
+
+### 无法启动服务
+
+**问题**: 启动后立即退出
+
+**解决**:
+```bash
+# 检查端口占用
+netstat -ano | findstr :9531
+
+# 检查配置文件
+cat config.yaml
+
+# 检查数据库
+ls data/meshray.db
+```
+
+---
+
+### 前端无法访问
+
+**问题**: 访问 http://localhost:9531 显示空白
+
+**解决**:
+```bash
+# 重新编译前端
+cd web
+rm -rf dist
+npm run build
+
+# 清除浏览器缓存
+Ctrl+Shift+Delete
+```
+
+---
+
+### DDNS 更新失败
+
+**问题**: DDNS 服务显示更新失败
+
+**解决**:
+1. 检查云服务商凭证是否正确
+2. 检查域名是否拼写错误
+3. 检查网络连接
+4. 查看日志文件：`data/logs/meshray.log`
+
+---
+
+## 📊 系统要求
+
+### 最低配置
+- **操作系统**: Windows 10 / Linux / macOS
+- **内存**: 256MB RAM
+- **磁盘**: 100MB 可用空间
+- **网络**: 需要访问互联网（DDNS 功能）
+
+### 推荐配置
+- **操作系统**: Windows 11 / Ubuntu 22.04 / macOS 13+
+- **内存**: 512MB RAM
+- **磁盘**: 500MB 可用空间
+- **网络**: 稳定的互联网连接
+
+---
+
+## 🔒 安全建议
+
+1. **修改默认密码**
+   - 首次登录后立即修改管理员密码
+   - 使用强密码（≥8 位，包含大小写字母和数字）
+
+2. **定期备份**
+   - 每周创建配置备份
+   - 将备份文件保存到安全位置
+
+3. **防火墙配置**
+   - 仅开放必要的端口（默认 9531）
+   - 使用反向代理（如 Nginx）
+
+4. **HTTPS 加密**
+   - 配置 SSL 证书
+   - 使用 Let's Encrypt 免费证书
+
+---
+
+## 📞 获取帮助
+
+### 文档资源
+- 📖 [完整功能开发总览](README_开发完成总览.md)
+- 📖 [功能验证与测试报告](功能验证与测试报告.md)
+- 📖 [WebSocket 通知推送实现报告](WebSocket 实时通知推送功能实现报告.md)
+
+### 技术支持
+- 🐛 提交 Issue
+- 💬 参与讨论
+- 📧 发送邮件至开发者
+
+---
+
+## 🎯 下一步
+
+完成基础配置后，您可以：
+
+1. ✅ **配置多个 DDNS 服务** - 支持 IPv4/IPv6 双栈
+2. ✅ **设置告警规则** - 监控系统资源
+3. ✅ **创建设备策略** - 控制访问权限
+4. ✅ **查看实时监控** - 了解网络状态
+5. ✅ **审计操作日志** - 追踪用户行为
+
+---
+
+**祝您使用愉快！** 🎉