357 lines
7.3 KiB
Markdown
Executable File
357 lines
7.3 KiB
Markdown
Executable File
# ✅ 部署完成检查清单
|
||
|
||
## 🎉 恭喜!所有文件已准备就绪
|
||
|
||
您的 Meow Music Server v2.0 已经配置完成,现在可以开始部署了!
|
||
|
||
---
|
||
|
||
## 📦 已创建的文件
|
||
|
||
### 后端系统
|
||
- ✅ `user.go` - 用户认证系统
|
||
- ✅ `struct.go` - 数据结构(已更新)
|
||
- ✅ `playlist.go` - 歌单管理(已扩展)
|
||
- ✅ `main.go` - 主程序(已更新路由)
|
||
- ✅ `index.go` - 路由处理(已更新)
|
||
- ✅ `go.mod` - 依赖配置(已添加bcrypt)
|
||
|
||
### 前端界面
|
||
- ✅ `theme/music-app.html` - 现代化React应用
|
||
|
||
### 启动脚本
|
||
- ✅ `start.bat` - Windows一键启动
|
||
- ✅ `start.sh` - Linux/macOS一键启动
|
||
|
||
### 文档
|
||
- ✅ `快速开始.md` - 3分钟快速部署
|
||
- ✅ `本地部署指南.md` - 详细部署教程
|
||
- ✅ `USER_SYSTEM_README.md` - API使用文档
|
||
- ✅ `新功能说明.md` - 功能特性说明
|
||
- ✅ `README_zh-CN.md` - 项目主文档(已更新)
|
||
|
||
---
|
||
|
||
## 🚀 现在开始部署
|
||
|
||
### Windows 用户
|
||
|
||
#### 方式一:一键启动(推荐)
|
||
|
||
1. 找到 `start.bat` 文件
|
||
2. **双击运行**
|
||
3. 等待启动完成
|
||
4. 浏览器访问:http://localhost:2233/app
|
||
|
||
#### 方式二:命令行启动
|
||
|
||
```bash
|
||
# 打开 PowerShell 或 CMD
|
||
cd d:\esp32-music-server\Meow\MeowEmbeddedMusicServer
|
||
|
||
# 运行启动脚本
|
||
start.bat
|
||
```
|
||
|
||
---
|
||
|
||
### Linux/macOS 用户
|
||
|
||
```bash
|
||
# 1. 进入项目目录
|
||
cd /path/to/MeowEmbeddedMusicServer
|
||
|
||
# 2. 给脚本添加执行权限
|
||
chmod +x start.sh
|
||
|
||
# 3. 运行启动脚本
|
||
./start.sh
|
||
|
||
# 4. 浏览器访问
|
||
# http://localhost:2233/app
|
||
```
|
||
|
||
---
|
||
|
||
## 🎯 启动后的操作
|
||
|
||
### 1️⃣ 验证服务器启动
|
||
|
||
启动后你应该看到:
|
||
|
||
```
|
||
╔═══════════════════════════════════════════════╗
|
||
║ 🎵 Meow Embedded Music Server v2.0 ║
|
||
║ 喵波音律 - 专为ESP32设计的音乐服务器 ║
|
||
╚═══════════════════════════════════════════════╝
|
||
|
||
[✓] Go环境检测成功
|
||
[✓] 配置文件已创建/存在
|
||
[✓] 依赖安装完成
|
||
[✓] 服务器正在启动...
|
||
|
||
访问地址:
|
||
新版应用: http://localhost:2233/app
|
||
经典界面: http://localhost:2233/
|
||
```
|
||
|
||
### 2️⃣ 访问应用
|
||
|
||
在浏览器中打开:**http://localhost:2233/app**
|
||
|
||
你应该看到登录/注册页面,紫色渐变背景。
|
||
|
||
### 3️⃣ 注册第一个账户
|
||
|
||
1. 点击"注册"标签
|
||
2. 填写信息:
|
||
- 用户名:`admin`
|
||
- 邮箱:`admin@music.com`
|
||
- 密码:`password123`(至少6位)
|
||
3. 点击"注册"按钮
|
||
4. 自动登录进入主界面
|
||
|
||
### 4️⃣ 测试功能
|
||
|
||
**搜索音乐:**
|
||
1. 在搜索框输入:`告白气球`
|
||
2. 点击"搜索"
|
||
3. 等待搜索结果
|
||
|
||
**播放音乐:**
|
||
1. 搜索结果显示后
|
||
2. 点击"▶ 播放"按钮
|
||
|
||
**添加到收藏:**
|
||
1. 在搜索结果页
|
||
2. 下拉菜单选择"我喜欢"
|
||
3. 歌曲自动添加
|
||
|
||
**创建歌单:**
|
||
1. 左侧边栏点击"+"号
|
||
2. 输入歌单名:`我的最爱`
|
||
3. 确认创建
|
||
|
||
---
|
||
|
||
## ✅ 功能验证清单
|
||
|
||
请确认以下功能都正常工作:
|
||
|
||
### 基础功能
|
||
- [ ] 服务器成功启动,无错误提示
|
||
- [ ] 可以访问 http://localhost:2233/app
|
||
- [ ] 可以看到登录/注册界面
|
||
- [ ] 界面显示正常(紫色渐变背景)
|
||
|
||
### 用户系统
|
||
- [ ] 可以注册新用户
|
||
- [ ] 注册后自动登录
|
||
- [ ] 可以退出登录
|
||
- [ ] 可以重新登录
|
||
|
||
### 音乐功能
|
||
- [ ] 可以搜索音乐
|
||
- [ ] 搜索结果正常显示
|
||
- [ ] 可以播放音乐
|
||
- [ ] 音频播放正常
|
||
|
||
### 歌单功能
|
||
- [ ] 可以看到"我喜欢"歌单
|
||
- [ ] 可以创建新歌单
|
||
- [ ] 可以添加歌曲到歌单
|
||
- [ ] 可以查看歌单歌曲列表
|
||
- [ ] 可以播放歌单中的歌曲
|
||
|
||
---
|
||
|
||
## 🔧 常见问题快速解决
|
||
|
||
### ❌ 启动失败:端口被占用
|
||
|
||
**现象**:提示 `address already in use`
|
||
|
||
**解决**:
|
||
```bash
|
||
# Windows
|
||
netstat -ano | findstr :2233
|
||
taskkill /PID <进程ID> /F
|
||
|
||
# Linux/macOS
|
||
lsof -i :2233
|
||
kill -9 <PID>
|
||
```
|
||
|
||
### ❌ 依赖下载失败
|
||
|
||
**现象**:提示 `go: downloading ... failed`
|
||
|
||
**解决**(中国大陆用户):
|
||
```bash
|
||
go env -w GOPROXY=https://goproxy.cn,direct
|
||
```
|
||
|
||
然后重新运行启动脚本
|
||
|
||
### ❌ 找不到 Go 命令
|
||
|
||
**解决**:
|
||
- 安装 Go: https://golang.org/dl/
|
||
- 安装后重新打开终端
|
||
|
||
### ❌ 页面无法访问
|
||
|
||
**检查**:
|
||
1. 服务器是否成功启动?
|
||
2. 浏览器地址是否正确?
|
||
3. 防火墙是否阻止了端口?
|
||
|
||
---
|
||
|
||
## 📁 数据文件位置
|
||
|
||
服务器运行后会自动创建:
|
||
|
||
```
|
||
files/
|
||
├── users.json # 用户账户数据
|
||
├── user_playlists.json # 用户歌单数据
|
||
└── playlists.json # 全局歌单(兼容旧版)
|
||
|
||
cache/
|
||
└── music/ # 缓存的音乐文件
|
||
```
|
||
|
||
**重要提示**:
|
||
- ⚠️ 不要手动编辑这些文件
|
||
- 💾 定期备份 `files/` 目录
|
||
- 🗑️ 可以删除 `cache/` 目录清理空间
|
||
|
||
---
|
||
|
||
## 🌐 局域网访问配置
|
||
|
||
如果需要让同一WiFi下的其他设备访问:
|
||
|
||
### 1. 查找本机IP
|
||
|
||
**Windows:**
|
||
```bash
|
||
ipconfig
|
||
```
|
||
查找 "IPv4 地址",如:`192.168.1.100`
|
||
|
||
**Linux/macOS:**
|
||
```bash
|
||
ifconfig
|
||
# 或
|
||
ip addr show
|
||
```
|
||
|
||
### 2. 修改配置
|
||
|
||
编辑 `.env` 文件(如果不存在则创建):
|
||
```env
|
||
WEBSITE_URL=http://192.168.1.100:2233
|
||
EMBEDDED_WEBSITE_URL=http://192.168.1.100:2233
|
||
```
|
||
|
||
### 3. 配置防火墙
|
||
|
||
**Windows:**
|
||
- 控制面板 → Windows防火墙 → 高级设置
|
||
- 入站规则 → 新建规则 → 端口 → TCP → 2233
|
||
|
||
**Linux:**
|
||
```bash
|
||
sudo ufw allow 2233/tcp
|
||
```
|
||
|
||
### 4. 重启服务器
|
||
|
||
按 `Ctrl+C` 停止,然后重新运行启动脚本
|
||
|
||
### 5. 其他设备访问
|
||
|
||
在同一WiFi下的设备浏览器访问:
|
||
```
|
||
http://192.168.1.100:2233/app
|
||
```
|
||
|
||
---
|
||
|
||
## 📚 进阶使用
|
||
|
||
### 编译可执行文件
|
||
|
||
```bash
|
||
# Windows
|
||
go build -o meow-music.exe
|
||
|
||
# Linux/macOS
|
||
go build -o meow-music
|
||
```
|
||
|
||
### 后台运行(Linux/macOS)
|
||
|
||
```bash
|
||
nohup ./start.sh > server.log 2>&1 &
|
||
```
|
||
|
||
### 查看日志
|
||
|
||
```bash
|
||
tail -f server.log
|
||
```
|
||
|
||
---
|
||
|
||
## 📞 获取帮助
|
||
|
||
### 查看详细文档
|
||
- 📖 `快速开始.md` - 基础使用
|
||
- 📚 `本地部署指南.md` - 详细教程
|
||
- 🔧 `USER_SYSTEM_README.md` - API文档
|
||
|
||
### 社区支持
|
||
- QQ群:865754861(喵波音律-音乐家园)
|
||
|
||
### 问题排查
|
||
1. 查看启动窗口的日志输出
|
||
2. 检查 `files/` 目录权限
|
||
3. 确认Go版本 >= 1.19
|
||
4. 尝试删除 `files/` 目录重新启动
|
||
|
||
---
|
||
|
||
## 🎉 部署成功!
|
||
|
||
如果上面的功能验证清单都打勾了,恭喜你!
|
||
|
||
**你现在拥有一个完整的音乐服务器了!** 🎵✨
|
||
|
||
### 下一步可以做什么?
|
||
|
||
- 🎵 搜索并收藏你喜欢的音乐
|
||
- 📋 创建不同主题的歌单
|
||
- 📱 配置局域网访问,让朋友也能用
|
||
- 💾 定期备份用户数据
|
||
- 🎨 自定义网站信息(修改 .env 文件)
|
||
|
||
---
|
||
|
||
## 🔄 版本信息
|
||
|
||
```
|
||
Meow Embedded Music Server
|
||
Version: 2.0.0
|
||
Release Date: 2024
|
||
Features: User System + Playlist Management
|
||
```
|
||
|
||
---
|
||
|
||
**开始享受您的音乐之旅吧!** 🎵
|
||
|
||
有任何问题随时查看文档或联系社区!
|