docs: 在 README 中说明配置文件的作用和安全注意事项
- 添加 .env.example/.env/.env.production 的用途说明表格 - 说明哪些文件应该/不应该提交到 Git - 添加安全提示,强调敏感信息不要提交
This commit is contained in:
23
README.md
23
README.md
@@ -137,6 +137,29 @@ pm2 logs qiniu-bot
|
|||||||
|
|
||||||
## ⚙️ 配置
|
## ⚙️ 配置
|
||||||
|
|
||||||
|
### 📄 配置文件说明
|
||||||
|
|
||||||
|
项目包含以下环境变量配置文件:
|
||||||
|
|
||||||
|
| 文件 | 作用 | 包含敏感信息 | 提交到 Git |
|
||||||
|
|------|------|-------------|-----------|
|
||||||
|
| `.env.example` | 配置模板,展示所有需要的环境变量 | ❌ 否(占位符) | ✅ 应该 |
|
||||||
|
| `.env` | 当前环境配置(运行时使用) | ✅ 是 | ❌ 不应该 |
|
||||||
|
| `.env.production` | 生产环境专用配置 | ✅ 是 | ❌ 不应该 |
|
||||||
|
|
||||||
|
**快速开始:**
|
||||||
|
```bash
|
||||||
|
# 新部署时复制模板
|
||||||
|
cp .env.example .env
|
||||||
|
|
||||||
|
# 编辑配置(填入真实信息)
|
||||||
|
nano .env
|
||||||
|
```
|
||||||
|
|
||||||
|
> ⚠️ **安全提示:** `.env` 和 `.env.production` 包含敏感信息(密钥、密码等),**切勿提交到 Git**!项目已配置 `.gitignore` 自动忽略这些文件。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### 环境变量 (.env)
|
### 环境变量 (.env)
|
||||||
|
|
||||||
```env
|
```env
|
||||||
|
|||||||
Reference in New Issue
Block a user