From 73364a3af0989e808d876d7eddf89db715b5ae23 Mon Sep 17 00:00:00 2001
From: sansan <77180927+sansan0@users.noreply.github.com>
Date: Sun, 14 Dec 2025 13:37:30 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E5=BC=80=E5=90=AF?=
=?UTF-8?q?=E9=82=AE=E4=BB=B6=E6=8E=A8=E9=80=81=E7=9A=84=E5=85=B3=E9=94=AE?=
=?UTF-8?q?=E9=85=8D=E7=BD=AE=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README-EN.md | 9 +++++++++
README.md | 11 ++++++++++-
config/config.yaml | 2 +-
3 files changed, 20 insertions(+), 2 deletions(-)
diff --git a/README-EN.md b/README-EN.md
index 36be381..17c8880 100644
--- a/README-EN.md
+++ b/README-EN.md
@@ -1181,6 +1181,15 @@ For long-term stable operation, we recommend [Docker Deployment](#6-docker-deplo
- Note: To prevent email bulk sending abuse, current bulk sending allows all recipients to see each other's email addresses.
- If you haven't configured email sending before, not recommended to try
+ > ⚠️ **Important Configuration Dependency**: Email push requires HTML report file. Make sure `formats.html` is set to `true` in `config/config.yaml`:
+ > ```yaml
+ > formats:
+ > sqlite: true
+ > txt: false
+ > html: true # Must be enabled, otherwise email push will fail
+ > ```
+ > If set to `false`, email push will report error: `Error: HTML file does not exist or not provided: None`
+
**GitHub Secret Configuration (⚠️ Name must match exactly):**
diff --git a/README.md b/README.md
index 735d220..f27ef90 100644
--- a/README.md
+++ b/README.md
@@ -1235,7 +1235,16 @@ GitHub Actions 环境下,数据存储在 **远程云存储**(支持 S3 兼
- 注意事项:为防止邮件群发功能被**滥用**,当前的群发是所有收件人都能看到彼此的邮箱地址。
- - 如果你没有过配置下面这种邮箱发送的经历,不建议尝试
+ - 如果你没有过配置下面这种邮箱发送的经历,不建议尝试
+
+ > ⚠️ **重要配置依赖**:邮件推送需要 HTML 报告文件。请确保 `config/config.yaml` 中的 `formats.html` 设置为 `true`:
+ > ```yaml
+ > formats:
+ > sqlite: true
+ > txt: false
+ > html: true # 必须启用,否则邮件推送会失败
+ > ```
+ > 如果设置为 `false`,邮件推送时会报错:`错误:HTML文件不存在或未提供: None`
diff --git a/config/config.yaml b/config/config.yaml
index d5064d4..1a5adb5 100644
--- a/config/config.yaml
+++ b/config/config.yaml
@@ -21,7 +21,7 @@ storage:
formats:
sqlite: true # 主存储(必须启用)
txt: false # 是否生成 TXT 快照
- html: false # 是否生成 HTML 报告
+ html: false # 是否生成 HTML 报告(⚠️ 邮件推送必须设为 true,否则会报错)
# 本地存储配置
local: