Skip to content

code2rich/jpage

Repository files navigation

即页

拖入文件,即刻成页。

>>> 查看即页产品介绍 <<<

即页是一个零配置的 HTML / Markdown 即时预览与分享工具。把写好的文档拖进来,立刻获得一个干净的在线页面——无需部署流程,无需服务器知识。特别适合 AI 生成内容的一键分享。


功能特性

核心能力

  • 即时预览 — 上传 HTML 或 Markdown 文件,秒级生成在线渲染页面
  • Markdown 增强渲染 — 代码高亮(highlight.js)、数学公式(KaTeX)、Mermaid 图表,深色/浅色主题自动切换
  • 源码查看 — 渲染 / 源码双模式切换,方便对照
  • 短链接 — 每个文件自动生成 8 位短链(/s/xxxxxxxx),分享更简洁
  • 文件管理 — 重命名、删除、下载、公开/私有切换,操作简单直观
  • 拖拽上传 — 支持点击选择和拖拽两种方式,单文件最大 50MB
  • 版本历史 — 覆盖上传自动保留历史版本,可随时回滚
  • 响应式设计 — 桌面端与移动端自适应,深色模式自动跟随系统

组织与发现

  • 标签系统 — 为文件打标签,多维度分类检索
  • 分类管理 — 创建分类归属文件,层级清晰
  • 收藏功能 — 一键收藏常用文件,快速访问

安全与权限

  • 多用户支持 — admin 可创建和管理多个用户,普通用户只能访问自己的文件和公开文件
  • 会话鉴权 — Cookie + bcrypt 密码哈希
  • API Token — 每用户可创建多个 API Token,适合脚本和 AI 工具调用
  • 公开/私有文件 — 上传时可选是否公开,私有文件仅文件所有者和 admin 可访问
  • API 限流 — 登录和上传接口均有频率限制,防止暴力破解和滥用

AI 集成

  • MCP 协议支持 — 内置 MCP Streamable HTTP 端点,AI 工具可直接调用
  • Skills 管理 — 自动发现 skills/ 目录下的 Claude Code/Desktop 技能包
  • JSON 上传接口/api/files/upload-json 支持程序化上传,适合 AI 工作流

部署

  • 零依赖运行 — 单容器即可启动,SQLite 内置存储
  • Docker 一键部署 — 多阶段构建,环境变量配置,数据卷持久化
  • 数据库迁移 — 自动执行 schema 迁移,升级无需手动操作

技术栈

  • 后端: Node.js + Express + express-session(SQLite 会话存储)
  • 数据库: SQLite3(零配置,自动迁移)
  • 前端: 原生 JavaScript(无框架依赖)
  • 渲染: marked.js + highlight.js + KaTeX + Mermaid
  • 协议: MCP Streamable HTTP(@modelcontextprotocol/sdk)
  • 容器: Docker / Docker Compose

快速开始

Docker 部署(推荐)

git clone https://github.com/code2rich/jpage.git
cd jpage
cp .env.example .env       # 编辑 .env 填入 ADMIN_PASSWORD 和 SESSION_SECRET
docker-compose up -d

访问 http://localhost:8858,浏览器会跳到登录页。

本地运行

npm install
ADMIN_USER=admin ADMIN_PASSWORD=test1234 SESSION_SECRET=dev-secret npm start

开发模式(热重载):

npm run dev

鉴权与安全

即页支持多用户体系。admin 可管理全部用户和文件,普通用户只能操作自己的文件和公开文件。分享链接(/api/files/:id/render/s/:key、下载、源码)在文件标记为公开时可匿名访问;上传时取消勾选「公开访问」可让该文件仅所有者和 admin 可见。

认证方式

API 和 MCP 端点支持三种认证方式:

  1. Session Cookie — 登录后获得 jpage.sid,适合浏览器访问
  2. API Token — 用户在设置中创建 jp_ 前缀的 Token,适合脚本调用
  3. MCP Token — 环境变量 MCP_TOKEN,适合 AI 工具连接(向后兼容)

