freedakgmail
134 lines
4.2 KiB
Markdown
134 lines
4.2 KiB
Markdown
# 📚 项目文档索引
|
|
|
|
## 🚀 快速开始
|
|
|
|
| 文档 | 说明 | 适用场景 |
|
|
|------|------|---------|
|
|
| [README.md](./README.md) | 项目主文档 | 了解项目、快速开始 |
|
|
| [DEPLOY_QUICK_START.md](./DEPLOY_QUICK_START.md) | 快速部署指南 | 快速部署到服务器 |
|
|
| [DEPLOY_GUIDE.md](./DEPLOY_GUIDE.md) | 完整部署指南 | 详细的部署步骤和配置 |
|
|
|
|
## 🔧 问题修复
|
|
|
|
| 文档 | 说明 | 适用场景 |
|
|
|------|------|---------|
|
|
| [QUICK_FIX_CARD.md](./QUICK_FIX_CARD.md) | 快速修复卡片 | 快速查看修复步骤 |
|
|
| [问题修复总结.md](./问题修复总结.md) | 重定向循环问题完整分析 | 深入理解问题原因 |
|
|
| [REDIRECT_LOOP_FIX.md](./REDIRECT_LOOP_FIX.md) | 重定向循环详细修复指南 | 详细的修复步骤和说明 |
|
|
|
|
## 🛠️ 工具脚本
|
|
|
|
| 脚本 | 说明 | 使用方法 |
|
|
|------|------|---------|
|
|
| [fix-redirect-loop.sh](./fix-redirect-loop.sh) | 自动修复重定向循环 | `./fix-redirect-loop.sh` |
|
|
| [deploy.sh](./deploy.sh) | 自动部署脚本 | `./deploy.sh` |
|
|
| [check-server.sh](./check-server.sh) | 检查服务器状态 | `./check-server.sh` |
|
|
|
|
## 📖 功能文档
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [BUTTONS_SUMMARY.md](./BUTTONS_SUMMARY.md) | 按钮功能总结 |
|
|
| [IMAGE_GUIDE.md](./IMAGE_GUIDE.md) | 图片处理指南 |
|
|
| [EMAIL_SETUP_SUMMARY.md](./EMAIL_SETUP_SUMMARY.md) | 邮件设置总结 |
|
|
|
|
## 🔐 权限系统
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [PERMISSIONS_QUICK_REFERENCE.md](./PERMISSIONS_QUICK_REFERENCE.md) | 权限快速参考 |
|
|
| [API_PERMISSION_VERIFICATION.md](./API_PERMISSION_VERIFICATION.md) | API权限验证 |
|
|
| [PERMISSION_IMPLEMENTATION_SUCCESS.md](./PERMISSION_IMPLEMENTATION_SUCCESS.md) | 权限实现成功总结 |
|
|
|
|
## 📝 开发文档
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [OPTIMIZATION_SUMMARY.md](./OPTIMIZATION_SUMMARY.md) | 优化总结 |
|
|
| [FINAL_SUMMARY.md](./FINAL_SUMMARY.md) | 最终总结 |
|
|
| [FINAL_CHECK.md](./FINAL_CHECK.md) | 最终检查清单 |
|
|
|
|
## 🌐 部署相关
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [部署说明.md](./部署说明.md) | 中文部署说明 |
|
|
| [部署脚本检查报告.md](./部署脚本检查报告.md) | 部署脚本检查 |
|
|
|
|
---
|
|
|
|
## 🔍 按问题类型查找
|
|
|
|
### 遇到重定向循环错误 (ERR_TOO_MANY_REDIRECTS)
|
|
1. 🚨 [QUICK_FIX_CARD.md](./QUICK_FIX_CARD.md) - 快速查看修复步骤
|
|
2. 🔧 运行 `./fix-redirect-loop.sh` - 自动修复
|
|
3. 📖 [问题修复总结.md](./问题修复总结.md) - 了解详细原因
|
|
4. 📚 [REDIRECT_LOOP_FIX.md](./REDIRECT_LOOP_FIX.md) - 手动修复指南
|
|
|
|
### 首次部署
|
|
1. 📖 [DEPLOY_QUICK_START.md](./DEPLOY_QUICK_START.md) - 快速开始
|
|
2. 📚 [DEPLOY_GUIDE.md](./DEPLOY_GUIDE.md) - 详细步骤
|
|
3. 🔧 运行 `./deploy.sh` - 自动部署
|
|
|
|
### 权限配置问题
|
|
1. 📖 [PERMISSIONS_QUICK_REFERENCE.md](./PERMISSIONS_QUICK_REFERENCE.md) - 快速参考
|
|
2. 📚 [API_PERMISSION_VERIFICATION.md](./API_PERMISSION_VERIFICATION.md) - API权限
|
|
|
|
### 功能使用问题
|
|
1. 📖 [README.md](./README.md) - 查看功能列表
|
|
2. 📚 [BUTTONS_SUMMARY.md](./BUTTONS_SUMMARY.md) - 按钮功能
|
|
3. 📚 [IMAGE_GUIDE.md](./IMAGE_GUIDE.md) - 图片处理
|
|
|
|
---
|
|
|
|
## 📌 重要提示
|
|
|
|
### ⚠️ 环境变量配置
|
|
- `NEXTAUTH_URL` **必须**与用户访问URL完全一致
|
|
- 详见: [问题修复总结.md](./问题修复总结.md)
|
|
|
|
### 🔐 安全建议
|
|
- 定期更新 `NEXTAUTH_SECRET`
|
|
- 使用强密码
|
|
- 配置HTTPS (生产环境)
|
|
|
|
### 📊 性能优化
|
|
- 参考: [OPTIMIZATION_SUMMARY.md](./OPTIMIZATION_SUMMARY.md)
|
|
- 使用PM2集群模式
|
|
- 配置日志轮转
|
|
|
|
---
|
|
|
|
## 🆘 获取帮助
|
|
|
|
1. **查看日志**
|
|
```bash
|
|
ssh -p 8006 root@115.190.235.230 'pm2 logs chinese-family-tree'
|
|
```
|
|
|
|
2. **检查配置**
|
|
```bash
|
|
ssh -p 8006 root@115.190.235.230 'cd /var/www/chinese-family-tree && cat .env'
|
|
```
|
|
|
|
3. **运行诊断脚本**
|
|
```bash
|
|
./check-server.sh
|
|
```
|
|
|
|
4. **查看相关文档**
|
|
- 根据问题类型选择对应文档
|
|
- 使用文档内的搜索功能
|
|
|
|
---
|
|
|
|
## 📅 文档更新日志
|
|
|
|
- **2024-11-24**: 添加重定向循环问题修复文档
|
|
- **2024-11-24**: 创建文档索引
|
|
- **2024-11-24**: 更新部署指南
|
|
|
|
---
|
|
|
|
**提示**: 建议收藏本文档,方便快速查找所需信息!
|