Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 3.97 KB

usage.md

File metadata and controls

82 lines (49 loc) · 3.97 KB

使用文档

文件功能描述:说明 WebShare 的登录、项目发布、分享访问、版本管理和常见使用策略。

登录管理后台

启动服务后访问 http://localhost:8080/admin/。首次启动会创建管理员账号;如果没有提前设置密码,请查看服务日志或 Windows 托盘菜单中的管理员账号信息。

普通用户只能管理自己的项目。管理员可以额外管理用户和分享地址。

创建项目

在管理后台创建项目时,需要关注:

  • 项目名称:用于后台识别。
  • 访问标识:用于生成 /p/{slug}/ 分享地址。
  • 访问方式:根据页面资源路径选择分享网关、固定挂载路径或独立端口。

创建后可以继续上传静态页面产物并启用项目。

创建并发布项目

发布静态页面

WebShare 支持三种发布方式:

  • 单 HTML:适合大模型生成的单文件页面、演示页和临时原型。
  • 文件夹:适合本地已经构建好的前端产物目录。
  • ZIP:适合把构建产物打包后上传。

上传后系统会分析资源路径,并给出可能的访问风险提示。发布成功的版本可以被激活、回滚或重新发布。

发布完成后的项目概览

访问方式选择

WebShare 只识别 base URL,不改写 HTML、CSS、JS 或 manifest。选择访问方式时可以按下面规则判断:

页面资源特征 推荐访问方式 示例
相对路径资源 分享网关 http://host:8081/p/demo/
固定前缀资源,如 /demo/ 固定挂载路径 http://host:8081/demo/
根路径资源,如 /assets/app.js 独立端口 http://host:12001/
多个根路径前缀混用 独立端口优先 需要检查文件结构风险

如果页面中存在 fetch('/api')、service worker、manifest 或 JS 动态拼接路径,系统只做风险提示,不会自动代理或修复。

需要调整入口文件、挂载路径、分享状态或 SPA fallback 时,可以在项目的“设置”页修改并保存。

项目配置页面

分享项目

项目启用后,后台会生成访问地址。局域网内其他设备访问时需要满足:

  • 访问设备和运行 WebShare 的机器在同一网络内。
  • 运行机器的防火墙允许对应端口访问。
  • 分享地址中的主机 IP 是局域网可访问 IP。

管理员可以在“分享地址”页面检测本机 IP 候选地址,并选择生成访问地址时使用的主机。

版本与文件管理

每次发布会生成新版本。常见操作包括:

  • 激活指定版本。
  • 回滚到历史版本。
  • 固定重要版本,避免被历史版本自动清理。
  • 停用项目。
  • 浏览、编辑、下载或删除项目文件。

版本历史会自动控制数量:同一个项目超过 10 个未固定历史版本时,系统会按创建时间删除最旧的未固定版本。当前正在使用的版本不会被自动删除;已固定版本也不会被自动删除,并且不计入 10 个未固定历史版本额度。

需要长期保留的演示版、交付版或里程碑版本,建议在“版本”页点击“固定”。固定后版本行会显示“已固定”,之后可以点击“取消固定”让它重新参与自动清理。固定版本仍然可以手动删除,删除当前版本时系统会自动切换到最近的剩余版本;如果没有剩余版本,项目会变为没有当前版本的状态。

正式分享前,建议先用另一台局域网设备打开访问地址,确认资源路径、图片、脚本和样式都能正常加载。

下载项目 EXE

已发布项目可以在管理后台下载独立 EXE。运行该 EXE 后,会在本机启动 127.0.0.1 随机端口服务,并自动用默认浏览器打开页面。

该能力适合把某个静态页面单独发给他人离线查看。服务端需要提前准备 Windows 运行壳;容器镜像和 Windows 单 EXE 构建流程会自动处理该文件。