环境变量

变量 必填 说明
ADMIN_USER 首次启动、users 表为空时使用的管理员用户名;留空默认 admin
ADMIN_PASSWORD 首次启动、users 表为空时使用的管理员密码(≥8 位);留空则自动生成 16 位随机密码并打到启动日志
SESSION_SECRET 生产必填 加密会话 Cookie;缺失时开发模式自动生成临时密钥,重启会失效
NODE_ENV production 时 Cookie 仅 HTTPS 下发送,SESSION_SECRET 缺失会拒绝启动
PORT 默认 8858
MCP_TOKEN 启用 /mcp 端点的 Bearer token;未设置时 MCP 端点不挂载

如果 ADMIN_USERADMIN_PASSWORD 都留空启动,启动日志会输出:

[即页] 已创建初始管理员: admin
[即页] 初始密码(请妥善保存): 7Hk2mN9pq4rTv8wX
[即页] ⚠️  首次登录后请立即修改密码

复制日志里的密码登录即可。

SESSION_SECRET 推荐生成方式:

node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

重置或修改密码

所有用户登录后可在设置中修改密码。admin 可在用户管理中重置其他用户密码。

手动方式(SQLite 命令行):

node -e "console.log(require('bcryptjs').hashSync('新密码', 10))"
sqlite3 data/database.sqlite "UPDATE users SET password_hash='<上面生成的hash>' WHERE username='admin';"

项目结构

jpage/
├── server.js           # Express 服务端(REST API + 鉴权 + Markdown 渲染)
├── logger.js           # 结构化 JSON Lines 日志工具
├── mcp-server.js       # MCP Streamable HTTP 端点(/mcp)
├── migrations.js       # 数据库迁移 runner
├── migrations/         # 按序执行的 schema 迁移文件
├── skills-registry.js  # 扫描 skills/ 目录,提供 skill 列表/详情/zip 打包
├── package.json
├── Dockerfile
├── docker-compose.yml
├── .env.example        # 环境变量示例
├── .mcp.json           # MCP 客户端配置示例
├── docs/
│   ├── api.md          # REST API 完整参考
│   └── design/         # 设计文档
├── skills/
│   └── jpage-upload/   # Claude Code / Desktop skill
│       └── SKILL.md
├── data/               # SQLite 数据库、上传文件与会话存储(运行时自动创建)
│   ├── database.sqlite
│   ├── sessions.sqlite
│   └── uploads/
└── public/             # 前端静态资源
    ├── index.html
    ├── css/style.css
    └── js/app.js

REST API

端口 8858PORT 可覆盖)。所有写入端点要求登录或 Bearer token。

鉴权

