Skip to content

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

docs: simplify env template comments

yomadc1dedefa758
diff --git a/.env.local.example b/.env.local.example
index 8be721c5..fa7deb8d 100644
--- a/.env.local.example
+++ b/.env.local.example
@@ -1,74 +1,76 @@
-# EdgeEver 本地环境变量模板。
-# 使用方式:复制为 .env.local,然后填入你自己的 Cloudflare 账号和资源信息。
-# 注意:.env.local 会被 git 忽略,不要把真实 Token 或私有资源 ID 提交到公开仓库。
+# EdgeEver local environment variables.
+# Copy this file to .env.local, fill in your own values, and never commit that file.
-# Cloudflare 账号 ID。
-# 可通过 `bunx wrangler whoami` 查看。
+# Cloudflare account ID.
+# Find it with `bunx wrangler whoami`.
CLOUDFLARE_ACCOUNT_ID=
-# Cloudflare API Token。
-# 本地已经通过 `wrangler login` 登录时可以留空;CI/CD 自动部署时再填写。
+# Cloudflare API token.
+# Leave empty when authenticated locally with `wrangler login`; set it for CI/CD deployments.
CLOUDFLARE_API_TOKEN=
-# Worker 服务名称。
-# 默认会部署为名叫 edgeever 的 Cloudflare Worker。
+# Worker service name.
+# Defaults to the `edgeever` Cloudflare Worker.
EDGE_EVER_WORKER_NAME=edgeever
-# 是否启用 workers.dev 子域名。可选值:true / false。
+# Whether to enable the workers.dev subdomain. Allowed values: true / false.
EDGE_EVER_WORKERS_DEV=true
-# D1 数据库名称。
-# 创建命令:`bunx wrangler d1 create edgeever`
+# D1 database name.
+# Create it with: `bunx wrangler d1 create edgeever`
EDGE_EVER_D1_DATABASE_NAME=edgeever
-# D1 数据库 ID。
-# 创建 D1 后,把 wrangler 返回的 database_id 填到这里。
-# Cloudflare Git 自动部署时,也需要在 Build Variables 里设置同名变量。
-# 脚本会生成临时 .wrangler.generated.toml,不需要把个人 D1 ID 提交到公开仓库。
+# D1 database ID.
+# After creating the D1 database, copy the returned database_id here.
+# Cloudflare Git deployments also require this variable in Build Variables.
+# The scripts generate a temporary .wrangler.generated.toml, so you do not need to
+# commit your personal D1 ID to the public repository.
EDGE_EVER_D1_DATABASE_ID=00000000-0000-0000-0000-000000000000
-# R2 生产资源桶名称。
-# 创建命令:`bunx wrangler r2 bucket create edgeever-resources`
+# Production R2 bucket name.
+# Create it with: `bunx wrangler r2 bucket create edgeever-resources`
EDGE_EVER_R2_BUCKET_NAME=edgeever-resources
-# R2 预览/本地开发资源桶名称。
-# 可选;用于 Wrangler preview/dev 场景隔离测试附件。
+# Preview/local development R2 bucket name.
+# Optional; use it to isolate test attachments in Wrangler preview/dev environments.
EDGE_EVER_R2_PREVIEW_BUCKET_NAME=edgeever-resources-preview
-# 登录账号。
+# Login username.
EDGE_EVER_AUTH_USERNAME=admin
-# 登录密码的 PBKDF2-SHA256 hash。
-# 生成命令:`bun run auth:hash -- <你的密码>`
-# 也可以用 `EDGE_EVER_<INSTANCE>_AUTH_PASSWORD_HASH` 给多实例配置不同密码。
-# 线上部署时建议把对应 hash 配成 Cloudflare Worker Secret。
+# PBKDF2-SHA256 hash of the login password.
+# Generate it with: `bun run auth:hash -- <your-password>`
+# For multi-instance deployments, use `EDGE_EVER_<INSTANCE>_AUTH_PASSWORD_HASH`
+# to configure a different password for each instance.
+# For production deployments, store the hash as a Cloudflare Worker Secret.
EDGE_EVER_AUTH_PASSWORD_HASH=
-# Web session 有效期,单位:天。服务端会限制在 1-400 天。
+# Web session lifetime in days. The server limits it to 1-400 days.
EDGE_EVER_SESSION_TTL_DAYS=400
-# 可选:公开 demo 模式。只建议 demo.edgeever.org 这类共享演示环境开启。
-# 开启后,Worker 会在读取笔记本时补齐示例内容,并通过 Cron 定期重置 demo 数据。
+# Optional: public demo mode. Recommended only for shared demo environments such as demo.edgeever.org.
+# When enabled, the Worker fills missing sample content and periodically resets demo data with Cron.
EDGE_EVER_DEMO_MODE=false
-# 可选:demo 重置 Cron,使用 UTC 时间。默认 `0 19 * * *`,即北京时间每天 03:00。
-# 仅在 EDGE_EVER_DEMO_MODE=true 时由部署脚本写入临时 Wrangler 配置。
+# Optional: demo reset Cron schedule, in UTC. Defaults to `0 19 * * *` (03:00 Beijing time).
+# The deployment scripts add it to the temporary Wrangler config only when EDGE_EVER_DEMO_MODE=true.
EDGE_EVER_DEMO_RESET_CRON=0 19 * * *
-# 可选:自定义域名。设置后部署脚本会生成 custom_domain route。
-# 例如:notes.example.com
+# Optional: custom domain. The deployment scripts create a custom_domain route when set.
+# Example: notes.example.com
EDGE_EVER_CUSTOM_DOMAIN=
-# 可选:完整 route pattern。未设置时会回退使用 EDGE_EVER_CUSTOM_DOMAIN。
-# 例如:notes.example.com/*
+# Optional: full route pattern. Falls back to EDGE_EVER_CUSTOM_DOMAIN when unset.
+# Example: notes.example.com/*
EDGE_EVER_ROUTE_PATTERN=
-# 前端访问 API 的基础地址。
-# 本地开发默认指向 Wrangler dev:`bun run dev:api`
+# Frontend API base URL.
+# Local development defaults to the Wrangler dev server: `bun run dev:api`
VITE_API_BASE_URL=http://127.0.0.1:8787
-# 可选:多实例部署。
-# 在本机 `.env.local` 或 Cloudflare Build Variables 中设置 `EDGE_EVER_INSTANCE=<name>` 后,
-# 脚本会优先读取 `EDGE_EVER_<NAME>_*`,再回退到上面的通用 `EDGE_EVER_*`。
-# 例如 `EDGE_EVER_INSTANCE=prod` 会优先读取 `EDGE_EVER_PROD_WORKER_NAME`、
-# `EDGE_EVER_PROD_D1_DATABASE_ID`、`EDGE_EVER_PROD_R2_BUCKET_NAME` 等变量。
+# Optional: multi-instance deployment.
+# Set `EDGE_EVER_INSTANCE=<name>` in .env.local or Cloudflare Build Variables.
+# The scripts prefer `EDGE_EVER_<NAME>_*` values and fall back to the generic
+# `EDGE_EVER_*` values above.
+# For example, `EDGE_EVER_INSTANCE=prod` prefers `EDGE_EVER_PROD_WORKER_NAME`,
+# `EDGE_EVER_PROD_D1_DATABASE_ID`, `EDGE_EVER_PROD_R2_BUCKET_NAME`, and similar variables.