132 lines
3.1 KiB
Markdown
132 lines
3.1 KiB
Markdown
|
# 环境配置快速参考
|
|||
|
|
|
|||
|
|
## 🚀 快速开始
|
|||
|
|
|
|||
|
|
### 1. 创建开发环境配置
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
cd backend
|
|||
|
|
|
|||
|
|
# 创建开发环境配置文件
|
|||
|
|
cat > .env.development << 'EOF'
|
|||
|
|
NODE_ENV=development
|
|||
|
|
DATABASE_URL="mysql://root:password@localhost:3306/competition_management_dev?schema=public"
|
|||
|
|
JWT_SECRET="dev-secret-key"
|
|||
|
|
PORT=3001
|
|||
|
|
EOF
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 2. 创建生产环境配置
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 创建生产环境配置文件（不要提交到 Git）
|
|||
|
|
cat > .env.production << 'EOF'
|
|||
|
|
NODE_ENV=production
|
|||
|
|
DATABASE_URL="mysql://prod_user:strong_password@prod-host:3306/competition_management?schema=public&sslmode=require"
|
|||
|
|
JWT_SECRET="$(openssl rand -hex 32)"
|
|||
|
|
PORT=3001
|
|||
|
|
EOF
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 3. 创建数据库
|
|||
|
|
|
|||
|
|
```sql
|
|||
|
|
-- 开发环境数据库
|
|||
|
|
CREATE DATABASE competition_management_dev
|
|||
|
|
CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
|||
|
|
|
|||
|
|
-- 生产环境数据库
|
|||
|
|
CREATE DATABASE competition_management
|
|||
|
|
CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 4. 初始化数据库
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 开发环境
|
|||
|
|
pnpm prisma:generate
|
|||
|
|
pnpm prisma:migrate
|
|||
|
|
|
|||
|
|
# 生产环境（部署时）
|
|||
|
|
NODE_ENV=production pnpm prisma:migrate:deploy
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 📋 环境区分总结
|
|||
|
|
|
|||
|
|
| 项目 | 开发环境 | 生产环境 |
|
|||
|
|
|------|---------|---------|
|
|||
|
|
| **配置文件** | `.env.development` | `.env.production` |
|
|||
|
|
| **数据库名** | `competition_management_dev` | `competition_management` |
|
|||
|
|
| **启动命令** | `pnpm start:dev` | `pnpm start:prod` |
|
|||
|
|
| **迁移命令** | `pnpm prisma:migrate` | `pnpm prisma:migrate:deploy` |
|
|||
|
|
| **Prisma Studio** | `pnpm prisma:studio:dev` | `pnpm prisma:studio:prod` |
|
|||
|
|
| **日志级别** | `debug` | `error` |
|
|||
|
|
| **CORS** | `*` (所有来源) | 指定域名 |
|
|||
|
|
| **SSL** | 可选 | 必须启用 |
|
|||
|
|
|
|||
|
|
## 🔑 关键区别
|
|||
|
|
|
|||
|
|
### 开发环境
|
|||
|
|
- ✅ 使用本地数据库
|
|||
|
|
- ✅ 简单的 JWT 密钥（便于开发）
|
|||
|
|
- ✅ 详细的日志输出
|
|||
|
|
- ✅ 允许所有 CORS 来源
|
|||
|
|
- ✅ 热重载支持
|
|||
|
|
|
|||
|
|
### 生产环境
|
|||
|
|
- ✅ 独立的数据库服务器
|
|||
|
|
- ✅ 强随机 JWT 密钥
|
|||
|
|
- ✅ 最小化日志输出
|
|||
|
|
- ✅ 限制 CORS 来源
|
|||
|
|
- ✅ 启用 SSL/TLS
|
|||
|
|
- ✅ 连接池优化
|
|||
|
|
|
|||
|
|
## 📝 配置文件示例
|
|||
|
|
|
|||
|
|
### `.env.development`
|
|||
|
|
```env
|
|||
|
|
NODE_ENV=development
|
|||
|
|
DATABASE_URL="mysql://root:password@localhost:3306/competition_management_dev?schema=public"
|
|||
|
|
JWT_SECRET="dev-secret-key"
|
|||
|
|
PORT=3001
|
|||
|
|
LOG_LEVEL=debug
|
|||
|
|
CORS_ORIGIN=*
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### `.env.production`
|
|||
|
|
```env
|
|||
|
|
NODE_ENV=production
|
|||
|
|
DATABASE_URL="mysql://prod_user:strong_password@prod-host:3306/competition_management?schema=public&sslmode=require"
|
|||
|
|
JWT_SECRET="your-production-secret-key-must-be-strong-and-random"
|
|||
|
|
PORT=3001
|
|||
|
|
LOG_LEVEL=error
|
|||
|
|
CORS_ORIGIN=https://yourdomain.com
|
|||
|
|
SSL_ENABLED=true
|
|||
|
|
DB_POOL_MIN=2
|
|||
|
|
DB_POOL_MAX=10
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## ⚠️ 注意事项
|
|||
|
|
|
|||
|
|
1. **不要提交 `.env` 文件到 Git**
|
|||
|
|
2. **生产环境必须使用强密码和 JWT_SECRET**
|
|||
|
|
3. **生产环境建议启用 SSL 连接**
|
|||
|
|
4. **定期备份生产数据库**
|
|||
|
|
5. **使用不同的数据库名称区分环境**
|
|||
|
|
|
|||
|
|
## 🔍 验证配置
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 检查当前环境
|
|||
|
|
echo $NODE_ENV
|
|||
|
|
|
|||
|
|
# 验证数据库连接（开发环境）
|
|||
|
|
NODE_ENV=development pnpm prisma:studio
|
|||
|
|
|
|||
|
|
# 验证数据库连接（生产环境）
|
|||
|
|
NODE_ENV=production pnpm prisma:studio:prod
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
更多详细信息请查看 [ENVIRONMENT_CONFIG.md](./ENVIRONMENT_CONFIG.md)
|
|||
|
|
|