端点 方法 说明
/api/auth/me GET 当前登录信息
/api/auth/login POST 登录({username, password}
/api/auth/logout POST 登出
/api/auth/change-password POST 修改密码(所有用户可用)

用户管理(仅 admin)

端点 方法 说明
/api/users GET 列出所有用户
/api/users POST 创建用户
/api/users/:id PUT 更新角色或重置密码
/api/users/:id DELETE 删除用户,文件转交 admin

API Token

端点 方法 说明
/api/tokens GET 列出自己的 Token
/api/tokens POST 创建 Token(明文仅返回一次)
/api/tokens/:id DELETE 删除 Token

文件管理

端点 方法 说明
/api/files GET 列出文件(admin 看全部,普通用户看自己的 + 公开的)
/api/files/upload POST multipart 上传
/api/files/upload-json POST JSON 上传({name, content, isPublic?}
/api/files/:id PUT 重命名或切换公开/私有
/api/files/:id DELETE 删除文件
/api/files/:id/content GET 返回原始文本
/api/files/:id/render GET 返回渲染后 HTML
/api/files/:id/download GET 流式下载文件
/s/:key GET 短链接渲染页面

标签

端点 方法 说明
/api/tags GET 列出所有标签(含 file_count)
/api/tags POST 创建标签
/api/tags/:id DELETE 删除标签
/api/files/:id/tags PUT 替换文件的标签列表

收藏

端点 方法 说明
/api/files/:id/star POST 收藏文件
/api/files/:id/star DELETE 取消收藏

分类

端点 方法 说明
/api/categories GET 列出分类(含 file_count)
/api/categories POST 创建分类
/api/categories/:id PUT 重命名分类
/api/categories/:id DELETE 删除分类
/api/files/:id/category PUT 设置文件分类

Skills

端点 方法 说明
/api/skills GET 列出已安装的 skill 包
/api/skills/:name GET skill 详情
/api/skills/:name/download GET ZIP 下载整个 skill 目录

完整 API 文档见 docs/api.md

MCP / AI 集成

即页内置 MCP Streamable HTTP 端点,让 Claude Code、Claude Desktop 等 AI 工具能够直接上传、管理文件。

启用

设置 MCP_TOKEN 环境变量即可启用:

MCP_TOKEN=your-secret-token

客户端配置

Claude Code — 把以下配置放到项目根 .mcp.json 或合并到 ~/.claude.json

{
  "mcpServers": {
    "jpage": {
      "type": "http",
      "url": "http://localhost:8858/mcp",
      "headers": {
        "Authorization": "Bearer ${env.MCP_TOKEN}"
      }
    }
  }
}

Claude Desktop — 把 mcpServers 块合并到 ~/Library/Application Support/Claude/claude_desktop_config.json

能力

Tools(15 个):

工具 用途
upload_file 上传 HTML 或 Markdown,返回预览链接
list_files 列出所有文件
get_file_content 读取文件原文
get_file_url 获取文件预览 URL
rename_file 重命名文件
delete_file 删除文件
list_file_versions 查看文件版本历史
restore_file_version 回滚到指定版本
list_tags 列出标签
add_tags_to_file 为文件添加标签
star_file 收藏文件
unstar_file 取消收藏
list_categories 列出分类
create_category 创建分类
set_file_category 设置文件分类

Resources(2 个):

URI 说明
jpage://files 所有文件元数据(JSON 列表)
jpage://file/{id} 单文件正文(≤ 256KB)

配套 Skill

仓库内 skills/jpage-upload/SKILL.md 是 Claude Code / Desktop 的开箱即用技能。安装后,AI 生成 HTML、Markdown、报告、可视化等内容时会自动上传到即页并返回预览链接。

ln -s "$(pwd)/skills/jpage-upload" ~/.claude/skills/jpage-upload

Web 管理

登录后首页底部有 AI 技能 (Skills) 区块,可查看详情、下载 zip 包。新增 Skill 只需在 skills/<name>/SKILL.md 编写 frontmatter,重启服务即可自动发现。

调试

npx -y @modelcontextprotocol/inspector http://localhost:8858/mcp

使用场景

  • AI 生成内容分享 — Claude Code、Cursor 等工具生成的 HTML 报告、可视化页面,一键上传获得可分享链接
  • 技术文档协作 — Markdown 笔记、会议纪要、项目报告,上传后自动渲染代码高亮、数学公式、流程图
  • 静态页面托管 — 单页 HTML Demo、原型、落地页,无需配置服务器
  • 临时文件分享 — 任何 HTML/Markdown 文件,拖入即得链接,无需注册账号
  • 版本管理 — 迭代更新的文档自动保留历史版本,随时回滚

为什么做这个

现有的方案要么太重(需要配置服务器、域名、CI),要么太封闭(绑定特定平台)。

即页只想做一件事:让静态内容的分享回归简单。拖入文件,得到一个链接。没有账户体系,没有学习成本,打开即用。

协议

MIT

About

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors