Skip to content

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

Add demo reset mode and prefilled login

tianma21c16392ce0d
diff --git a/.env.local.example b/.env.local.example
index e09f8779..d7286ffc 100644
--- a/.env.local.example
+++ b/.env.local.example
@@ -47,6 +47,14 @@ EDGE_EVER_AUTH_PASSWORD_HASH=
# Web session 有效期,单位:天。服务端会限制在 1-90 天。
EDGE_EVER_SESSION_TTL_DAYS=30
+# 可选:公开 demo 模式。只建议 demo.edgeever.org 这类共享演示环境开启。
+# 开启后,Worker 会在读取笔记本时补齐示例内容,并通过 Cron 定期重置 demo 数据。
+EDGE_EVER_DEMO_MODE=false
+
+# 可选:demo 重置 Cron,使用 UTC 时间。默认 `0 19 * * *`,即北京时间每天 03:00。
+# 仅在 EDGE_EVER_DEMO_MODE=true 时由部署脚本写入临时 Wrangler 配置。
+EDGE_EVER_DEMO_RESET_CRON=0 19 * * *
+
# 可选:自定义域名。设置后部署脚本会生成 custom_domain route。
# 例如:notes.example.com
EDGE_EVER_CUSTOM_DOMAIN=
diff --git a/README.md b/README.md
index c046041b..af98af72 100644
--- a/README.md
+++ b/README.md
@@ -20,23 +20,48 @@ Memos 等轻量笔记产品更开放,但交互体验和经典印象笔记式
- 演示账号:`ee-demo`
- 演示密码:`demo#dZ6Q29Zjfor%`
-公开演示环境可能会被重置,请不要保存私密内容。
+公开演示环境会每天自动重置并恢复示例笔记,请不要保存私密内容。
## 部署
+建议先 Fork 本仓库到你自己的 GitHub 账号,再从你的 Fork 仓库进行部署。这样后续 EdgeEver 发布新功能时,你可以在 GitHub 上通过 **Sync fork** 同步官方仓库更新,再重新部署到自己的 Cloudflare。
+
### AI Agent 一句话部署
如果你使用 Codex、Claude Code、Antigravity 等 AI Agent,并且已经登录 Cloudflare 或安装了 Cloudflare 相关插件,可以直接把下面这句话发给 Agent:
```text
-这个是 GitHub 上的项目链接:https://github.com/msh01/edgeever。请把这个项目安装部署到 Cloudflare 上。
+这个是我的 EdgeEver Fork 仓库链接:<你的 Fork 仓库 URL>。请把这个项目安装部署到 Cloudflare 上。
```
Agent 应优先按 [AI Agent Cloudflare Deployment](docs/agent-deploy-cloudflare.md) 执行,只在需要 Cloudflare 授权、首次登录密码或自定义域名时询问你。
### 手动部署
-如果使用 CLI 部署:
+1. Fork 官方仓库:
+
+ ```text
+ https://github.com/msh01/edgeever
+ ```
+
+2. Clone 你自己的 Fork 仓库:
+
+ ```sh
+ git clone <你的 Fork 仓库 URL>
+ cd edgeever
+ ```
+
+3. 使用自动化辅助命令部署:
+
+ ```sh
+ cp .env.local.example .env.local
+ bun install
+ EDGE_EVER_PASSWORD='<你的密码>' bun run deploy:setup
+ bun run deploy:doctor
+ bun run deploy
+ ```
+
+如果你想手动创建 Cloudflare 资源,也可以使用 CLI:
```sh
cp .env.local.example .env.local
@@ -47,14 +72,36 @@ bun run auth:hash -- <你的密码>
bun run deploy
```
-把 D1 创建命令返回的 `database_id` 和密码 hash 填入本机 `.env.local`。也可以使用自动化辅助命令:
+把 D1 创建命令返回的 `database_id` 和密码 hash 填入本机 `.env.local`。
+
+## 更新到最新版
+
+如果你是通过 Fork 部署的:
+
+1. 打开你自己的 EdgeEver Fork 仓库。
+2. 点击 GitHub 页面上的 **Sync fork**,同步官方仓库的最新代码。
+3. 回到本地项目目录重新部署:
+
+ ```sh
+ git pull
+ bun install
+ bun run deploy:doctor
+ bun run deploy
+ ```
+
+同步 Fork 只会更新你 GitHub 仓库里的代码,不会自动更新已经部署到 Cloudflare 的实例。同步后必须重新执行部署命令,更新才会生效。
+
+## 公开 Demo 模式
+
+个人自托管实例默认不会自动清理数据。如果你要部署类似 `demo.edgeever.org` 的公开演示环境,可以在 `.env.local` 或 Cloudflare Build Variables 中开启 demo 模式:
```sh
-EDGE_EVER_PASSWORD='<你的密码>' bun run deploy:setup
-bun run deploy:doctor
-bun run deploy
+EDGE_EVER_DEMO_MODE=true
+EDGE_EVER_DEMO_RESET_CRON='0 19 * * *'
```
+开启后,服务端会自动补齐示例笔记,并在每天 UTC 19:00(北京时间 03:00)通过 Cloudflare Cron 重置 demo 数据:删除用户新增内容、附件资源、API token 和审计日志,再恢复固定示例笔记。
+
## 功能
- 个人使用几乎可以零成本托管:基于 Cloudflare D1 + R2 免费额度,短笔记可达 10 万条量级,200KB 图片约可存放 5 万张。
diff --git a/apps/api/src/index.ts b/apps/api/src/index.ts
index a4dce8d0..2d58891a 100644
--- a/apps/api/src/index.ts
+++ b/apps/api/src/index.ts
@@ -43,6 +43,7 @@ type Bindings = {
EDGE_EVER_AUTH_PASSWORD_HASH?: string;
EDGE_EVER_SESSION_TTL_DAYS?: string;
EDGE_EVER_R2_BUCKET_NAME?: string;
+ EDGE_EVER_DEMO_MODE?: string;
};
type AuthContext = {
@@ -194,6 +195,72 @@ const PASSWORD_SALT_BYTES = 16;
const SESSION_TOKEN_BYTES = 32;
const DEFAULT_SESSION_TTL_DAYS = 30;
const DEFAULT_R2_BUCKET_NAME = "edgeever-resources";
+const DEMO_SEED_NOTEBOOKS = [
+ { id: "nb_inbox", parentId: null, name: "等待分类", slug: "inbox", icon: "notebook", color: "#0f766e", sortOrder: 10 },
+ { id: "nb_projects", parentId: null, name: "工作项目", slug: "work-projects", icon: "notebook", color: "#2563eb", sortOrder: 20 },
+ { id: "nb_learning", parentId: null, name: "学习资料", slug: "learning-resources", icon: "notebook", color: "#7c3aed", sortOrder: 30 },
+ { id: "nb_creative", parentId: null, name: "灵感创作", slug: "creative-ideas", icon: "notebook", color: "#db2777", sortOrder: 40 },
+ { id: "nb_personal", parentId: null, name: "生活个人", slug: "personal-life", icon: "notebook", color: "#ea580c", sortOrder: 50 },
+ { id: "nb_demo_features", parentId: "nb_projects", name: "功能演示", slug: "demo-features", icon: "notebook", color: "#0891b2", sortOrder: 21 },
+];
+const DEMO_SEED_MEMOS = [
+ {
+ id: "memo_welcome",
+ notebookId: "nb_inbox",
+ title: "欢迎来到 EdgeEver",
+ tags: ["edgeever", "welcome"],
+ isPinned: true,
+ markdown:
+ "## 欢迎来到 EdgeEver\n\n这是公开演示环境,可以随便创建、编辑、搜索和合并笔记。\n\n演示环境会每天自动重置,请不要保存私密内容。",
+ },
+ {
+ id: "memo_demo_editor",
+ notebookId: "nb_demo_features",
+ title: "富文本与 Markdown 编辑",
+ tags: ["editor", "markdown"],
+ isPinned: true,
+ markdown:
+ "## 富文本与 Markdown 编辑\n\nEdgeEver 使用 TipTap 保存结构化正文,同时保留 Markdown 和纯文本索引。\n\n- 支持标题、列表、引用和代码块\n- API 和 MCP 可以直接读写 Markdown\n- 搜索使用纯文本索引,不依赖前端编辑器",
+ },
+ {
+ id: "memo_demo_search_tags",
+ notebookId: "nb_learning",
+ title: "标签、搜索与归档",
+ tags: ["search", "tags", "workflow"],
+ isPinned: false,
+ markdown:
+ "## 标签、搜索与归档\n\n这条笔记用于演示标签和全文搜索。你可以搜索 `workflow`、`全文搜索` 或 `EdgeEver`。\n\n建议把临时资料先放入等待分类,再通过标签和笔记本整理。",
+ },
+ {
+ id: "memo_demo_merge",
+ notebookId: "nb_demo_features",
+ title: "多选合并笔记示例",
+ tags: ["merge", "long-term-note"],
+ isPinned: false,
+ markdown:
+ "## 多选合并笔记示例\n\n在笔记列表中多选几条笔记后,可以合并为一条长期笔记。原笔记会进入回收站,资源关联会移动到新笔记。\n\n这个能力适合把零散摘录整理成项目总结。",
+ },
+ {
+ id: "memo_demo_agent",
+ notebookId: "nb_projects",
+ title: "Agent-ready:REST API 与 MCP",
+ tags: ["api", "mcp", "agent"],
+ isPinned: false,
+ markdown:
+ "## Agent-ready\n\nEdgeEver 提供 REST API、OpenAPI schema 和 MCP endpoint。AI Agent 可以读取笔记本、创建笔记、整理标签,并把导入资料迁移到你的自托管实例。\n\nOpenAPI 路径:`/api/openapi.json`",
+ },
+ {
+ id: "memo_demo_mobile",
+ notebookId: "nb_personal",
+ title: "移动端与 PWA",
+ tags: ["pwa", "mobile"],
+ isPinned: false,
+ markdown:
+ "## 移动端与 PWA\n\nEdgeEver 支持桌面三栏工作流,也适配移动端。你可以把站点安装为 PWA,用手机快速记录,再回到桌面整理。",
+ },
+];
+const DEMO_SEED_NOTEBOOK_IDS = DEMO_SEED_NOTEBOOKS.map((notebook) => notebook.id);
+const DEMO_SEED_MEMO_IDS = DEMO_SEED_MEMOS.map((memo) => memo.id);
const MAX_IMAGE_UPLOAD_BYTES = 100 * 1024 * 1024;
const MAX_ATTACHMENT_UPLOAD_BYTES = 100 * 1024 * 1024;
const REVISION_SNAPSHOT_INTERVAL_MS = 5 * 60 * 1000;
@@ -441,6 +508,10 @@ app.get("/api/v1/notebooks", async (c) => {
return denied;
}
+ if (isDemoMode(c.env)) {
+ await ensureDemoSeed(c.env.DB);
+ }
+
const rows = await c.env.DB.prepare(
notebookSelectSql(
`WHERE n.is_deleted = 0
@@ -1452,6 +1523,19 @@ app.post("/mcp", async (c) => {
return c.json(result.body, result.status as 200);
});
+const worker = {
+ fetch(request: Request, env: Bindings, ctx: ExecutionContext) {
+ return app.fetch(request, env, ctx);
+ },
+ async scheduled(controller: ScheduledController, env: Bindings, ctx: ExecutionContext) {
+ if (!isDemoMode(env)) {
+ return;
+ }
+
+ ctx.waitUntil(resetDemoData(env, controller.scheduledTime));
+ },
+};
+
app.notFound((c) =>
c.json(
{
@@ -1464,7 +1548,7 @@ app.notFound((c) =>
)
);
-export default app;
+export default worker;
type JsonRpcRequest = {
jsonrpc?: string;
@@ -3059,6 +3143,135 @@ const emptyTrashMemosRecord = async (
return deleted;
};
+const isDemoMode = (env: Bindings) => env.EDGE_EVER_DEMO_MODE?.trim().toLowerCase() === "true";
+
+const ensureDemoSeed = async (db: D1Database) => {
+ const now = isoNow();
+ const statements: D1PreparedStatement[] = [];
+
+ for (const notebook of DEMO_SEED_NOTEBOOKS) {
+ statements.push(
+ db
+ .prepare(
+ `INSERT INTO notebooks (
+ id, parent_id, name, slug, icon, color, sort_order, is_deleted, created_at, updated_at, deleted_at
+ ) VALUES (?, ?, ?, ?, ?, ?, ?, 0, ?, ?, NULL)
+ ON CONFLICT(id) DO UPDATE SET
+ parent_id = excluded.parent_id,
+ name = excluded.name,
+ slug = excluded.slug,
+ icon = excluded.icon,
+ color = excluded.color,
+ sort_order = excluded.sort_order,
+ is_deleted = 0,
+ updated_at = excluded.updated_at,
+ deleted_at = NULL`
+ )
+ .bind(
+ notebook.id,
+ notebook.parentId,
+ notebook.name,
+ notebook.slug,
+ notebook.icon,
+ notebook.color,
+ notebook.sortOrder,
+ now,
+ now
+ )
+ );
+ }
+
+ for (const memo of DEMO_SEED_MEMOS) {
+ const contentJson = markdownToDoc(memo.markdown);
+ const contentText = docToText(contentJson);
+ const contentHash = await sha256(memo.markdown + JSON.stringify(contentJson));
+
+ statements.push(
+ db
+ .prepare(
+ `INSERT INTO memos (
+ id, notebook_id, title, excerpt, tags_json, is_pinned, is_archived, is_deleted,
+ created_by, updated_by, created_at, updated_at, deleted_at
+ ) VALUES (?, ?, ?, ?, ?, ?, 0, 0, 'system', 'system', ?, ?, NULL)
+ ON CONFLICT(id) DO UPDATE SET
+ notebook_id = excluded.notebook_id,
+ title = excluded.title,
+ excerpt = excluded.excerpt,
+ tags_json = excluded.tags_json,
+ is_pinned = excluded.is_pinned,
+ is_archived = 0,
+ is_deleted = 0,
+ updated_by = 'system',
+ updated_at = excluded.updated_at,
+ deleted_at = NULL`
+ )
+ .bind(
+ memo.id,
+ memo.notebookId,
+ memo.title,
+ createExcerpt(contentText),
+ JSON.stringify(normalizeTags(memo.tags)),
+ memo.isPinned ? 1 : 0,
+ now,
+ now
+ ),
+ db
+ .prepare(
+ `INSERT INTO memo_contents (
+ memo_id, content_json, content_markdown, content_text, content_hash, revision, created_at, updated_at
+ ) VALUES (?, ?, ?, ?, ?, 0, ?, ?)
+ ON CONFLICT(memo_id) DO UPDATE SET
+ content_json = excluded.content_json,
+ content_markdown = excluded.content_markdown,
+ content_text = excluded.content_text,
+ content_hash = excluded.content_hash,
+ revision = 0,
+ updated_at = excluded.updated_at`
+ )
+ .bind(memo.id, JSON.stringify(contentJson), memo.markdown, contentText, contentHash, now, now),
+ db.prepare(`DELETE FROM memos_fts WHERE memo_id = ?`).bind(memo.id),
+ db
+ .prepare(
+ `INSERT INTO memos_fts (memo_id, title, content_text, tags)
+ VALUES (?, ?, ?, ?)`
+ )
+ .bind(memo.id, memo.title, contentText, memo.tags.join(" "))
+ );
+ }
+
+ await db.batch(statements);
+};
+
+const resetDemoData = async (env: Bindings, scheduledTime: number) => {
+ const db = env.DB;
+ const memoPlaceholders = DEMO_SEED_MEMO_IDS.map(() => "?").join(", ");
+ const notebookPlaceholders = DEMO_SEED_NOTEBOOK_IDS.map(() => "?").join(", ");
+ const resourceRows = await db.prepare(`SELECT object_key FROM resources`).all<{ object_key: string }>();
+ const objectKeys = resourceRows.results.map((resource) => resource.object_key);
+
+ for (let index = 0; index < objectKeys.length; index += 1000) {
+ await env.RESOURCES.delete(objectKeys.slice(index, index + 1000));
+ }
+
+ await db.batch([
+ db.prepare(`DELETE FROM memos_fts`),
+ db.prepare(`DELETE FROM resources`),
+ db.prepare(`DELETE FROM memo_revisions`),
+ db.prepare(`DELETE FROM memo_contents WHERE memo_id NOT IN (${memoPlaceholders})`).bind(...DEMO_SEED_MEMO_IDS),
+ db.prepare(`DELETE FROM memos WHERE id NOT IN (${memoPlaceholders})`).bind(...DEMO_SEED_MEMO_IDS),
+ db.prepare(`UPDATE notebooks SET parent_id = NULL`),
+ db.prepare(`DELETE FROM notebooks WHERE id NOT IN (${notebookPlaceholders})`).bind(...DEMO_SEED_NOTEBOOK_IDS),
+ db.prepare(`DELETE FROM api_tokens`),
+ db.prepare(`DELETE FROM audit_events`),
+ ]);
+
+ await ensureDemoSeed(db);
+ await audit(db, "system", null, "demo.reset", "demo", "edgeever-demo", {
+ scheduledTime: new Date(scheduledTime).toISOString(),
+ seedMemoCount: DEMO_SEED_MEMOS.length,
+ });
+};
+
const moveMemosToNotebook = async (
db: D1Database,
memoIds: string[],
diff --git a/apps/web/src/components/LoginScreen.tsx b/apps/web/src/components/LoginScreen.tsx
index c73dee7b..3920fb0d 100644
--- a/apps/web/src/components/LoginScreen.tsx
+++ b/apps/web/src/components/LoginScreen.tsx
@@ -10,9 +10,21 @@ interface LoginScreenProps {
onSubmit: (payload: { username: string; password: string }) => void;
}
+const DEMO_LOGIN_CREDENTIALS = {
+ username: "ee-demo",
+ password: "demo#dZ6Q29Zjfor%",
+};
+
+const getDefaultLoginCredentials = () => {
+ const hostname = window.location.hostname;
+ const isDemoHost = hostname === "demo.edgeever.org" || hostname.startsWith("edgeever-demo.");
+
+ return isDemoHost ? DEMO_LOGIN_CREDENTIALS : { username: "admin", password: "" };
+};
+
export const LoginScreen = ({ error, isSubmitting, onSubmit }: LoginScreenProps) => {
- const [username, setUsername] = useState("admin");
- const [password, setPassword] = useState("");
+ const [username, setUsername] = useState(() => getDefaultLoginCredentials().username);
+ const [password, setPassword] = useState(() => getDefaultLoginCredentials().password);
const handleSubmit = (event: FormEvent<HTMLFormElement>) => {
event.preventDefault();
diff --git a/scripts/cloudflare-deploy.mjs b/scripts/cloudflare-deploy.mjs
index 7efe81db..4fa1abc1 100644
--- a/scripts/cloudflare-deploy.mjs
+++ b/scripts/cloudflare-deploy.mjs
@@ -65,7 +65,7 @@ const readEnv = () => {
};
const scopedKey = (name, values) => {
- const instance = (values.get("EDGE_EVER_INSTANCE") || process.env.EDGE_EVER_INSTANCE || "")
+ const instance = (process.env.EDGE_EVER_INSTANCE || values.get("EDGE_EVER_INSTANCE") || "")
.trim()
.replace(/[^a-zA-Z0-9]/g, "_")
.toUpperCase();
@@ -249,6 +249,14 @@ const doctor = () => {
check("R2 bucket name", Boolean(envValue("R2_BUCKET_NAME", values)), envValue("R2_BUCKET_NAME", values) || "missing") &&
passed;
+ const demoMode = envValue("DEMO_MODE", values).toLowerCase();
+ passed =
+ check(
+ "demo mode",
+ !demoMode || ["true", "false"].includes(demoMode),
+ demoMode === "true" ? "enabled, daily reset cron will be generated" : "disabled",
+ ) && passed;
+
const passwordHash = envValue("AUTH_PASSWORD_HASH", values);
passed =
check(
diff --git a/scripts/run-wrangler.mjs b/scripts/run-wrangler.mjs
index 6870f068..3275c241 100644
--- a/scripts/run-wrangler.mjs
+++ b/scripts/run-wrangler.mjs
@@ -123,6 +123,7 @@ const runtimeVars = {
EDGE_EVER_AUTH_USERNAME: envValue("AUTH_USERNAME"),
EDGE_EVER_SESSION_TTL_DAYS: envValue("SESSION_TTL_DAYS"),
EDGE_EVER_R2_BUCKET_NAME: envValue("R2_BUCKET_NAME"),
+ EDGE_EVER_DEMO_MODE: envValue("DEMO_MODE"),
};
const runtimeVarLines = Object.entries(runtimeVars)
.filter(([, value]) => Boolean(value))
@@ -137,6 +138,21 @@ ${runtimeVarLines.join("\n")}
`;
}
+const demoMode = envValue("DEMO_MODE")?.toLowerCase();
+if (demoMode && !["true", "false"].includes(demoMode)) {
+ throw new Error("EDGE_EVER_DEMO_MODE must be true or false.");
+}
+
+if (demoMode === "true") {
+ const demoResetCron = envValue("DEMO_RESET_CRON") || "0 19 * * *";
+ changed = true;
+ config = `${config.trimEnd()}
+
+[triggers]
+crons = [${tomlString(demoResetCron)}]
+`;
+}
+
const customDomain = envValue("CUSTOM_DOMAIN");
const routePattern = envValue("ROUTE_PATTERN") || customDomain;
if (routePattern) {