GithubBackup/cloudflare_temp_email
1
0
Fork 0
mirror of https://github.com/dreamhunter2333/cloudflare_temp_email.git synced 2026-07-07 15:21:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: update UI install docs (#709)

Browse Source
This commit is contained in:
Dream Hunter
2025-08-23 01:14:41 +08:00
committed by GitHub
parent 4084771621
commit 89d8944e60
31 changed files with 32 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
vitepress-docs/docs/zh/guide/ui/d1.md
View File

@@ -2,7 +2,7 @@
## 创建数据库
打开 cloudflare 控制台，选择 `Workers & Pages` -> `D1` -> `Create Database`，点击创建数据库
打开 cloudflare 控制台，选择 `Storage & Databases` -> `D1 SQL Database` -> `Create Database`，点击创建数据库
![d1](/ui_install/d1.png)
@@ -10,13 +10,11 @@
## 初始化数据库
你也可以跳过初始化数据库，在部署完成后，在 admin 页面的 `快速设置` -> `数据库` 中，点击 `初始化数据库` 按钮来初始化数据库
::: warning 注意
下面输入的是 `db/schema.sql` 的内容
你也可以跳过初始化数据库，在部署完成后，在 admin 页面的 `快速设置` -> `数据库` 中，点击 `初始化数据库` 按钮来初始化数据库
:::
打开 `Console` 标签页，输入 `db/schema.sql` 的内容，点击 `Execute` 执行
打开 `Console` 标签页，输入仓库中 [db/schema.sql](https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/db/schema.sql) 文件的内容，点击 `Execute` 执行
![d1](/ui_install/d1-exec.png)

4
vitepress-docs/docs/zh/guide/ui/pages.md
View File

@@ -42,11 +42,11 @@ const generate = async () => {
}
</script>
1. 点击 `Workers & Pages` -> `Overview` -> `Create Application`
1. 点击 `Compute (Workers)` -> `Workers & Pages` -> `Create`
![create pages](/ui_install/worker_home.png)
2. 选择 `Pages`，选择 `Create using direct upload`
2. 选择 `Pages`，选择 `Use direct upload`
![pages](/ui_install/pages.png)

37
vitepress-docs/docs/zh/guide/ui/worker.md
View File

@@ -3,15 +3,16 @@
> [!warning] 注意
> `worker.dev` 域名在中国无法访问，请自定义域名
1. 点击 `Workers & Pages` -> `Overview` -> `Create Application`
1. 点击 `Compute (Workers)` -> `Workers & Pages` -> `Create`
![create worker](/ui_install/worker_home.png)
2. 选择 `Worker`，点击 `Create Worker`, 修改名称然后点击 `Deploy`
![worker1](/ui_install/worker-1.png)
![worker2](/ui_install/worker-2.png)
3. 回到 `Overview`，找到刚刚创建的 worker，点击 `Settings` -> `Runtime`, 修改 `Compatibility flags`, 增加 `nodejs_compat`, 兼容日期也需要大于图片中的日期。
3. 回到 `Workers & Pages`，找到刚刚创建的 worker，点击 `Settings` -> `Runtime`, 修改 `Compatibility flags`, 手动输入增加 `nodejs_compat`, 兼容日期也需要大于图片中的日期。
![worker-runtime](/ui_install/worker-runtime.png)
@@ -26,10 +27,11 @@
>
> 参考: [issues156](https://github.com/dreamhunter2333/cloudflare_temp_email/issues/156#issuecomment-2079453822)
![worker2](/ui_install/worker-2.png)
![worker3](/ui_install/worker-3.png)
![worker-upload](/ui_install/worker-upload.png)
6. 点击 `Settings` -> `Variables`, 如图所示添加变量
6. 点击 `Settings` -> `Variables and Secrets`, 如图所示添加变量
![worker-var](/ui_install/worker-var.png)
@@ -51,12 +53,16 @@
| `ENABLE_USER_CREATE_EMAIL` | 文本/JSON | 是否允许用户创建邮箱, 不配置则不允许 | `true` |
| `ENABLE_USER_DELETE_EMAIL` | 文本/JSON | 是否允许用户删除邮件, 不配置则不允许 | `true` |
7. 点击 `Settings` -> `Variables`, 下拉找到 `D1 Database`, 点击 `Add Binding`, 名称如图，选择刚刚创建的 D1 数据库，点击 `Deploy`
7. 点击 `Settings` -> `Bindings`, 点击 `Add Binding`, 名称如图，选择刚刚创建的 D1 数据库，点击 `Add Binding`
> [!NOTE] 重要
> 注意此处 `D1 Database` 的绑定名称必须为 `DB`
![worker-d1](/ui_install/worker-d1.png)
![worker-bindings](/ui_install/worker-bindings.png)
![worker-d1-1](/ui_install/worker-d1-1.png)
![worker-d1-2](/ui_install/worker-d1-2.png)
8. 点击 `Settings` -> `Trggers`, 这里可以添加自己的域名，你也可以使用自动生成的 `*.workers.dev` 的域名。记录下这个域名，后面部署前端会用到。
@@ -67,24 +73,35 @@
![worker3](/ui_install/worker-3.png)
9. 如果你要启用注册用户功能，并需要发送邮件验证，则需要创建 `KV` 缓存, 不需要可跳过此步骤，点击 `Workers & Pages` -> `KV` -> `Create Namespace`, 如图，点击 `Create Namespace`，然后在 `Settings` -> `Variables`, 下拉找到 `KV`, 点击 `Add Binding`, 名称如图，选择刚刚创建的 `KV` 缓存，点击 `Deploy`
9. 如果你要启用注册用户功能，并需要发送邮件验证，则需要创建 `KV` 缓存, 不需要可跳过此步骤
> [!NOTE] 重要
> 如果你要启用注册用户功能，并需要发送邮件验证，则需要创建 `KV` 缓存, 不需要可跳过此步骤
>
> 注意此处 `KV` 的绑定名称必须为 `KV`
点击 `Storage & Databases` -> `KV` -> `Create Namespace`, 如图，点击 `Create Namespace`
![worker-kv](/ui_install/worker-kv.png)
![worker-kv-bind](/ui_install/worker-kv-bind.png)
![worker-kv-0](/ui_install/worker-kv-0.png)
然后点击 `Settings` -> `Bindings`, 点击 `Add Binding`, 名称如图，选择刚刚创建的 KV,点击 `Add Binding`
![worker-bindings](/ui_install/worker-bindings.png)
![worker-kv-1](/ui_install/worker-kv-1.png)
![worker-kv-2](/ui_install/worker-kv-2.png)
10. Telegram Bot 配置
> [!NOTE]
> 如果不需要 Telegram Bot, 可跳过此步骤
请先创建一个 Telegram Bot，然后获取 `token`，然后执行下面的命令，将 `token` 添加到 `Variables` 中, Name: `TELEGRAM_BOT_TOKEN`
请先创建一个 Telegram Bot，然后获取 `token`，将 `token` 添加到 `Variables and Secrets` 中, 变量名称: `TELEGRAM_BOT_TOKEN`
11. 如果你想要使用 admin 页面中的定时任务清理邮件，需要到 `Settings` -> `Triggers` -> `Cron Triggers` 中添加定时任务.
11. 如果你想要使用 admin 页面中的定时任务清理邮件，需要到 `Settings` -> `Trigger Events` -> `Cron Triggers` 中添加定时任务.
> [!NOTE]
> 选择 `cron` 表达式，输入 `0 0 * * *`（此表达式表示每天午夜运行），点击 `Add` 增加。请根据您的需求调整此表达式。