steel-browser

环境要求

• 已安装 Docker（本地运行预构建镜像）
• 已安装 Docker Compose（使用 docker compose 方式启动时）
• 本机 3000 端口可用（API 与 UI 服务端口）
• 本机 9223 端口可用（控制台调试器端口）
• Mac Silicon（Apple 芯片）用户需指定 arm64 平台环境变量

安装与启动步骤

1. 1拉取并运行镜像

   README 推荐的最简单方式，一条命令启动预构建镜像，容器会同时跑起 API 与 UI 服务。

   docker run -p 3000:3000 -p 9223:9223 ghcr.io/steel-dev/steel-browser

   复制

2. 2Mac 芯片加平台参数

   Apple Silicon 用户需按 README 指定 linux/arm64，否则镜像可能无法在正确平台运行。

   DOCKER_DEFAULT_PLATFORM=linux/arm64 docker run -p 3000:3000 -p 9223:9223 ghcr.io/steel-dev/steel-browser

   复制

3. 3或用 compose 启动

   README 说明也可用 docker compose 把 API 和 UI 分开运行，需在含 docker-compose.yml 的仓库目录下执行。

   docker compose up

   复制

4. 4访问 UI 与接口

   服务起来后浏览器打开 UI 界面，接口文档在 /documentation，API 端点为 http://localhost:3000。

5. 5试用 REPL 示例

   README 提到可进入 repl 目录运行 start 脚本快速把玩接口，需要本地有 Node.js 环境。

   cd repl
   npm run start

   复制

6. 6贡献者开发模式

   本地改代码时改用开发版 compose，会从 api 与 ui 目录构建镜像，服务跑在 3000 与 5173 端口。

   docker compose -f docker-compose.dev.yml up --build

   复制

关键配置

如何确认成功

浏览器访问 http://localhost:3000/ui 能看到界面，访问 http://localhost:3000/documentation 能打开接口文档，即启动成功。

常见问题

注意事项

• README 未提供镜像构建的源码本地安装步骤，非 Docker 部署需参考官方文档与仓库其他文件。
• 9223 端口用于控制台调试器，如不需要可自行取舍端口映射。
• 开发模式默认使用 5173 端口跑 UI，和默认 3000 端口的部署方式不同。