☰
如何5分钟快速部署Inkstone自托管笔记:Cloudflare Workers完整教程(R2/KV双模式)
2026/10/15 16:14:53 网站建设 项目流程

【免费下载链接】inkstone

A self-hosted Markdown notebook that runs entirely on Cloudflare Workers.

项目地址:https://gitcode.com/gh_mirrors/inksto/inkstone
点击查看免费下载

Inkstone 是一款自托管的 Markdown 笔记应用,完整运行在 Cloudflare Workers 上:笔记始终是纯 Markdown 文本,同时提供实时预览、D1 全文搜索、Wiki 双链与关系图谱、离线编辑、多设备同步、公开分享,以及 WebDAV/S3 异地备份。整站数据(数据库、附件、运行环境)完全由你自己掌控,从 Fork 仓库到打开线上地址,整个部署过程通常只需 5 分钟。

部署前 1 分钟:先搞懂 R2 与 KV 双模式 🤔

Inkstone 的附件与头像二进制存放在两种可选存储中,二者对应不同的部署配置:

对比项R2 模式(推荐)KV 模式
配置文件wrangler.tomlwrangler.kv.toml
附件绑定R2 桶inkstone-files(绑定名FILES)KV 命名空间FILES_KV
部署命令npm run deploynpm run deploy:kv
Workers AI 绑定含AI绑定,可开启语义/混合搜索不含 AI 绑定,使用关键词搜索
适用场景图片附件多、追求长期扩展轻量笔记、想配置更少

两种模式都固定使用 D1 数据库inkstone-db存放账号、笔记、版本与索引,并用 Durable Object 实现实时同步与凭据加密。绑定定义可参考 src/worker/env.ts。

💡 拿不准就选R2 模式:对象存储更适合大量图片附件,且自带 Workers AI 语义搜索能力。

一键部署步骤:Cloudflare 控制台 5 分钟上线

第 1 步:Fork 仓库将 Inkstone 仓库 Fork 到你自己的代码托管账号。

第 2 步:创建 Worker登录 Cloudflare 控制台,进入Workers & Pages,点击Create Worker / 创建,选择Continue with GitHub,然后选中你刚 Fork 的仓库。

第 3 步:填写构建与部署命令

  • 构建命令(Build command):npm run build
  • 部署命令(Deploy command):R2 模式填npm run deploy;KV 模式改成npm run deploy:kv

这两条脚本定义在 package.json 中,会自动完成类型检查、生产构建,再通过 Wrangler 按对应 wrangler 配置发布。

第 4 步:保存并等待部署完成,随后打开生成的 Workers 域名即可。

第 5 步:注册首个账号新账号会自动获得中文、英文两篇起始笔记,可以直接开始写作。

完整说明见中文文档 README_ZH.md。

命令行部署备选方案(wrangler CLI)

如果你习惯本地操作,也可以克隆仓库手动部署(需要 Node.js 24 以上,版本约束见 package.json):

git clone https://gitcode.com/gh_mirrors/inksto/inkstone cd inkstone npm ci wrangler login # 或设置 CLOUDFLARE_API_TOKEN 环境变量 npm run deploy # R2 模式;KV 模式执行 npm run deploy:kv

本地开发预览:3 条命令任选

不急着上线的话,可以先在本地跑起来(开发环境说明见 CONTRIBUTING.md):

命令用途
npm run dev启动本地 Worker + 前端,访问http://localhost:7712
npm run dev:kv使用 KV 附件配置启动本地环境
npm run dev:demo启动刷新即重置的纯前端体验版

部署后必做的 3 件事 ✅

  1. 配置异地备份:在设置中配置 WebDAV 或 S3 兼容存储,支持多目标、手动或定时备份;ZIP 备份与导出共用同一套可校验的 Markdown 快照。
  2. 给数据留一份当前备份:数据库升级通过带版本号、可重复执行的迁移自动完成,更新实例前建议先备份。
  3. 留意版本更新提醒:发现新的稳定版本时只有站长会收到提醒,不会打扰普通成员。

常见问题速查

Q:部署一直失败?先看构建日志,最常见原因是误改了构建/部署命令,或仓库不是最新的 Inkstone 分支。

Q:KV 和 R2 可以互换吗?属于不同绑定(FILES_KV与FILES),切换需按对应模式重新部署,迁移前务必备份附件。

Q:不想要 AI 语义搜索?直接选 KV 模式即可,系统会继续提供 D1 FTS5 关键词全文搜索(含中文索引)。

从 Fork 到上线只要 5 分钟,你的笔记数据从此真正属于你自己。

【免费下载链接】inkstone

A self-hosted Markdown notebook that runs entirely on Cloudflare Workers.

项目地址:https://gitcode.com/gh_mirrors/inksto/inkstone
点击查看免费下载

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询