安装指南

根据您的需求选择最适合的安装方式：

方式	适用场景
Docker	运行在与您的宿主系统完全隔离的独立容器中。
裸机运行 (Bare Metal)	AI 将直接在您的机器上进行操作 —— 拥有您实际的文件、工具和环境。
Docker Compose	您已经在通过 Docker Compose 运行 Open WebUI，并希望将 Open Terminal 加入其中。

在下方选择您的安装方式，然后按照步骤操作。

Docker

需要安装 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 密钥

如果没有显式设置 API 密钥，系统将自动生成一个。您可以通过以下命令查看：

docker logs open-terminal

Bare Metal

警告

在此模式下，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-key

2. 工作目录

Open Terminal 会为当前所在的工作目录提供文件服务。若要限制在特定的项目中，请：

cd /path/to/your/project
uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key

Windows

通过 pywinpty 得到良好支持。具有彩色输出以及支持交互式程序的完整 PowerShell 支持。

Docker Compose

在您现有的 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 是无法解析互通的。

---

下一步

连接到 Open WebUI →