open-terminal

环境要求

• 已安装 Docker（推荐用 Docker 方式运行）
• 本机 8000 端口未被占用
• 若走裸机方式：已安装 Python，并可用 pip 或 uvx
• 准备好一个自定义 API 密钥（可选，不设置会自动生成）

安装与启动步骤

1. 1启动 Docker 容器

   用官方镜像一键拉起服务，挂载 open-terminal 数据卷持久化 /home/user，并通过环境变量设置 API 密钥。

   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

   复制

2. 2获取自动生成的密钥

   如果启动时没有设置 OPEN_TERMINAL_API_KEY，系统会自动生成一个，可从容器日志中读取。

   docker logs open-terminal

   复制

3. 3访问服务验证

   服务默认监听 8000 端口，浏览器或 curl 访问 http://localhost:8000 即可看到接口响应。

   curl http://localhost:8000

   复制

4. 4按需安装额外软件包

   通过环境变量在容器启动时安装 apt / pip / npm 包，包多会拖慢启动速度，重度定制建议自建镜像。

   docker run -d --name open-terminal -p 8000:8000 \
     -e OPEN_TERMINAL_PACKAGES="cowsay figlet" \
     -e OPEN_TERMINAL_PIP_PACKAGES="httpx polars" \
     -e OPEN_TERMINAL_NPM_PACKAGES="typescript tsx" \
     ghcr.io/open-webui/open-terminal

   复制

5. 5裸机方式运行（可选）

   不装 Docker 时可用 uvx 免安装运行，或用 pip 全局安装后启动。注意命令会直接以你的用户权限在真机执行。

   uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key

   复制

6. 6使用自定义配置文件

   除环境变量和命令行参数外，还可以通过 TOML 配置文件启动，并用 --config 指定具体文件路径。

   open-terminal run --config /path/to/my-config.toml

   复制

关键配置

如何确认成功

浏览器或 curl 访问 http://localhost:8000 有响应；执行 docker logs open-terminal 能看到启动信息和 API 密钥。

常见问题

注意事项

• 裸机（pip/uvx）方式下命令直接以你的用户权限在真机执行，存在风险，建议优先使用 Docker 沙箱。
• 挂载 Docker socket 会让容器获得宿主机的等效 root 权限，只应在完全信任的环境中使用。
• 通过环境变量安装软件包会在每次容器启动时重复执行，包列表较大时启动会明显变慢。
• 建议把 api_key 写到用户配置文件而非命令行参数，避免密钥出现在 ps / htop 输出中。