配置参考

Open Terminal 开箱即用，带有合理的默认设置。如果您需要进行自定义，本页涵盖了所有您可以修改的设置。

设置按以下顺序应用（后者的设置将覆盖前者的设置）：

1. 内置默认值
2. 系统配置文件（/etc/open-terminal/config.toml）
3. 用户配置文件（~/.config/open-terminal/config.toml）
4. 环境变量（OPEN_TERMINAL_*）
5. CLI 参数（--host、--port 等）

---

所有设置

设置	默认值	环境变量	描述
Host	0.0.0.0	—	监听的网络地址
Port	8000	—	端口号
API Key	自动生成	OPEN_TERMINAL_API_KEY	用于连接的密码
API Key File	—	OPEN_TERMINAL_API_KEY_FILE	从文件中加载密钥（适用于 Docker secrets）
Log Directory	~/.local/state/open-terminal/logs	OPEN_TERMINAL_LOG_DIR	日志文件的保存位置
Max Sessions	16	OPEN_TERMINAL_MAX_SESSIONS	最大并发终端会话数
Enable Terminal	true	OPEN_TERMINAL_ENABLE_TERMINAL	开启/关闭交互式终端
Enable Notebooks	true	OPEN_TERMINAL_ENABLE_NOTEBOOKS	开启/关闭 Jupyter notebook 执行
TERM	xterm-256color	OPEN_TERMINAL_TERM	终端颜色支持
Execute Timeout	未设置	OPEN_TERMINAL_EXECUTE_TIMEOUT	等待命令输出的超时时间（秒）
Execute Description	—	OPEN_TERMINAL_EXECUTE_DESCRIPTION	向 AI 告知已安装工具的自定义文本
Multi-User	false	OPEN_TERMINAL_MULTI_USER	启用 每用户隔离
CORS Origins	—	OPEN_TERMINAL_CORS_ALLOWED_ORIGINS	允许的跨域（CORS）域名
Allowed Domains	—	OPEN_TERMINAL_ALLOWED_DOMAINS	出口防火墙：仅允许向这些域名发起出站连接

---

仅限 Docker 的设置

以下设置仅适用于 Docker 镜像：

设置	环境变量	描述
System Packages	OPEN_TERMINAL_PACKAGES	启动时需要安装的以空格分隔的系统软件包列表
Python Packages	OPEN_TERMINAL_PIP_PACKAGES	启动时需要安装的以空格分隔的 Python 软件包列表

备注

这些软件包在每次容器启动时都会被重新安装。如果您需要安装大量软件包，请考虑 构建自定义镜像。

---

配置文件

除了使用环境变量外，您还可以将设置写入文件中：

host = "0.0.0.0"
port = 8000
api_key = "your-secret-key"
log_dir = "/var/log/open-terminal"
max_terminal_sessions = 16
enable_terminal = true
enable_notebooks = true
execute_timeout = 5
execute_description = "This terminal has ffmpeg and ImageMagick installed."

为什么要使用配置文件？

它可以防止您的 API 密钥出现在命令行和 shell 历史记录中。在机器上运行 ps 或 htop 的任何人都将无法看到它。

要使用自定义位置的配置文件：

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

---

Docker 凭据

对于生产环境的 Docker 部署，您可以从凭据（secret）文件中加载 API 密钥：

services:
  open-terminal:
    image: ghcr.io/open-webui/open-terminal
    environment:
      - OPEN_TERMINAL_API_KEY_FILE=/run/secrets/terminal_api_key
    secrets:
      - terminal_api_key

secrets:
  terminal_api_key:
    file: ./terminal_api_key.txt

---

镜像变体

Open Terminal 提供三种规格大小的镜像：

	latest	slim	alpine
最适合	通用场景、AI 智能体	较小的体积占用	最小的体积占用
大小	约 4 GB	约 430 MB	约 230 MB
包含内容	Node.js、Python、编译器、ffmpeg、Docker CLI、数据科学库	git、curl、jq	git、curl、jq
可以安装软件包	✔（具备 sudo 权限）	✘	✘
多用户	✔	✘	✘

如果您不确定该选择哪一个，请使用 latest。 它预装了所有必需的工具，因此 AI 可以直接使用任何工具而无需等待安装。

相关内容

• 安全最佳实践 →
• 多用户设置 →