From 52ac421a0bb6d8c1c16aa99fdaf27d17a2a2c7ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=A5=AD=E5=9B=A2?= Date: Sat, 14 Mar 2026 21:57:40 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=9C=A8=20README=20=E4=B8=AD=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=E9=85=8D=E7=BD=AE=E6=96=87=E4=BB=B6=E7=9A=84=E4=BD=9C?= =?UTF-8?q?=E7=94=A8=E5=92=8C=E5=AE=89=E5=85=A8=E6=B3=A8=E6=84=8F=E4=BA=8B?= =?UTF-8?q?=E9=A1=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 添加 .env.example/.env/.env.production 的用途说明表格 - 说明哪些文件应该/不应该提交到 Git - 添加安全提示,强调敏感信息不要提交 --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 4f7dbe2..699915a 100644 --- a/README.md +++ b/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