Create README_CN.md

2024-10-08 03:09:26 +13:00
1 parent 9721524508
commit 7b71823ee6
@@ -0,0 +1,151 @@
+# Auth Inbox
+
+[English](https://github.com/TooonyChen/AuthInbox/blob/main/README.md) | [中文](https://github.com/TooonyChen/AuthInbox/blob/main/README_CN.md)
+
+**Auth Inbox** 是一个开源项目，利用 [Cloudflare](https://cloudflare.com/) 的免费服务，安全地管理和查看认证邮件，因此无需自行设置服务器。它可以自动处理收到的邮件，提取验证码或链接，并将其存储在数据库中。管理员可以通过一个用户友好的网页界面轻松查看提取的信息。AuthInbox 还支持通过 Bark 进行实时通知，使其成为一个全面且省心的邮件认证管理解决方案。
+
+不想在主邮箱中收到广告和垃圾邮件？想要多个备用邮箱用于注册服务和网站？试试这个吧！
+
+---
+
+## 目录
+
+- [功能](#features)
+- [使用技术](#technologies-used)
+- [安装](#installation)
+- [许可证](#license)
+- [截图](#Screenshots)
+
+---
+
+## 功能
+
+- **邮件处理**：自动捕获和存储收到的邮件。
+- **验证码提取**：利用 AI 从邮件中提取验证码、链接和组织名称。
+- **安全前端**：提供受 Basic Access Authentication 保护的网页界面，用于查看提取的验证码。
+- **实时通知**：当提取到新的验证码时，可选通过 Bark 发送通知。
+- **数据库集成**：将原始和处理过的邮件数据存储在 D1Database 中。
+
+---
+
+## 使用技术
+
+- **Cloudflare Workers 无服务器平台**：用于处理邮件和网页请求的平台。
+- **D1Database**：Cloudflare 提供的无服务器 SQL 数据库，用于存储邮件数据。
+- **TypeScript**：强类型的编程语言，提供稳健且易维护的代码。
+- **Google AI Studio API**：用于从邮件中提取相关信息。
+- **Bark API**：可选集成，用于发送实时通知。
+- **HTML/CSS**：响应式、现代化设计的前端界面。
+- **Google Fonts**：为网页界面提供一致的排版，提升
+
+视觉效果。
+
+---
+
+## 安装
+
+0. **先决条件**
+
+   安装 [Wrangler](https://developers.cloudflare.com/workers/wrangler/get-started/)
+   ```bash
+   npm install wrangler -g
+   ```
+   创建一个 [Google AI Studio API](https://aistudio.google.com/) 并且在你的 [Cloudflare](https://dash.cloudflare.com/) 账户上绑定一个域名
+
+1. **初始化**
+
+   ```bash
+   git clone https://github.com/TooonyChen/AuthInbox.git
+   cd AuthInbox
+   npm install
+   ```
+
+2. **创建 d1 数据库**
+
+   当你第一次执行 [Wrangler](https://developers.cloudflare.com/workers/wrangler/get-started/) 登录命令时，系统会提示你登录。按提示操作即可。
+
+   ```bash
+   npx wrangler d1 execute inbox-d1 --local --file=./schema.sql # 创建名为 'inbox-d1' 的 d1 数据库
+   ```
+   你将会看到如下结果：
+   ```bash
+   ✅ Successfully created DB 'inbox-d1'
+
+   [[d1_databases]]
+   binding = "DB" # 在你的 Worker 中通过 env.DB 访问
+   database_name = "inbox-d1"
+   database_id = "<你的数据库的唯一ID>"
+   ```
+   请从终端复制结果，你将在下一步中使用它们。
+
+3. **配置环境变量**
+
+使用项目根目录下的 `wrangler.toml` 文件，并添加所需的环境变量：
+
+   ```toml
+   name = "auth-inbox"
+   type = "typescript"
+   
+   [vars]
+   UseBark = 'true' # 设置为 'true' 启用 Bark，设置为 'false' 禁用
+   barkUrl = "https://api.day.app"
+   barkTokens = 'xxxxxxxxx' # 填写你 iOS 设备上的 Bark tokens，可从 https://bark.day.app/ 下载应用获取
+   FrontEndAdminID = 'admin' # 你的登录 ID
+   FrontEndAdminPassword = 'password' # 你的登录密码
+   GoogleAPIKey = 'xxxxxxxxxxx' # 你的 Google API key，如果没有可以前往 https://aistudio.google.com/ 生成一个
+
+   [[d1_databases]] # 从步骤 2 的终端结果中复制这些行。
+   binding = "DB"
+   database_name = "inbox-d1" # 从步骤 2 中复制
+   database_id = "<你的数据库的唯一ID>" # 从步骤 2 中复制
+   ```
+
+4. **部署你的 worker**
+
+   部署你的 Worker 以使项目在互联网上可访问。运行以下命令：
+   ```bash
+   npx wrangler deploy
+   ```
+   你将看到如下输出：
+   ```
+   output: https://inbox-d1.<你的子域名>.workers.dev
+   ```
+   你现在可以访问该 URL 来查看你部署的 Auth Inbox 的邮件结果。
+
+5. **设置邮件转发**
+
+   前往 [Cloudflare Dashboard](https://dash.cloudflare.com/) -> `Websites` -> `<你的域名>` -> `Email` -> `Email-Routing` -> `Routing Rules`  
+   如果你想使用“接收所有地址”：
+   ![image](https://github.com/user-attachments/assets/53e5a939-6b03-4ca6-826a-7a5f02f361ac)  
+   如果你想使用“自定义地址”：
+   ![image](https://github.com/user-attachments/assets/b0d0ab94-c2ad-4870-ac08-d53e64b2c880)
+
+6. **完成**
+
+   一切设置完毕！现在可以试试了！
+
+---
+
+## 许可证
+
+本项目基于 [MIT License](LICENSE) 许可证。
+
+---
+
+## 截图
+
+![image](https://github.com/user-attachments/assets/2a93c9a7-0fd9-404b-9bce-83a458f1c66e)
+
+---
+
+## 鸣谢
+
+- 感谢 **Cloudflare Workers** 提供强大的无服务器平台。
+- 感谢 **Google Gemini AI** 提供智能的邮件内容提取功能。
+- 感谢 **Bark** 提供实时通知能力。
+- 感谢 **开源社区** 为像 AuthInbox 这样的项目提供灵感和支持。
+- 感谢 **ChatGPT** 协助我写代码
+
+---
+
+</step3_refined_translation>