Skip to content

AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.

docs: align online Cloudflare deployment guidance

tianma-iffd88ded9ca93
diff --git a/README.ja.md b/README.ja.md
index 4ecabaca..43951a77 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -102,18 +102,20 @@ Cloudflare のオンライン導入は、次のいずれかです。
次のプロンプトを AI Agent(Codex、Claude、Cursor、WorkBuddy、Antigravity、OpenClaw、Hermes Agent など)へそのまま送ってください。実行中に GitHub や Cloudflare へのアクセスが求められたら、権限を確認して認可してください。
```text
-EdgeEver をオンラインで導入してください:
+GitHub と Cloudflare のオンライン操作だけで EdgeEver を導入してください:
1. Fork https://github.com/tianma-if/edgeever.
2. Cloudflare で D1 `edgeever` と R2 `edgeever-resources` を作成します。
-3. その Fork を Cloudflare Workers & Pages に取り込み、`main` を本番ブランチにします。
-4. ユーザーが指定した管理者パスワードを Worker Secret `EDGE_EVER_AUTH_PASSWORD` に保存します。
- パスワードは 32 文字以上を推奨します。管理者ユーザー名の既定値は `admin` です。
- 別のユーザー名を指定された場合は、初回ビルド前に Workers Builds 変数
- `EDGE_EVER_AUTH_USERNAME` を設定します。
-5. 初回ビルドを開始します。導入後、`/api/health` と `/api/openapi.json` を確認し、
+3. Workers & Pages で Fork の `main` ブランチから `edgeever` という名前の Worker を作成します。
+ リポジトリのルートを使い、Cloudflare Workers Builds の既定のデプロイコマンドを維持します。
+ その API トークンに D1 の読み取り・編集権限があることを確認して Save and Deploy を選択します。
+4. Worker の作成後、ユーザーが指定したパスワードを実行時 Secret
+ `EDGE_EVER_AUTH_PASSWORD` に設定します
+ (32 文字以上を推奨)。管理者ユーザー名の既定値は `admin` です。別の名前を指定された場合は、
+ 次のビルド前に Workers Builds 変数 `EDGE_EVER_AUTH_USERNAME` を設定します。
+5. 再度ビルドし、`/api/health` と `/api/openapi.json` を確認してから、
その管理者ユーザー名とパスワードでログインできることを確認します。
6. GitHub Actions の `Update deployed EdgeEver` を有効にし、一度手動実行して、
- Fork が最新の機能と修正を自動で受け取れるようにします。
+ Fork が今後の安定版と修正を自動で受け取れるようにします。
```
> 詳細な要件: [AI Agent Cloudflare Deployment](docs/agent-deploy-cloudflare.md)。
@@ -124,10 +126,10 @@ EdgeEver をオンラインで導入してください:
1. **リポジトリを Fork**:GitHub 右上の **Fork** で、EdgeEver を自分のアカウントへ Fork します。
2. **Cloudflare リソースを作成**:D1 `edgeever` と R2 `edgeever-resources` を作ります。
-3. **プロジェクトを取り込み、設定**:Fork を Cloudflare **Workers & Pages** に取り込み、`main` を本番ブランチにします。binding は導入コマンドが作ります。Fork 内のファイルは編集しないでください。
-4. **管理者パスワードを設定**:Worker Secret `EDGE_EVER_AUTH_PASSWORD` を追加し、管理者ログイン用パスワードを値にします。32 文字以上の強いパスワードを推奨します。
-5. **ビルドと確認**:管理者ユーザー名の既定値は `admin` です。別のユーザー名を使う場合は、初回ビルド前に Workers Builds 変数 `EDGE_EVER_AUTH_USERNAME` を設定します。初回ビルドを開始し、導入後に `/api/health` が `200` を返すことを確認してから、設定した管理者ユーザー名とパスワードでログインします。
-6. **自動更新を有効化**:Fork の **Actions** タブで **I understand my workflows, go ahead and enable them** を押し、**Update deployed EdgeEver** を一度手動実行して、以降の機能と修正を自動で受け取れるようにします。
+3. **プロジェクトを取り込み、設定**:Cloudflare **Workers & Pages** で Fork の `main` ブランチから `edgeever` という名前の Worker を作成します。リポジトリのルートと、Cloudflare 上で実行される Workers Builds の既定のデプロイコマンドを使い、API トークンの D1 読み取り・編集権限を確認します。binding はデプロイコマンドが作るため、Fork 内のファイルは編集しないでください。
+4. **管理者パスワードを準備**:管理者ログイン用パスワードを用意します。32 文字以上を推奨します。Worker 作成後、実行時 Secret `EDGE_EVER_AUTH_PASSWORD` に保存します。
+5. **ビルドと確認**:Save and Deploy で Worker が作成され、ビルドが始まります。管理者 Secret がないため失敗した場合は、手順 4 の実行時 Secret を追加して再試行します。管理者ユーザー名の既定値は `admin` です。別の名前を使う場合は、再試行前に Workers Builds 変数 `EDGE_EVER_AUTH_USERNAME` を設定します。導入後に `/api/health` が `200` を返すことを確認し、設定した管理者ユーザー名とパスワードでログインします。
+6. **自動更新を有効化**:Fork の **Actions** タブで **I understand my workflows, go ahead and enable them** を押し、**Update deployed EdgeEver** を一度手動実行して、今後の安定版と修正を自動で受け取れるようにします。
> 📖 手順と設定の詳細は [Online Deployment Guide](docs/deploy-cloudflare-button.md) を見てください。
diff --git a/README.md b/README.md
index ae15f544..dbafb551 100644
--- a/README.md
+++ b/README.md
@@ -102,19 +102,21 @@ For Cloudflare, choose either of the following online deployment options:
Copy the prompt below directly into an AI Agent (such as Codex, Claude, Cursor, WorkBuddy, Antigravity, OpenClaw, Hermes Agent, etc.). During execution, if access to GitHub or Cloudflare is required, review the requested permissions and follow the prompts to authorize access.
```text
-Deploy EdgeEver online:
+Deploy EdgeEver entirely through GitHub and Cloudflare:
1. Fork https://github.com/tianma-if/edgeever.
2. Create D1 `edgeever` and R2 `edgeever-resources` in Cloudflare.
-3. Import the Fork into Cloudflare Workers & Pages and use `main` as the production
- branch.
-4. Save the user's chosen administrator password as the Worker Secret
- `EDGE_EVER_AUTH_PASSWORD`. Prefer at least 32 characters.
- The administrator username defaults to `admin`. If the user specifies another, set
- `EDGE_EVER_AUTH_USERNAME` as a Workers Builds variable before the first build.
-5. Start the first build. Once deployed, verify `/api/health` and `/api/openapi.json`.
- Then log in with that administrator username and password.
+3. In Workers & Pages, create a Worker named `edgeever` from the Fork's `main` branch.
+ Use the repository root, keep Cloudflare's default Workers Builds deploy command,
+ and ensure its API token can read and edit D1. Select Save and Deploy.
+4. After the Worker is created, add the user's chosen password as the runtime Secret
+ `EDGE_EVER_AUTH_PASSWORD` (preferably at least 32 characters).
+ The username defaults to `admin`.
+ If the user specifies another, set `EDGE_EVER_AUTH_USERNAME` as a Workers Builds
+ variable before the next build.
+5. Run the build again, verify `/api/health` and `/api/openapi.json`, then log in
+ with that administrator username and password.
6. Enable and manually run the GitHub Actions workflow named `Update deployed EdgeEver`
- once so the Fork can automatically receive the latest EdgeEver features and fixes.
+ once so the Fork can automatically receive future stable releases and fixes.
```
> Detailed requirements: [AI Agent Cloudflare Deployment](docs/agent-deploy-cloudflare.md).
@@ -125,10 +127,10 @@ Complete setup in 6 web steps:
1. **Fork the Repository**: Click **Fork** at the top right of GitHub to fork EdgeEver into your personal account.
2. **Create Cloudflare Resources**: Create D1 `edgeever` and R2 `edgeever-resources`.
-3. **Import & Configure the Project**: Import the Fork into Cloudflare **Workers & Pages** and use `main` as the production branch. The deploy command creates the bindings; do not edit Fork files.
-4. **Set the Administrator Password**: Add a Worker Secret named `EDGE_EVER_AUTH_PASSWORD` and set its value to your chosen administrator login password. Prefer a strong password of at least 32 characters.
-5. **Build & Verify**: The administrator username defaults to `admin`. To use another username, set the `EDGE_EVER_AUTH_USERNAME` Workers Builds variable before the first build. Start the first build. Once deployed, confirm `/api/health` returns `200`, then log in with the administrator username and password you configured.
-6. **Enable Automatic Updates**: Open the Fork's **Actions** tab, click **I understand my workflows, go ahead and enable them**, then manually run **Update deployed EdgeEver** once so the Fork can automatically receive future EdgeEver features and fixes.
+3. **Import & Configure the Project**: Create a Worker named `edgeever` from the Fork's `main` branch in Cloudflare **Workers & Pages**. Use the repository root and keep Cloudflare's default Workers Builds deploy command, which runs in Cloudflare. Ensure its API token can read and edit D1. The deploy command creates the bindings; do not edit Fork files.
+4. **Choose the Administrator Password**: Choose an administrator password, preferably at least 32 characters. Once the Worker is created, save it as the runtime Secret `EDGE_EVER_AUTH_PASSWORD`.
+5. **Build & Verify**: Save and Deploy creates the Worker and starts a build. If it fails because the administrator Secret is missing, add the runtime Secret from step 4 and retry. The username defaults to `admin`; to use another, set the `EDGE_EVER_AUTH_USERNAME` Workers Builds variable before retrying. Once deployed, confirm `/api/health` returns `200`, then log in with the configured username and password.
+6. **Enable Automatic Updates**: Open the Fork's **Actions** tab, click **I understand my workflows, go ahead and enable them**, then manually run **Update deployed EdgeEver** once so the Fork can automatically receive future stable releases and fixes.
> 📖 For full step-by-step instructions and configuration details, see the [Online Deployment Guide](docs/deploy-cloudflare-button.md).
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 3e0a4097..8b0598cb 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -102,18 +102,19 @@ Cloudflare 在线部署可以选择以下两种方式之一:
将下方提示词直接复制发送给 AI Agent(如 Codex、Claude、Cursor、WorkBuddy、Antigravity、OpenClaw、Hermes Agent 等)。执行过程中,如需访问 GitHub 或 Cloudflare,请确认权限范围并按提示完成授权。
```text
-请在线完成 EdgeEver 部署:
+请全程通过 GitHub 和 Cloudflare 在线部署 EdgeEver:
1. Fork https://github.com/tianma-if/edgeever。
2. 在 Cloudflare 中创建 D1 `edgeever` 与 R2 `edgeever-resources`。
-3. 将这个 Fork 导入 Cloudflare Workers & Pages,并将 `main` 设为生产分支。
-4. 将用户指定的管理员密码保存为 Worker Secret `EDGE_EVER_AUTH_PASSWORD`。
- 密码建议至少 32 个字符。管理员用户名默认为 `admin`。
- 若用户指定其他用户名,请在首次构建前设置 Workers Builds 构建变量
- `EDGE_EVER_AUTH_USERNAME`。
-5. 启动首次构建。部署完成后,验证 `/api/health` 和 `/api/openapi.json`,
- 再用该管理员用户名和密码验证登录。
+3. 在 Workers & Pages 中从 Fork 的 `main` 分支创建名为 `edgeever` 的 Worker。
+ 使用仓库根目录,保留 Cloudflare Workers Builds 的默认部署命令,确认其 API Token
+ 具备 D1 读取和编辑权限,然后保存并部署。
+4. Worker 创建后,设置运行时 Secret `EDGE_EVER_AUTH_PASSWORD`,值为用户指定的密码
+ (建议至少 32 个字符)。管理员用户名默认为 `admin`;如需自定义,请在再次构建前
+ 设置 Workers Builds 构建变量 `EDGE_EVER_AUTH_USERNAME`。
+5. 再次构建,验证 `/api/health` 和 `/api/openapi.json`,再用该管理员
+ 用户名和密码验证登录。
6. 启用并手动运行一次名为 `Update deployed EdgeEver` 的 GitHub Actions 工作流,
- 以便后续自动同步更新,持续获得 EdgeEver 最新的产品特性和问题修复。
+ 以便后续自动同步正式版本,持续获得 EdgeEver 的功能更新和问题修复。
```
> 详细约定与要求请查看:[AI Agent 在线部署约定](docs/agent-deploy-cloudflare.zh-CN.md)。
@@ -124,10 +125,10 @@ Cloudflare 在线部署可以选择以下两种方式之一:
1. **Fork 仓库**:在 GitHub 点击右上角 **Fork**,将项目 Fork 到您的个人账户下。
2. **创建 Cloudflare 资源**:创建 D1 `edgeever` 与 R2 `edgeever-resources`。
-3. **导入并配置项目**:在 Cloudflare **Workers & Pages** 中导入该 Fork,并将 `main` 设为生产分支。binding 由部署命令生成,不要修改 Fork 中的文件。
-4. **设置管理员密码**:添加一个名为 `EDGE_EVER_AUTH_PASSWORD` 的 Worker Secret,并将其值设为您要使用的管理员登录密码。建议使用至少 32 个字符的强密码。
-5. **首次构建与验证**:管理员用户名默认为 `admin`。如需使用其他用户名,请在首次构建前设置 Workers Builds 构建变量 `EDGE_EVER_AUTH_USERNAME`。启动首次构建,部署完成后访问 `/api/health`,确认返回 `200`,再用配置的管理员用户名和密码登录。
-6. **启用自动更新**:进入 Fork 的 **Actions** 标签页,点击 **I understand my workflows, go ahead and enable them**,然后手动运行一次 **Update deployed EdgeEver**,确保后续能够自动获得 EdgeEver 的最新功能与修复。
+3. **导入并配置项目**:在 Cloudflare **Workers & Pages** 中从 Fork 的 `main` 分支创建名为 `edgeever` 的 Worker。使用仓库根目录,保留由 Cloudflare 在线执行的 Workers Builds 默认部署命令,并确认其 API Token 具备 D1 读取和编辑权限。binding 由部署命令生成,不要修改 Fork 中的文件。
+4. **准备管理员密码**:准备管理员登录密码,建议至少 32 个字符。Worker 创建后,将它保存为运行时 Secret `EDGE_EVER_AUTH_PASSWORD`。
+5. **首次构建与验证**:保存并部署会创建 Worker 并启动构建。如因缺少管理员 Secret 而失败,添加第 4 步的运行时 Secret 后重试。管理员用户名默认为 `admin`;如需使用其他用户名,请在重试构建前设置 Workers Builds 构建变量 `EDGE_EVER_AUTH_USERNAME`。部署完成后访问 `/api/health`,确认返回 `200`,再用配置的管理员用户名和密码登录。
+6. **启用自动更新**:进入 Fork 的 **Actions** 标签页,点击 **I understand my workflows, go ahead and enable them**,然后手动运行一次 **Update deployed EdgeEver**,确保后续能够自动获得正式版本的功能更新与修复。
> 📖 包含具体参数与构建命令的详细步骤,请查看 [在线部署完整文档](docs/deploy-cloudflare-button.zh-CN.md)。
diff --git a/README.zh-TW.md b/README.zh-TW.md
index 156c2c05..5de8276a 100644
--- a/README.zh-TW.md
+++ b/README.zh-TW.md
@@ -102,18 +102,19 @@ Cloudflare 線上部署可以選擇以下兩種方式之一:
將下方提示詞直接複製傳送給 AI Agent(如 Codex、Claude、Cursor、WorkBuddy、Antigravity、OpenClaw、Hermes Agent 等)。執行過程中,如需存取 GitHub 或 Cloudflare,請確認權限範圍並依提示完成授權。
```text
-請線上完成 EdgeEver 部署:
+請全程透過 GitHub 和 Cloudflare 線上部署 EdgeEver:
1. Fork https://github.com/tianma-if/edgeever。
2. 在 Cloudflare 中建立 D1 `edgeever` 與 R2 `edgeever-resources`。
-3. 將這個 Fork 匯入 Cloudflare Workers & Pages,並將 `main` 設為正式環境分支。
-4. 將使用者指定的管理員密碼儲存為 Worker Secret `EDGE_EVER_AUTH_PASSWORD`。
- 密碼建議至少 32 個字元。管理員使用者名稱預設為 `admin`。
- 若使用者指定其他名稱,請在首次建置前設定 Workers Builds 建置變數
- `EDGE_EVER_AUTH_USERNAME`。
-5. 啟動首次建置。部署完成後,驗證 `/api/health` 和 `/api/openapi.json`,
- 再用該管理員使用者名稱和密碼驗證登入。
+3. 在 Workers & Pages 中從 Fork 的 `main` 分支建立名為 `edgeever` 的 Worker。
+ 使用儲存庫根目錄,保留 Cloudflare Workers Builds 的預設部署指令,確認其 API Token
+ 具備 D1 讀取及編輯權限,然後儲存並部署。
+4. Worker 建立後,設定執行時 Secret `EDGE_EVER_AUTH_PASSWORD`,值為使用者指定的密碼
+ (建議至少 32 個字元)。管理員使用者名稱預設為 `admin`;如需自訂,請在再次建置前
+ 設定 Workers Builds 建置變數 `EDGE_EVER_AUTH_USERNAME`。
+5. 再次建置,驗證 `/api/health` 和 `/api/openapi.json`,再用該管理員
+ 使用者名稱和密碼驗證登入。
6. 啟用並手動執行一次名為 `Update deployed EdgeEver` 的 GitHub Actions 工作流程,
- 以便後續自動同步更新,持續獲得 EdgeEver 最新的產品特性與問題修復。
+ 以便後續自動同步正式版本,持續獲得 EdgeEver 的功能更新與問題修復。
```
> 詳細約定與要求請查看:[AI Agent 線上部署約定](docs/agent-deploy-cloudflare.zh-CN.md)。
@@ -124,10 +125,10 @@ Cloudflare 線上部署可以選擇以下兩種方式之一:
1. **Fork 儲存庫**:在 GitHub 點選右上角 **Fork**,將專案 Fork 到您的個人帳戶下。
2. **建立 Cloudflare 資源**:建立 D1 `edgeever` 與 R2 `edgeever-resources`。
-3. **匯入並設定專案**:在 Cloudflare **Workers & Pages** 中匯入該 Fork,並將 `main` 設為正式環境分支。binding 由部署指令產生,不要修改 Fork 中的檔案。
-4. **設定管理員密碼**:新增一個名為 `EDGE_EVER_AUTH_PASSWORD` 的 Worker Secret,並將其值設為您要使用的管理員登入密碼。建議使用至少 32 個字元的強密碼。
-5. **首次建置與驗證**:管理員使用者名稱預設為 `admin`。如需使用其他名稱,請在首次建置前設定 Workers Builds 建置變數 `EDGE_EVER_AUTH_USERNAME`。啟動首次建置,部署完成後造訪 `/api/health`,確認回傳 `200`,再用設定的管理員使用者名稱和密碼登入。
-6. **啟用自動更新**:進入 Fork 的 **Actions** 分頁,點選 **I understand my workflows, go ahead and enable them**,然後手動執行一次 **Update deployed EdgeEver**,確保後續能夠自動獲得 EdgeEver 的最新功能與修復。
+3. **匯入並設定專案**:在 Cloudflare **Workers & Pages** 中從 Fork 的 `main` 分支建立名為 `edgeever` 的 Worker。使用儲存庫根目錄,保留由 Cloudflare 線上執行的 Workers Builds 預設部署指令,並確認其 API Token 具備 D1 讀取及編輯權限。binding 由部署指令產生,不要修改 Fork 中的檔案。
+4. **準備管理員密碼**:準備管理員登入密碼,建議至少 32 個字元。Worker 建立後,將它儲存為執行時 Secret `EDGE_EVER_AUTH_PASSWORD`。
+5. **首次建置與驗證**:儲存並部署會建立 Worker 並啟動建置。如因缺少管理員 Secret 而失敗,新增步驟 4 的執行時 Secret 後重試。管理員使用者名稱預設為 `admin`;如需使用其他名稱,請在重試建置前設定 Workers Builds 建置變數 `EDGE_EVER_AUTH_USERNAME`。部署完成後造訪 `/api/health`,確認回傳 `200`,再用設定的管理員使用者名稱和密碼登入。
+6. **啟用自動更新**:進入 Fork 的 **Actions** 分頁,點選 **I understand my workflows, go ahead and enable them**,然後手動執行一次 **Update deployed EdgeEver**,確保後續能夠自動獲得正式版本的功能更新與修復。
> 📖 包含具體參數與建置指令的詳細步驟,請查看 [線上部署完整文件](docs/deploy-cloudflare-button.zh-CN.md)。
diff --git a/apps/site/src/deployment-prompts.ts b/apps/site/src/deployment-prompts.ts
index d06baa38..854a2057 100644
--- a/apps/site/src/deployment-prompts.ts
+++ b/apps/site/src/deployment-prompts.ts
@@ -1,29 +1,32 @@
export const deploymentPrompts = {
- "en-US": `Deploy EdgeEver online:
+ "en-US": `Deploy EdgeEver entirely through GitHub and Cloudflare:
1. Fork https://github.com/tianma-if/edgeever.
2. Create D1 \`edgeever\` and R2 \`edgeever-resources\` in Cloudflare.
-3. Import the Fork into Cloudflare Workers & Pages and use \`main\` as the production
- branch.
-4. Save the user's chosen administrator password as the Worker Secret
- \`EDGE_EVER_AUTH_PASSWORD\`. Prefer at least 32 characters.
- The administrator username defaults to \`admin\`. If the user specifies another, set
- \`EDGE_EVER_AUTH_USERNAME\` as a Workers Builds variable before the first build.
-5. Start the first build. Once deployed, verify \`/api/health\` and \`/api/openapi.json\`.
- Then log in with that administrator username and password.
+3. In Workers & Pages, create a Worker named \`edgeever\` from the Fork's \`main\` branch.
+ Use the repository root, keep Cloudflare's default Workers Builds deploy command,
+ and ensure its API token can read and edit D1. Select Save and Deploy.
+4. After the Worker is created, add the user's chosen password as the runtime Secret
+ \`EDGE_EVER_AUTH_PASSWORD\` (preferably at least 32 characters).
+ The username defaults to \`admin\`.
+ If the user specifies another, set \`EDGE_EVER_AUTH_USERNAME\` as a Workers Builds
+ variable before the next build.
+5. Run the build again, verify \`/api/health\` and \`/api/openapi.json\`, then log in
+ with that administrator username and password.
6. Enable and manually run the GitHub Actions workflow named \`Update deployed EdgeEver\`
- once so the Fork can automatically receive the latest EdgeEver features and fixes.`,
- "zh-CN": `请在线完成 EdgeEver 部署:
+ once so the Fork can automatically receive future stable releases and fixes.`,
+ "zh-CN": `请全程通过 GitHub 和 Cloudflare 在线部署 EdgeEver:
1. Fork https://github.com/tianma-if/edgeever。
2. 在 Cloudflare 中创建 D1 \`edgeever\` 与 R2 \`edgeever-resources\`。
-3. 将这个 Fork 导入 Cloudflare Workers & Pages,并将 \`main\` 设为生产分支。
-4. 将用户指定的管理员密码保存为 Worker Secret \`EDGE_EVER_AUTH_PASSWORD\`。
- 密码建议至少 32 个字符。管理员用户名默认为 \`admin\`。
- 若用户指定其他用户名,请在首次构建前设置 Workers Builds 构建变量
- \`EDGE_EVER_AUTH_USERNAME\`。
-5. 启动首次构建。部署完成后,验证 \`/api/health\` 和 \`/api/openapi.json\`,
- 再用该管理员用户名和密码验证登录。
+3. 在 Workers & Pages 中从 Fork 的 \`main\` 分支创建名为 \`edgeever\` 的 Worker。
+ 使用仓库根目录,保留 Cloudflare Workers Builds 的默认部署命令,确认其 API Token
+ 具备 D1 读取和编辑权限,然后保存并部署。
+4. Worker 创建后,设置运行时 Secret \`EDGE_EVER_AUTH_PASSWORD\`,值为用户指定的密码
+ (建议至少 32 个字符)。管理员用户名默认为 \`admin\`;如需自定义,请在再次构建前
+ 设置 Workers Builds 构建变量 \`EDGE_EVER_AUTH_USERNAME\`。
+5. 再次构建,验证 \`/api/health\` 和 \`/api/openapi.json\`,再用该管理员
+ 用户名和密码验证登录。
6. 启用并手动运行一次名为 \`Update deployed EdgeEver\` 的 GitHub Actions 工作流,
- 以便后续自动同步更新,持续获得 EdgeEver 最新的产品特性和问题修复。`,
+ 以便后续自动同步正式版本,持续获得 EdgeEver 的功能更新和问题修复。`,
} as const;
export const manualDeploymentCopy = {
@@ -40,19 +43,19 @@ export const manualDeploymentCopy = {
},
{
title: "Import & Configure the Project",
- body: "Import the Fork into Cloudflare Workers & Pages and use main as the production branch. The deploy command creates the bindings; do not edit Fork files.",
+ body: "Create a Worker named edgeever from the Fork's main branch in Cloudflare Workers & Pages. Use the repository root and keep Cloudflare's default Workers Builds deploy command, which runs in Cloudflare. Ensure its API token can read and edit D1. The deploy command creates the bindings; do not edit Fork files.",
},
{
- title: "Set the Administrator Password",
- body: "Add a Worker Secret named EDGE_EVER_AUTH_PASSWORD and set its value to your chosen administrator login password. Prefer a strong password of at least 32 characters.",
+ title: "Choose the Administrator Password",
+ body: "Choose an administrator password, preferably at least 32 characters. Once the Worker is created, save it as the runtime Secret EDGE_EVER_AUTH_PASSWORD.",
},
{
title: "Build & Verify",
- body: "The administrator username defaults to admin. To use another username, set the EDGE_EVER_AUTH_USERNAME Workers Builds variable before the first build. Start the first build. Once deployed, confirm /api/health returns 200, then log in with the administrator username and password you configured.",
+ body: "Save and Deploy creates the Worker and starts a build. If it fails because the administrator Secret is missing, add the runtime Secret from step 4 and retry. The username defaults to admin; to use another, set the EDGE_EVER_AUTH_USERNAME Workers Builds variable before retrying. Once deployed, confirm /api/health returns 200, then log in with the configured username and password.",
},
{
title: "Enable Automatic Updates",
- body: "Open the Fork's Actions tab, click I understand my workflows, go ahead and enable them, then manually run Update deployed EdgeEver once so the Fork can automatically receive future EdgeEver features and fixes.",
+ body: "Open the Fork's Actions tab, click I understand my workflows, go ahead and enable them, then manually run Update deployed EdgeEver once so the Fork can automatically receive future stable releases and fixes.",
},
],
},
@@ -69,19 +72,19 @@ export const manualDeploymentCopy = {
},
{
title: "导入并配置项目",
- body: "在 Cloudflare Workers & Pages 中导入该 Fork,并将 main 设为生产分支。binding 由部署命令生成,不要修改 Fork 中的文件。",
+ body: "在 Cloudflare Workers & Pages 中从 Fork 的 main 分支创建名为 edgeever 的 Worker。使用仓库根目录,保留由 Cloudflare 在线执行的 Workers Builds 默认部署命令,并确认其 API Token 具备 D1 读取和编辑权限。binding 由部署命令生成,不要修改 Fork 中的文件。",
},
{
- title: "设置管理员密码",
- body: "添加一个名为 EDGE_EVER_AUTH_PASSWORD 的 Worker Secret,并将其值设为您要使用的管理员登录密码。建议使用至少 32 个字符的强密码。",
+ title: "准备管理员密码",
+ body: "准备管理员登录密码,建议至少 32 个字符。Worker 创建后,将它保存为运行时 Secret EDGE_EVER_AUTH_PASSWORD。",
},
{
title: "首次构建与验证",
- body: "管理员用户名默认为 admin。如需使用其他用户名,请在首次构建前设置 Workers Builds 构建变量 EDGE_EVER_AUTH_USERNAME。启动首次构建,部署完成后访问 /api/health,确认返回 200,再用配置的管理员用户名和密码登录。",
+ body: "保存并部署会创建 Worker 并启动构建。如因缺少管理员 Secret 而失败,添加第 4 步的运行时 Secret 后重试。管理员用户名默认为 admin;如需使用其他用户名,请在重试构建前设置 Workers Builds 构建变量 EDGE_EVER_AUTH_USERNAME。部署完成后访问 /api/health,确认返回 200,再用配置的管理员用户名和密码登录。",
},
{
title: "启用自动更新",
- body: "进入 Fork 的 Actions 标签页,点击 I understand my workflows, go ahead and enable them,然后手动运行一次 Update deployed EdgeEver,确保后续能够自动获得 EdgeEver 的最新功能与修复。",
+ body: "进入 Fork 的 Actions 标签页,点击 I understand my workflows, go ahead and enable them,然后手动运行一次 Update deployed EdgeEver,确保后续能够自动获得正式版本的功能更新与修复。",
},
],
},
diff --git a/docs/agent-deploy-cloudflare.md b/docs/agent-deploy-cloudflare.md
index aadcd209..2c19a100 100644
--- a/docs/agent-deploy-cloudflare.md
+++ b/docs/agent-deploy-cloudflare.md
@@ -16,28 +16,23 @@ This document defines the standard operating specifications and conventions for
- Create an R2 bucket named exactly `edgeever-resources`.
3. **Cloudflare Project Import**
- - Log into the Cloudflare **Workers & Pages** console and import the Fork repository.
- - Configure the project to use the repository root, the production `main` branch, and read the root `wrangler.toml`.
+ - In Cloudflare **Workers & Pages**, create a Worker named `edgeever` by importing the Fork repository. Select the repository root and production branch `main`.
+ - Keep the default Deploy command `npx wrangler deploy` in Cloudflare's Workers Builds settings. Cloudflare runs it in its build environment; the user does not run it on their computer. The repository routes it through EdgeEver's validated deployment pipeline. Do not create a Pages project for the application.
+ - Select **Save and Deploy** to create the Worker. The initial build may fail because the administrator Secret has not been added yet; configure it in the next step, then retry.
4. **Configure Login Credentials & Instance Settings**
- - **Worker Secret**: Add secret `EDGE_EVER_AUTH_PASSWORD` for the initial administrator password. Prefer a strong password of at least 32 characters.
+ - **Worker Secret**: After the Worker exists, add the runtime Secret `EDGE_EVER_AUTH_PASSWORD` for the initial administrator password. Prefer a strong password of at least 32 characters.
- Keep this password only as a Worker runtime Secret; do not copy it into Workers Builds variables. The standard deploy entrypoint reuses and verifies the existing Secret.
- Do not edit `wrangler.toml` or add duplicate bindings in the Dashboard. The deployment command generates the `DB` and `RESOURCES` bindings from these standard resource names.
- For an existing Worker deployed from older instructions, do not ask the user to rename or reconfigure a custom R2 bucket. With no explicit override, deployment automatically preserves the live `RESOURCES` binding and administrator username.
-5. **Configure Workers Builds Commands**
- - In the Cloudflare project build settings, set the standard commands:
-
- ```text
- Build command: bun install --frozen-lockfile && EDGE_EVER_DEPLOYMENT_TRIGGER=main_push EDGE_EVER_DEPLOYMENT_METHOD=cloudflare_workers_builds bun run build:cloudflare
- Deploy command: bun run deploy:cloudflare-builds
- ```
-
- - The deploy command automatically resolves the D1 UUID from the `edgeever` database name and writes all instance settings only to a temporary generated Wrangler configuration. The tracked `wrangler.toml` must remain unchanged; deployment rejects instance-specific values committed there so a Fork cannot diverge on infrastructure configuration.
+5. **Check Workers Builds Settings**
+ - Keep the repository root, `main` branch, and default Deploy command `npx wrangler deploy` in Cloudflare's build settings. Existing deployments that already use the explicit `bun run build:cloudflare` and `bun run deploy:cloudflare-builds` commands there may keep them.
+ - The deployment pipeline automatically resolves the D1 UUID from the `edgeever` database name and writes instance settings only to a temporary generated Wrangler configuration. The tracked `wrangler.toml` must remain unchanged; deployment rejects instance-specific values committed there so a Fork cannot diverge on infrastructure configuration.
- Ensure the Workers Builds API token can read and edit D1. Advanced non-secret customization belongs in `EDGE_EVER_*` Workers Builds variables. For a differently named database, set `EDGE_EVER_D1_DATABASE_NAME`; set `EDGE_EVER_D1_DATABASE_ID` only if automatic UUID discovery is unavailable. Passwords remain runtime Secrets.
6. **Start Initial Build & Verify Service**
- - Trigger the initial build. Once deployed, run the following automated verifications:
+ - Retry the build after adding the runtime Secret and any requested username override. Once deployed, run the following automated verifications:
- Check `https://<your-worker-domain>/api/health` returns HTTP `200` with JSON `{"ok": true}`.
- Check `https://<your-worker-domain>/api/openapi.json` is reachable and returns JSON `{"ok": true}`.
- Verify login API using the configured administrator username (default: `admin`) and `EDGE_EVER_AUTH_PASSWORD`.
@@ -54,4 +49,4 @@ This document defines the standard operating specifications and conventions for
## Optional: Customize the Initial Administrator Username
-Ordinary deployments use the default username `admin`; do not proactively ask the user whether to change it. Only when the user explicitly requests a custom administrator username, set `EDGE_EVER_AUTH_USERNAME` in Workers Builds variables before the first build and use that username during login verification. Changing only this variable after the administrator account exists does not rename that account.
+Ordinary deployments use the default username `admin`; do not proactively ask the user whether to change it. Only when the user explicitly requests a custom administrator username, set `EDGE_EVER_AUTH_USERNAME` in Workers Builds variables before retrying the initial build and use that username during login verification. Changing only this variable after the administrator account exists does not rename that account.
diff --git a/docs/agent-deploy-cloudflare.zh-CN.md b/docs/agent-deploy-cloudflare.zh-CN.md
index 57f06025..92d9d8e1 100644
--- a/docs/agent-deploy-cloudflare.zh-CN.md
+++ b/docs/agent-deploy-cloudflare.zh-CN.md
@@ -16,28 +16,23 @@
- 创建名称严格为 `edgeever-resources` 的 R2 存储桶。
3. **Cloudflare 项目导入**
- - 登录 Cloudflare **Workers & Pages** 控制台,导入该 Fork 仓库。
- - 配置项目使用仓库根目录、生产环境 `main` 分支,并读取仓库根目录下的 `wrangler.toml`。
+ - 在 Cloudflare **Workers & Pages** 中导入 Fork 仓库,创建名为 `edgeever` 的 Worker。选择仓库根目录和生产分支 `main`。
+ - 在 Cloudflare Workers Builds 设置中保留默认部署命令 `npx wrangler deploy`。该命令由 Cloudflare 的构建环境执行,用户无需在本机运行;仓库会将其接入 EdgeEver 的受验证部署流程。应用不要创建为 Pages 项目。
+ - 点击 **Save and Deploy** 创建 Worker。首次构建可能因为尚未添加管理员 Secret 而失败;完成下一步配置后重试。
4. **配置登录凭据与实例参数**
- - **Worker Secret**:添加密钥 `EDGE_EVER_AUTH_PASSWORD`,值为初始管理员登录密码;建议使用至少 32 个字符的强密码。
+ - **Worker Secret**:Worker 创建后,添加运行时密钥 `EDGE_EVER_AUTH_PASSWORD`,值为初始管理员登录密码;建议使用至少 32 个字符的强密码。
- 该密码只配置为 Worker 运行时 Secret,不要复制到 Workers Builds 构建变量;标准部署入口会复用并验证已存在的 Secret。
- 不要修改 `wrangler.toml`,也不要在控制台重复添加 binding。部署命令会根据标准资源名称生成 `DB` 与 `RESOURCES` binding。
- 对按旧版文档部署的已有 Worker,不要要求用户重命名或重新配置自定义 R2 存储桶。没有显式覆盖时,部署会自动保留线上 `RESOURCES` binding 与管理员用户名。
-5. **配置 Workers Builds 命令**
- - 在 Cloudflare 项目的构建设置中,填入以下标准命令:
-
- ```text
- Build command: bun install --frozen-lockfile && EDGE_EVER_DEPLOYMENT_TRIGGER=main_push EDGE_EVER_DEPLOYMENT_METHOD=cloudflare_workers_builds bun run build:cloudflare
- Deploy command: bun run deploy:cloudflare-builds
- ```
-
- - 部署命令会根据 `edgeever` 数据库名称自动查询 D1 UUID,并把所有实例参数仅写入临时生成的 Wrangler 配置。受版本控制的 `wrangler.toml` 必须保持不变;若把实例专属配置提交到该文件,部署会直接拒绝,避免 Fork 因基础设施配置产生分叉。
+5. **检查 Workers Builds 配置**
+ - 在 Cloudflare 的构建设置中保持仓库根目录、`main` 分支和默认部署命令 `npx wrangler deploy`。已有部署若在构建设置中使用显式的 `bun run build:cloudflare` 与 `bun run deploy:cloudflare-builds` 命令,可继续沿用。
+ - 部署流程会根据 `edgeever` 数据库名称自动查询 D1 UUID,并把所有实例参数仅写入临时生成的 Wrangler 配置。受版本控制的 `wrangler.toml` 必须保持不变;若把实例专属配置提交到该文件,部署会直接拒绝,避免 Fork 因基础设施配置产生分叉。
- 请确保 Workers Builds API Token 具有 D1 读取和编辑权限。高级非敏感自定义参数应放在 `EDGE_EVER_*` Workers Builds 构建变量中。如使用其他数据库名称,设置 `EDGE_EVER_D1_DATABASE_NAME`;仅在无法自动查询 UUID 时设置 `EDGE_EVER_D1_DATABASE_ID`。密码始终属于运行时 Secret。
6. **启动首次构建与服务验证**
- - 触发启动首次构建,待构建部署完成后,进行如下自动化验证:
+ - 添加运行时 Secret 及用户要求的用户名覆盖后,重试构建。部署完成后进行如下自动化验证:
- 检查 `https://<你的 Worker 域名>/api/health` 返回 `200` 状态码且 JSON 内容为 `{"ok": true}`。
- 检查 `https://<你的 Worker 域名>/api/openapi.json` 可以访问,且 JSON 含 `"ok": true`。
- 使用配置的管理员用户名(默认 `admin`)和 `EDGE_EVER_AUTH_PASSWORD` 验证登录 API。
@@ -54,4 +49,4 @@
## 可选:自定义初始管理员用户名
-普通部署直接使用默认用户名 `admin`,不要主动询问用户是否需要修改。仅当用户明确要求自定义管理员用户名时,才在首次构建前通过 Workers Builds 构建变量设置 `EDGE_EVER_AUTH_USERNAME`,并在登录验证时使用该用户名。管理员账号已创建后,仅修改该变量不会重命名现有账号。
+普通部署直接使用默认用户名 `admin`,不要主动询问用户是否需要修改。仅当用户明确要求自定义管理员用户名时,才在重试首次构建前通过 Workers Builds 构建变量设置 `EDGE_EVER_AUTH_USERNAME`,并在登录验证时使用该用户名。管理员账号已创建后,仅修改该变量不会重命名现有账号。
diff --git a/docs/deploy-cloudflare-button.md b/docs/deploy-cloudflare-button.md
index 700d0a92..85fdd30f 100644
--- a/docs/deploy-cloudflare-button.md
+++ b/docs/deploy-cloudflare-button.md
@@ -38,9 +38,10 @@ Log into your [Cloudflare Dashboard](https://dash.cloudflare.com/). If an entry
1. Open **Workers & Pages**, click **Create application**, then **Get started** next to **Import a repository**. If the entry moves, see [Cloudflare's instructions](https://developers.cloudflare.com/workers/ci-cd/builds/#connect-a-new-worker).
2. Follow the prompts to connect your GitHub account, authorize access to your Fork, and select the Forked `edgeever` repository.
3. Project settings:
+ - **Worker name**: `edgeever`, matching the `name` in the root `wrangler.toml`
- **Git branch** (or **Production branch**): `main`
- **Root directory**: Leave blank to use the repository root
- - Deploy command: npx wrangler deploy (keep the default)
+ - Deploy command: npx wrangler deploy (keep Cloudflare's default; Workers Builds runs it online, not on your computer)
- **API token**: The automatically generated token may lack D1 permissions. Select or create a User API Token scoped to the target account with D1 read and edit permissions; if permissions are insufficient, correct them based on the build log and retry.
The deployment command creates the `DB` and `RESOURCES` bindings and looks up the D1 UUID. Do not edit `wrangler.toml` or add duplicate bindings in the Dashboard.
@@ -53,7 +54,7 @@ Click **Save and Deploy** to create the Worker. The first build fails verificati
| Type | Name | Value | Purpose |
| :--- | :--- | :--- | :--- |
-| **Secret** | `EDGE_EVER_AUTH_PASSWORD` | Preferably at least 32 characters and unique to this instance | Administrator login password |
+| **Secret** | `EDGE_EVER_AUTH_PASSWORD` | Preferably at least 32 characters | Administrator login password |
`EDGE_EVER_AUTH_PASSWORD` is the variable name; its value is the administrator login password. It is a Worker runtime Secret, not a Workers Builds variable.
@@ -99,7 +100,7 @@ To customize an instance, add non-secret values under the Worker's **Settings
| `EDGE_EVER_WORKERS_DEV` | Enable or disable the `workers.dev` route |
| `EDGE_EVER_CUSTOM_DOMAIN` / `EDGE_EVER_ROUTE_PATTERN` | Custom routing |
-Set a custom administrator username before the first build; changing the variable later does not rename the account.
+Set a custom administrator username before retrying the initial build; changing the variable after the account exists does not rename it.
Older deployments need not migrate a custom R2 bucket; upgrades reuse the live `RESOURCES` binding unless overridden. Existing explicit build commands remain supported; see [Workers Builds configuration](cloudflare-workers-builds.md).
diff --git a/docs/deploy-cloudflare-button.zh-CN.md b/docs/deploy-cloudflare-button.zh-CN.md
index 715f431d..95e0e02e 100644
--- a/docs/deploy-cloudflare-button.zh-CN.md
+++ b/docs/deploy-cloudflare-button.zh-CN.md
@@ -38,9 +38,10 @@
1. 打开 **Workers & Pages**,点击 **Create application** → **Import a repository** 旁的 **Get started**。入口变化时参考 [Cloudflare 官方步骤](https://developers.cloudflare.com/workers/ci-cd/builds/#connect-a-new-worker)。
2. 按提示连接 GitHub 账户,授权 Cloudflare 访问该 Fork,并选中您刚才 Fork 的 `edgeever` 仓库。
3. 在项目设置中:
+ - **Worker 名称**:`edgeever`,与根目录 `wrangler.toml` 中的 `name` 一致
- **Git branch**(或 **Production branch**):选择 `main`
- **Root directory**:保持留空,使用仓库根目录
- - Deploy command: npx wrangler deploy(保留默认值)
+ - Deploy command: npx wrangler deploy(保留 Cloudflare 默认值,由 Workers Builds 在线执行,无需在本机运行)
- **API token**:自动生成的 token 可能没有 D1 权限。选择或创建限定到目标账户、具备 D1 读取与编辑权限的 User API Token;权限不足时按构建日志调整后重试。
部署命令会自动生成 `DB` 与 `RESOURCES` binding,并查询 D1 UUID。不要修改 `wrangler.toml` 或在控制台重复添加 binding。
@@ -53,7 +54,7 @@
| 类型 (Type) | 名称 (Name) | 值 (Value) | 说明 |
| :--- | :--- | :--- | :--- |
-| **Secret** | `EDGE_EVER_AUTH_PASSWORD` | 建议至少 32 个字符且仅用于此实例的强密码 | 管理员登录密码 |
+| **Secret** | `EDGE_EVER_AUTH_PASSWORD` | 建议至少 32 个字符的强密码 | 管理员登录密码 |
`EDGE_EVER_AUTH_PASSWORD` 是变量名,值是管理员登录密码。它属于 Worker 运行时 Secret,不是 Workers Builds 构建变量。
@@ -99,7 +100,7 @@ EDGE_EVER_UPDATE_CHANNEL=edge
| `EDGE_EVER_WORKERS_DEV` | 启用或禁用 `workers.dev` 路由 |
| `EDGE_EVER_CUSTOM_DOMAIN` / `EDGE_EVER_ROUTE_PATTERN` | 自定义路由 |
-自定义管理员用户名须在首次构建前设置;账号创建后修改该变量不会重命名账号。
+自定义管理员用户名须在重试首次构建前设置;账号创建后修改该变量不会重命名账号。
旧部署的自定义 R2 存储桶无需迁移;不设置覆盖变量时,升级会沿用线上 `RESOURCES` binding。已有项目的显式构建命令也可继续使用,详见 [Workers Builds 配置](cloudflare-workers-builds.zh-CN.md)。