Lumen自托管部署教程10分钟用Vercel发布你的专属笔记实例含GitHub OAuth配置【免费下载链接】lumenA free, open-source note-taking app that syncs with markdown files in your GitHub repository项目地址: https://gitcode.com/gh_mirrors/lumen1/lumenLumen是一款免费、开源的笔记应用它的笔记以 Markdown 文件形式同步到你自己的 GitHub 仓库中数据完全由你掌控。本文带你完成Lumen 自托管部署在 10 分钟内用 Vercel 发布一个专属笔记实例并手把手配置GitHub OAuth实现一键登录与仓库同步。为什么选择 Lumen在部署之前先花 30 秒了解它能给你带来什么纯 Markdown无锁定的纯文本格式任意编辑器都能打开GitHub 双向同步基于 isomorphic-git在浏览器中完成克隆、编辑、推送Wiki 链接 / 标签 / 模板支持[[wikilink]]内链、标签聚合与模板变量AI 语音助手可接入 OpenAI 进行语音对话PWA 离线支持移动端可安装到主屏使用核心特性一览可在 README.md 中找到。准备工作清单 开始 Lumen 自托管部署前请确认已准备好准备项说明Vercel 账号免费额度即可支撑个人部署Git 账号用于存放 Markdown 笔记的私有仓库OAuth App在 Git 平台的 Settings → Developer settings 中创建本地环境可选Node.js npm用于本地预览第一步获取 Lumen 代码克隆代码仓库仓库地址如下git clone https://gitcode.com/gh_mirrors/lumen1/lumen cd lumen npm install 安装完成后会自动执行patch-package见 package.json 的postinstall脚本无需手动处理补丁文件 decode-named-character-reference1.0.2.patch。本地快速体验开发模式下用个人访问令牌登录跳过 OAuth# 在根目录创建 .env.local # VITE_GITHUB_PAT你的个人访问令牌 npm run dev:vercel然后访问http://localhost:8888。相关说明见 CONTRIBUTING.md。第二步用 Vercel 发布部署在 Vercel 中Add New → Project导入上一步克隆的仓库框架自动识别为Vite构建命令保持默认npm run build在项目Settings → Environment Variables中添加两个变量VITE_GITHUB_CLIENT_IDOAuth App 的 Client IDGITHUB_CLIENT_SECRETOAuth App 的 Client Secret点击Deploy约 1~2 分钟后即可访问你的专属笔记实例 为什么只需要两个变量登录回调由服务端函数 api/github-auth.ts 处理它用 Client ID Secret 换取 access tokenSecret 只存在于服务端不会暴露给浏览器。路由与代理是怎么配的无需手动配置vercel.json 已预置所有重写规则把/github-auth、/cors-proxy、/file-proxy等路径代理到api/目录下的函数如 api/cors-proxy.ts、api/share/[...path].ts。其中/cors-proxy负责绕过浏览器跨域限制让 isomorphic-git 能直连 API 完成仓库读写。第三步配置 GitHub OAuth关键这是自托管部署中最容易踩坑的一步请按以下步骤操作登录 Git 平台 →Settings → Developer settings → OAuth Apps → New OAuth AppApplication URL填写你的 Vercel 域名如https://lumen.example.comAuthorization callback URL填写https://lumen.example.com/github-auth⚠️ 必须与域名完全一致否则登录会报redirect_uri错误保存后复制Client ID和Client Secret填入 Vercel 环境变量重新部署一次使环境变量生效前端登录按钮会请求repo,gist,user:email三个权限scope发起逻辑在 src/components/github-auth.tsx。⚠️邮箱提示OAuth 流程要求账号至少有一个公开的邮箱否则会提示 No public email found。请在账号邮箱设置中取消隐藏至少一个邮箱见 api/github-auth.ts 中的校验逻辑。首次使用为实例选择一个笔记仓库部署完成后打开你的实例并点击Sign in with GitHub授权通过后会出现仓库选择表单组件源码src/components/repo-form.tsxSelect an existing repository直接挂载已有的 Markdown 仓库Create a new repository一键基于官方模板生成全新的私有笔记仓库之后所有笔记都会作为.md文件写回仓库包含 frontmatter 元数据格式定义见 docs/metadata.md你可以随时用任意编辑器离线修改。常见问题排查 ️现象解决方法登录跳转报redirect_uri mismatch回调地址必须是https://你的域名/github-auth且协议、域名完全一致No public email found在邮箱设置中公开一个邮箱仓库无法拉取确认 OAuth 授权时勾选了repo权限私有仓库需重新授权部署后接口 404检查 Vercel 是否识别了api/目录确认构建框架为 Vercel/Other写在最后至此你已完成一次完整的Lumen 自托管部署一个只属于你或你的小团队的 Markdown 笔记实例已上线笔记数据以纯文本形式存放在自己的仓库里——这才是数据自由的终极形态。更多进阶内容可以参考查询语法docs/query-language.md模板变量用法docs/templates.md键盘快捷键速查docs/keyboard-shortcuts.md【免费下载链接】lumenA free, open-source note-taking app that syncs with markdown files in your GitHub repository项目地址: https://gitcode.com/gh_mirrors/lumen1/lumen创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Lumen自托管部署教程：10分钟用Vercel发布你的专属笔记实例（含GitHub OAuth配置）
Lumen自托管部署教程10分钟用Vercel发布你的专属笔记实例含GitHub OAuth配置【免费下载链接】lumenA free, open-source note-taking app that syncs with markdown files in your GitHub repository项目地址: https://gitcode.com/gh_mirrors/lumen1/lumenLumen是一款免费、开源的笔记应用它的笔记以 Markdown 文件形式同步到你自己的 GitHub 仓库中数据完全由你掌控。本文带你完成Lumen 自托管部署在 10 分钟内用 Vercel 发布一个专属笔记实例并手把手配置GitHub OAuth实现一键登录与仓库同步。为什么选择 Lumen在部署之前先花 30 秒了解它能给你带来什么纯 Markdown无锁定的纯文本格式任意编辑器都能打开GitHub 双向同步基于 isomorphic-git在浏览器中完成克隆、编辑、推送Wiki 链接 / 标签 / 模板支持[[wikilink]]内链、标签聚合与模板变量AI 语音助手可接入 OpenAI 进行语音对话PWA 离线支持移动端可安装到主屏使用核心特性一览可在 README.md 中找到。准备工作清单 开始 Lumen 自托管部署前请确认已准备好准备项说明Vercel 账号免费额度即可支撑个人部署Git 账号用于存放 Markdown 笔记的私有仓库OAuth App在 Git 平台的 Settings → Developer settings 中创建本地环境可选Node.js npm用于本地预览第一步获取 Lumen 代码克隆代码仓库仓库地址如下git clone https://gitcode.com/gh_mirrors/lumen1/lumen cd lumen npm install 安装完成后会自动执行patch-package见 package.json 的postinstall脚本无需手动处理补丁文件 decode-named-character-reference1.0.2.patch。本地快速体验开发模式下用个人访问令牌登录跳过 OAuth# 在根目录创建 .env.local # VITE_GITHUB_PAT你的个人访问令牌 npm run dev:vercel然后访问http://localhost:8888。相关说明见 CONTRIBUTING.md。第二步用 Vercel 发布部署在 Vercel 中Add New → Project导入上一步克隆的仓库框架自动识别为Vite构建命令保持默认npm run build在项目Settings → Environment Variables中添加两个变量VITE_GITHUB_CLIENT_IDOAuth App 的 Client IDGITHUB_CLIENT_SECRETOAuth App 的 Client Secret点击Deploy约 1~2 分钟后即可访问你的专属笔记实例 为什么只需要两个变量登录回调由服务端函数 api/github-auth.ts 处理它用 Client ID Secret 换取 access tokenSecret 只存在于服务端不会暴露给浏览器。路由与代理是怎么配的无需手动配置vercel.json 已预置所有重写规则把/github-auth、/cors-proxy、/file-proxy等路径代理到api/目录下的函数如 api/cors-proxy.ts、api/share/[...path].ts。其中/cors-proxy负责绕过浏览器跨域限制让 isomorphic-git 能直连 API 完成仓库读写。第三步配置 GitHub OAuth关键这是自托管部署中最容易踩坑的一步请按以下步骤操作登录 Git 平台 →Settings → Developer settings → OAuth Apps → New OAuth AppApplication URL填写你的 Vercel 域名如https://lumen.example.comAuthorization callback URL填写https://lumen.example.com/github-auth⚠️ 必须与域名完全一致否则登录会报redirect_uri错误保存后复制Client ID和Client Secret填入 Vercel 环境变量重新部署一次使环境变量生效前端登录按钮会请求repo,gist,user:email三个权限scope发起逻辑在 src/components/github-auth.tsx。⚠️邮箱提示OAuth 流程要求账号至少有一个公开的邮箱否则会提示 No public email found。请在账号邮箱设置中取消隐藏至少一个邮箱见 api/github-auth.ts 中的校验逻辑。首次使用为实例选择一个笔记仓库部署完成后打开你的实例并点击Sign in with GitHub授权通过后会出现仓库选择表单组件源码src/components/repo-form.tsxSelect an existing repository直接挂载已有的 Markdown 仓库Create a new repository一键基于官方模板生成全新的私有笔记仓库之后所有笔记都会作为.md文件写回仓库包含 frontmatter 元数据格式定义见 docs/metadata.md你可以随时用任意编辑器离线修改。常见问题排查 ️现象解决方法登录跳转报redirect_uri mismatch回调地址必须是https://你的域名/github-auth且协议、域名完全一致No public email found在邮箱设置中公开一个邮箱仓库无法拉取确认 OAuth 授权时勾选了repo权限私有仓库需重新授权部署后接口 404检查 Vercel 是否识别了api/目录确认构建框架为 Vercel/Other写在最后至此你已完成一次完整的Lumen 自托管部署一个只属于你或你的小团队的 Markdown 笔记实例已上线笔记数据以纯文本形式存放在自己的仓库里——这才是数据自由的终极形态。更多进阶内容可以参考查询语法docs/query-language.md模板变量用法docs/templates.md键盘快捷键速查docs/keyboard-shortcuts.md【免费下载链接】lumenA free, open-source note-taking app that syncs with markdown files in your GitHub repository项目地址: https://gitcode.com/gh_mirrors/lumen1/lumen创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考