browsh/browsh

Browsh Docker镜像文档

镜像概述和主要用途

Browsh是一款全交互式、实时且现代化的基于文本的浏览器，通过无头Firefox渲染网页内容，可在TTY终端或浏览器中显示。其核心价值在于解决低带宽网络环境下的Web浏览需求，允许用户通过SSH或MoSH连接远程服务器运行浏览器，大幅减少本地带宽消耗，同时支持现代HTML5和JavaScript功能，弥补了传统文本浏览器的功能局限。

核心功能和特性

• 现代Web技术支持：基于Firefox 63+引擎，完整支持HTML5、JavaScript及现代Web应用，突破传统文本浏览器功能限制
• 多终端渲染能力：可在TTY终端直接渲染，或通过浏览器客户端访问，终端模式无需额外专用客户端
• 低带宽优化传输：支持SSH/MoSH协议，利用MoSH的连接自动重连、差异屏幕更新等特性，最小化数据传输量
• 资源消耗转移：将浏览器运行负载转移至远程服务器，降低本地设备（如笔记本、树莓派）的CPU占用和电池消耗

使用场景和适用范围

• 低带宽网络环境：适用于3kbps等极端低带宽网络（如手机热点），通过服务器端加载网页，仅传输终端渲染结果
• 远程终端访问：CLI用户可通过SSH/MoSH直接在终端中浏览现代网页，无需VNC等图形化远程工具
• 资源受限设备：低功耗设备（如树莓派）或需延长续航的移动设备，将浏览器运行在市电供电的服务器端

安装与部署

Docker快速部署

直接拉取并运行官方Docker镜像（约230MB）：

bash
docker run --rm -it browsh/browsh

参数说明：--rm退出后自动清理容器，-it提供交互式终端环境

其他安装方式（参考）

• 二进制安装：从https://github.com/browsh-org/browsh/releases%E4%B8%8B%E8%BD%BD%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%EF%BC%88%E7%BA%A67MB%EF%BC%89%EF%BC%8C%E9%9C%80%E9%A2%84%E5%85%88%E5%AE%89%E8%A3%85Firefox 63及更高版本

使用方法

基本操作

大多数键盘按键和鼠标手势与桌面浏览器操作一致，包括：

• 方向键导航页面
• 鼠标点击链接/按钮
• 常用快捷键（如Ctrl+T新建标签页、Ctrl+W关闭标签页等）

完整文档

详细使用说明请查阅官方文档

开发与贡献指南

开发环境依赖

• 必备工具：NodeJS、Golang
• NodeJS推荐通过https://github.com/creationix/nvm%E5%AE%89%E8%A3%85%EF%BC%8C%E8%87%AA%E5%8A%A8%E5%8C%B9%E9%85%8D%E4%BB%93%E5%BA%93%60.nvmrc%60%E6%8C%87%E5%AE%9A%E7%89%88%E6%9C%AC
• Golang版本信息可参考仓库.travis.yml配置

依赖安装步骤

1. Web扩展依赖：在webext/目录执行npm install
2. CLI客户端依赖：
   • 安装dep：执行interfacer/contrib/setup_dep.sh
   • 在interfacer/目录执行dep ensure安装Go依赖

开发环境配置

推荐开发流程：

• Webpack监听代码变更：webpack --watch（自动重建Web扩展）
• 运行CLI客户端（复用现有Firefox）：go run ./interfacer/src/main.go --firefox.use-existing --debug
• 自动重载Web扩展：在webext/dist目录执行web-ext run --verbose（需Mozillaweb-ext工具）

系统环境指南

• Linux：参考https://github.com/browsh-org/browsh/blob/master/contrib/setup_linux_build_environment.md
• Windows：参考https://github.com/browsh-org/browsh/blob/master/contrib/setup_windows_build_environment.md
• macOS：参考https://github.com/browsh-org/browsh/blob/master/contrib/setup_mac_build_environment.md

版本构建与测试

构建发布版本

参考构建脚本interfacer/contrib/build_browsh.go，注意Web扩展需从Mozilla官方档案库下载官方.xpi文件（Mozilla限制同一版本号仅允许官方签名扩展）

测试命令

• Web扩展测试：webext/目录执行npm test
• CLI单元测试：interfacer/目录执行go test src/browsh/*.go
• CLI端到端测试：interfacer/目录执行go test test/tty/*.go
• HTTP服务测试：interfacer/目录执行go test test/http-server/*.go

社区与支持

开发交流：通过Gitter与社区连接，解决使用问题或参与贡献

许可证

GNU Lesser General Public License v2.1