Skip to content

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

Fix deploy button env template

tianmad07273c93b32
diff --git a/.env.example b/.env.example
index b022ac26..13741d4a 100644
--- a/.env.example
+++ b/.env.example
@@ -1,35 +1,7 @@
-# EdgeEver 本地环境变量模板。
-# 使用方式:复制为 .env.local,然后填入你自己的 Cloudflare 账号和资源信息。
-# 注意:.env.local 会被 git 忽略,不要把真实 Token 或私有资源 ID 提交到公开仓库。
-
-# Cloudflare 账号 ID。
-# 可通过 `bunx wrangler whoami` 查看。
-CLOUDFLARE_ACCOUNT_ID=
-
-# Cloudflare API Token。
-# 本地已经通过 `wrangler login` 登录时可以留空;CI/CD 自动部署时再填写。
-CLOUDFLARE_API_TOKEN=
-
-# Worker 服务名称。
-# 默认会部署为名叫 edgeever 的 Cloudflare Worker。
-EDGE_EVER_WORKER_NAME=edgeever
-
-# D1 数据库名称。
-# 创建命令:`bunx wrangler d1 create edgeever`
-EDGE_EVER_D1_DATABASE_NAME=edgeever
-
-# D1 数据库 ID。
-# 创建 D1 后,把 wrangler 返回的 database_id 填到这里,并同步替换 wrangler.toml 里的占位值。
-EDGE_EVER_D1_DATABASE_ID=00000000-0000-0000-0000-000000000000
-
-# R2 生产资源桶名称。
-# 创建命令:`bunx wrangler r2 bucket create edgeever-resources`
-EDGE_EVER_R2_BUCKET_NAME=edgeever-resources
-
-# R2 预览/本地开发资源桶名称。
-# 可选;用于 Wrangler preview/dev 场景隔离测试附件。
-EDGE_EVER_R2_PREVIEW_BUCKET_NAME=edgeever-resources-preview
-
-# 前端访问 API 的基础地址。
-# 本地开发默认指向 Wrangler dev:`bun run dev:api`
-VITE_API_BASE_URL=http://127.0.0.1:8787
+# EdgeEver Worker runtime secrets template.
+#
+# Cloudflare Deploy Button 会读取 `.env.example` / `.dev.vars.example`,并把其中
+# 每一个变量当作需要用户在部署向导里填写的 Worker Secret。
+#
+# 当前阶段 EdgeEver 不需要任何 Worker 运行时密钥,所以这里故意不声明变量。
+# 本地 CLI / Wrangler 部署所需的账号、资源和 Token 模板请看 `.env.local.example`。
diff --git a/.env.local.example b/.env.local.example
new file mode 100644
index 00000000..b022ac26
--- /dev/null
+++ b/.env.local.example
@@ -0,0 +1,35 @@
+# EdgeEver 本地环境变量模板。
+# 使用方式:复制为 .env.local,然后填入你自己的 Cloudflare 账号和资源信息。
+# 注意:.env.local 会被 git 忽略,不要把真实 Token 或私有资源 ID 提交到公开仓库。
+
+# Cloudflare 账号 ID。
+# 可通过 `bunx wrangler whoami` 查看。
+CLOUDFLARE_ACCOUNT_ID=
+
+# Cloudflare API Token。
+# 本地已经通过 `wrangler login` 登录时可以留空;CI/CD 自动部署时再填写。
+CLOUDFLARE_API_TOKEN=
+
+# Worker 服务名称。
+# 默认会部署为名叫 edgeever 的 Cloudflare Worker。
+EDGE_EVER_WORKER_NAME=edgeever
+
+# D1 数据库名称。
+# 创建命令:`bunx wrangler d1 create edgeever`
+EDGE_EVER_D1_DATABASE_NAME=edgeever
+
+# D1 数据库 ID。
+# 创建 D1 后,把 wrangler 返回的 database_id 填到这里,并同步替换 wrangler.toml 里的占位值。
+EDGE_EVER_D1_DATABASE_ID=00000000-0000-0000-0000-000000000000
+
+# R2 生产资源桶名称。
+# 创建命令:`bunx wrangler r2 bucket create edgeever-resources`
+EDGE_EVER_R2_BUCKET_NAME=edgeever-resources
+
+# R2 预览/本地开发资源桶名称。
+# 可选;用于 Wrangler preview/dev 场景隔离测试附件。
+EDGE_EVER_R2_PREVIEW_BUCKET_NAME=edgeever-resources-preview
+
+# 前端访问 API 的基础地址。
+# 本地开发默认指向 Wrangler dev:`bun run dev:api`
+VITE_API_BASE_URL=http://127.0.0.1:8787
diff --git a/.gitignore b/.gitignore
index 26320c93..a36dcef3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,6 +2,7 @@
.env
.env.*
!.env.example
+!.env.local.example
node_modules/
dist/
diff --git a/README.md b/README.md
index c897de30..e6d7d8f8 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
</p>
<p align="center">
- 点击上方按钮进入 Cloudflare 部署向导;确认后会自动创建并绑定 D1/R2 资源,构建并部署 EdgeEver。
+ 点击上方按钮进入 Cloudflare 部署向导;Cloudflare 会根据 wrangler 配置创建并绑定 D1/R2 资源,执行构建、D1 migration 和 Worker 部署。
</p>
EdgeEver 是一个完全开源、支持自部署、面向人类和 AI Agent 的现代笔记工作区。
@@ -127,12 +127,14 @@ content_text 全文搜索、摘要、embedding 使用的纯文本
## Cloudflare 初始化
-公开仓库可以直接通过上方 **Deploy to Cloudflare** 按钮进入部署向导。Cloudflare 会读取 `wrangler.toml`,为 D1/R2 等绑定创建或配置所需资源,并使用 `package.json` 中的 `deploy` 脚本执行 D1 migration 与 Worker 部署。你仍需要登录 Cloudflare 并确认仓库名、Worker 名和资源名。
+公开仓库可以直接通过上方 **Deploy to Cloudflare** 按钮进入部署向导。Cloudflare 会读取 `wrangler.toml`,为 D1/R2 等绑定创建或配置所需资源,并使用 `package.json` 中的 `deploy` 脚本执行 D1 migration 与 Worker 部署。你仍需要登录 Cloudflare、授权 GitHub/GitLab 连接,并确认仓库名、Worker 名和资源名;如果你的账号里已经存在同名 Worker 或仓库,把项目名改成一个唯一名称即可。
+
+`.env.example` 在 Deploy Button 语义下是 Worker Secret 模板。当前 EdgeEver 不需要运行时密钥,所以一键部署时不需要填写 `CLOUDFLARE_ACCOUNT_ID` 或 `CLOUDFLARE_API_TOKEN`。
如果你更喜欢 CLI 部署,先创建本机环境文件:
```sh
-cp .env.example .env.local
+cp .env.local.example .env.local
```
`.env.local` 已被 `.gitignore` 忽略,用来保存本机 Cloudflare 账号、资源名称、API Token 等部署参数。不要把它提交到公开仓库。