Ngrok Preview

🔗 任务产出秒变手机预览

为本地任务产出生成临时 ngrok 预览链接并推送至 Telegram,实现移动端安全查看,任务结束后自动清理

收藏
3.6k
安装
1.3k
版本
1.0.2
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

ngrok-preview 是一个用于将本地生成的任务产出(图片、图表、文件等)快速转化为可在移动端查看的临时公开链接的实用工具。其核心流程为:收集任务专属产出 → 创建会话级临时链接 → 推送至 Telegram 并明确告知有效期 → 任务结束后自动或手动清理会话。

典型使用场景

  • AI 生成图像/图表后,用户需要在手机上查看效果
  • 临时演示本地文件,无需配置持久化托管
  • 快速分享任务产出,避免繁琐的文件传输步骤

命令行接口

通过 python3 scripts/ngrok_preview.py 提供子命令:

  • up: 创建预览会话,支持 --title--session-id--ttl-minutes--source 参数
  • down: 停止指定或最新会话,可配合 --delete-session-dir 清理
  • status: 列出活跃会话
  • cleanup: 批量清理过期会话

显著优点

1. 零配置快速分享:无需搭建服务器或配置域名,一条命令即可生成 HTTPS 公网链接
2. 移动端友好:链接针对手机查看优化,解决本地文件难以在移动设备访问的痛点

3. 会话级隔离:通过 session-id 将链接与特定任务绑定,避免不同任务产出混杂

4. 自动生命周期管理:支持 TTL 设置(默认 120 分钟)和显式清理,降低长期暴露风险

5. Telegram 原生集成:链接自动推送至对话上下文,附带有效期说明,体验完整闭环

潜在缺点与局限性

1. 依赖外部服务:核心功能依赖 ngrok 服务,存在第三方平台可用性和网络稳定性风险
2. Token 管理负担:需预配置 NGROK_AUTHTOKEN,在共享环境中存在凭证泄露隐患

3. 临时性限制:不适合需要长期访问的场景,TTL 到期后需重新生成

4. 带宽与并发隐性限制:免费 ngrok 套餐存在速率限制,高并发或大文件场景可能受限

5. 会话状态分散session-id 需人工维护,复杂工作流中可能产生孤立未清理会话

适合人群

  • 频繁使用 AI 工具生成可视化产出,需要即时移动端确认的设计师、分析师
  • 远程协作中需要快速共享本地文件片段的开发者、项目经理
  • 临时演示场景下不愿配置复杂托管方案的敏捷团队

常规风险

| 风险类型 | 说明 | 缓解措施 |
|---------|------|---------|
| 数据泄露 | 临时链接可能被截获或在过期前被意外分享 | 缩短 TTL、限制 `source` 范围为最小必要文件 |
| 凭证泄露 | ngrok token 硬编码或环境变量暴露 | 使用密钥管理工具,避免提交至版本控制 |
| 目录遍历 | `--source` 参数误配置为敏感根目录 | 强制校验路径白名单,禁止暴露工作区根目录 |
| 会话残留 | 异常退出导致 `down` 未执行,链接持续有效 | 结合 `cleanup` 定期任务和短 TTL 设计 |

建议生产环境启用 ngrok 企业版以获得 IP 白名单、自定义域名等增强安全能力。

Ngrok Preview 内容

references文件夹
scripts文件夹
手动下载zip · 9.1 kB
troubleshooting.mdtext/markdown
请选择文件