安装
根据你的需求选择安装方式:
| 方式 | 适用场景 |
|---|---|
| Docker | 在隔离容器中运行,与宿主系统完全分离。 |
| 裸机 | AI 直接在你的机器上工作——使用真实的文件、工具和环境。 |
| Docker Compose | 你已在使用 Docker Compose 运行 Open WebUI,并希望将 Open Terminal 添加进去。 |
在下方选择你的方式,然后按步骤操作。
- Docker
- 裸机
- Docker Compose
需要安装 Docker。
1. 启动容器
docker run -d \
--name open-terminal \
--restart unless-stopped \
-p 8000:8000 \
-v open-terminal:/home/user \
-e OPEN_TERMINAL_API_KEY=your-secret-key \
ghcr.io/open-webui/open-terminal将 your-secret-key 替换为你自己的密码。
参数说明
| 参数 | 用途 |
|---|---|
-d | 在后台运行 |
--name open-terminal | 容器名称,便于引用 |
--restart unless-stopped | 重启时自动启动 |
-p 8000:8000 | 在 http://localhost:8000 暴露服务 |
-v open-terminal:/home/user | 在重启间保持文件持久化 |
-e OPEN_TERMINAL_API_KEY=... | 认证密钥 |
2. 验证
在浏览器中打开 http://localhost:8000/docs,你应该能看到 Open Terminal API 页面。
自动生成的 API Key
如果未设置 API Key,系统会自动生成一个。通过以下命令查看:
docker logs open-terminal注意
在此模式下,AI 能执行你用户账户权限范围内的任何操作,包括修改和删除文件。
1. 运行 Open Terminal
方式 A — 免安装直接运行:
uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key通过 uv 下载并运行,无需永久安装。
方式 B — 通过 pip 安装:
pip install open-terminal
open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key2. 工作目录
Open Terminal 从当前目录提供文件服务。若要将其限定在特定项目:
cd /path/to/your/project
uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-keyWindows
通过 pywinpty 支持 Windows。完整支持 PowerShell,包括彩色输出和交互式程序。
在你现有的 docker-compose.yml 中添加 Open Terminal 服务:
1. 更新 Compose 文件
services:
open-webui:
image: ghcr.io/open-webui/open-webui:latest
container_name: open-webui
ports:
- "3000:8080"
volumes:
- open-webui:/app/backend/data
open-terminal:
image: ghcr.io/open-webui/open-terminal
container_name: open-terminal
volumes:
- open-terminal:/home/user
environment:
- OPEN_TERMINAL_API_KEY=your-secret-key
volumes:
open-webui:
open-terminal:2. 启动服务
docker compose up -d连接 URL
当两个服务共享同一个 Docker Compose 网络时,使用服务名称作为主机:
http://open-terminal:8000
localhost 在容器之间无法解析。
下一步
想要一整台机器?
cptr(Open WebUI Computer)将你的整台电脑放进一个浏览器标签页:文件、终端、git、编辑器和 AI 触手可及,从任何设备都能访问。它还可以通过其网关 API 连接到 Open WebUI。