Open WebUI 集成

Open WebUI(126k★)是最流行的 AI 自托管聊天界面。借助 Hermes Agent 内置的 API 服务器,您可以将 Open WebUI 用作代理的精美 Web 前端——包含对话管理、用户账户和现代聊天界面。

架构

flowchart LR
    A["Open WebUI<br/>浏览器 UI<br/>端口 3000"]
    B["hermes-agent<br/>网关 API 服务器<br/>端口 8642"]
    A -->|POST /v1/chat/completions| B
    B -->|SSE 流式响应| A

Open WebUI 连接到 Hermes Agent 的 API 服务器,就像连接到 OpenAI 一样。Hermes 使用其完整的工具集——终端、文件操作、网络搜索、记忆、技能——处理请求,并返回最终响应。

:::important 运行时位置 API 服务器是 Hermes 代理运行时,而非纯粹的 LLM 代理。对于每个请求,Hermes 在 API 服务器主机上创建一个服务端 AIAgent。工具调用在 API 服务器运行的地方执行。

例如,如果笔记本电脑将 Open WebUI 或其他兼容 OpenAI 的客户端指向远程机器上的 Hermes API 服务器,则 pwd、文件工具、浏览器工具、本地 MCP 工具和其他工作区工具在远程 API 服务器主机上运行,而非笔记本电脑上。 :::

Open WebUI 以服务器间通信方式与 Hermes 对话,因此此集成不需要 API_SERVER_CORS_ORIGINS

快速设置

单命令本地引导(macOS/Linux,无需 Docker)

如果您希望在本地将 Hermes + Open WebUI 连接在一起,并带有可复用的启动器,请运行:

cd ~/.hermes/hermes-agent
bash scripts/setup_open_webui.sh

该脚本的功能:

  • 确保 ~/.hermes/.env 包含 API_SERVER_ENABLEDAPI_SERVER_HOSTAPI_SERVER_KEYAPI_SERVER_PORTAPI_SERVER_MODEL_NAME
  • 重启 Hermes 网关以使 API 服务器启动
  • 将 Open WebUI 安装到 ~/.local/open-webui-venv
  • ~/.local/bin/start-open-webui-hermes.sh 写入启动器
  • 在 macOS 上安装 launchd 用户服务;在带有 systemd --user 的 Linux 上安装用户服务

默认值:

  • Hermes API:http://127.0.0.1:8642/v1
  • Open WebUI:http://127.0.0.1:8080
  • 向 Open WebUI 广告的模型名称:Hermes Agent

有用的覆盖:

OPEN_WEBUI_NAME='My Hermes UI' \
OPEN_WEBUI_ENABLE_SIGNUP=true \
HERMES_API_MODEL_NAME='My Hermes Agent' \
bash scripts/setup_open_webui.sh

在 Linux 上,自动后台服务设置需要正常的 systemd --user 会话。如果您在无头 SSH 机器上并希望跳过服务安装,请运行:

OPEN_WEBUI_ENABLE_SERVICE=false bash scripts/setup_open_webui.sh

1. 启用 API 服务器

hermes config set API_SERVER_ENABLED true
hermes config set API_SERVER_KEY your-secret-key

hermes config set 自动将标志路由到 config.yaml,将密钥路由到 ~/.hermes/.env。如果网关已在运行,请重启以使更改生效:

hermes gateway stop && hermes gateway

2. 启动 Hermes Agent 网关

hermes gateway

您应该看到:

[API Server] API server listening on http://127.0.0.1:8642

3. 验证 API 服务器是否可达

curl -s http://127.0.0.1:8642/health
# {"status": "ok", ...}
 
curl -s -H "Authorization: Bearer ***" http://127.0.0.1:8642/v1/models
# {"object":"list","data":[{"id":"hermes-agent", ...}]}

如果 /health 失败,网关没有拾取 API_SERVER_ENABLED=true——请重启。如果 /v1/models 返回 401,您的 Authorization 标头与 API_SERVER_KEY 不匹配。

4. 启动 Open WebUI

docker run -d -p 3000:8080 \
  -e OPENAI_API_BASE_URL=http://host.docker.internal:8642/v1 \
  -e OPENAI_API_KEY=your-secret-key \
  -e ENABLE_OLLAMA_API=false \
  --add-host=host.docker.internal:host-gateway \
  -v open-webui:/app/backend/data \
  --name open-webui \
  --restart always \
  ghcr.io/open-webui/open-webui:main

ENABLE_OLLAMA_API=false 抑制默认的 Ollama 后端,否则它会显示为空并杂乱模型选择器。如果您实际上有 Ollama 在旁边运行,请省略此设置。

首次启动需要 15-30 秒:Open WebUI 在首次启动时会下载 sentence-transformer 嵌入模型(约 150MB)。在打开 UI 之前等待 docker logs open-webui 稳定下来。

5. 打开 UI

访问 **http://localhost:3000**。创建您的管理员账户(第一个用户成为管理员)。您应该会在模型下拉菜单中看到您的代理(以您的配置文件命名,或默认配置文件的 hermes-agent)。开始聊天吧!

Docker Compose 设置

对于更永久的设置,创建一个 docker-compose.yml

services:
  open-webui:
    image: ghcr.io/open-webui/open-webui:main
    ports:
      - "3000:8080"
    volumes:
      - open-webui:/app/backend/data
    environment:
      - OPENAI_API_BASE_URL=http://host.docker.internal:8642/v1
      - OPENAI_API_KEY=your-secret-key
      - ENABLE_OLLAMA_API=false
    extra_hosts:
      - "host.docker.internal:host-gateway"
    restart: always
 
volumes:
  open-webui:

然后:

docker compose up -d

通过管理 UI 配置

如果您更倾向于通过 UI 而非环境变量来配置连接:

  1. 登录 Open WebUI,访问 http://localhost:3000
  2. 点击您的个人资料头像管理员设置
  3. 进入 连接
  4. OpenAI API 下,点击扳手图标(管理)
  5. 点击 + 添加新连接
  6. 输入:
    • URLhttp://host.docker.internal:8642/v1
    • API Key:与 Hermes 中的 API_SERVER_KEY 完全相同的值
  7. 点击对勾以验证连接
  8. 保存

您的代理模型现在应出现在模型下拉菜单中(以您的配置文件命名,或默认配置文件的 hermes-agent)。

:::warning 环境变量仅在 Open WebUI 首次启动时生效。之后,连接设置存储在其内部数据库中。要稍后更改,请使用管理 UI 或删除 Docker 卷并重新开始。 :::

API 类型:Chat Completions vs Responses

Open WebUI 在连接到后端时支持两种 API 模式:

模式格式何时使用
Chat Completions(默认)/v1/chat/completions推荐。开箱即用。
Responses(实验性)/v1/responses通过 previous_response_id 实现服务端对话状态。

使用 Chat Completions(推荐)

这是默认模式,无需额外配置。Open WebUI 发送标准 OpenAI 格式的请求,Hermes Agent 相应响应。每个请求包含完整的对话历史。

使用 Responses API

要使用 Responses API 模式:

  1. 进入 管理员设置连接OpenAI管理
  2. 编辑您的 hermes-agent 连接
  3. API 类型从”Chat Completions”更改为 “Responses(Experimental)”
  4. 保存

使用 Responses API 时,Open WebUI 以 Responses 格式发送请求(input 数组 + instructions),Hermes Agent 可以通过 previous_response_id 在多个回合中保留完整的工具调用历史。当 stream: true 时,Hermes 还会流式传输规范原生的 function_callfunction_call_output 条目,这可以在渲染 Responses 事件的客户端中实现自定义结构化工具调用 UI。

:::note Open WebUI 目前在 Responses 模式下仍然在客户端管理对话历史——它在每个请求中发送完整消息历史,而不是使用 previous_response_id。今天 Responses 模式的主要优势在于结构化事件流:文本增量、function_callfunction_call_output 条目以 OpenAI Responses SSE 事件而非 Chat Completions 块的形式到达。 :::

工作原理

当您在 Open WebUI 中发送消息时:

  1. Open WebUI 发送 POST /v1/chat/completions 请求,包含您的消息和对话历史
  2. Hermes Agent 使用 API 服务器的配置文件、模型/提供者配置、记忆、技能和配置的 API 服务器工具集创建一个服务端 AIAgent 实例
  3. 代理处理您的请求——它可以在 API 服务器主机上调用工具(终端、文件操作、网络搜索等)
  4. 工具执行时,内联进度消息流式传输到 UI,让您看到代理正在做什么(例如 `💻 ls -la`, `🔍 Python 3.12 release`
  5. 代理的最终文本响应流式传输回 Open WebUI
  6. Open WebUI 在其聊天界面中显示响应

您的代理可以访问与该 API 服务器 Hermes 实例相同的工具和能力。如果 API 服务器是远程的,这些工具也是远程的。

如果您需要工具针对您的本地工作区运行,请在本地运行 Hermes 并将其指向纯 LLM 提供商或纯兼容 OpenAI 的模型代理(例如 vLLM、LiteLLM、Ollama、llama.cpp、OpenAI、OpenRouter 等)。未来的”远程大脑,本地双手”分割运行时模式正在 #18715 中跟踪;这不是当前 API 服务器的行为。

:::tip 工具进度 启用流式传输后(默认),您会在工具运行时看到简短的内联指示——工具 emoji 和其关键参数。这些会在代理最终回答之前出现在响应流中,让您了解幕后发生的事情。 :::

配置参考

Hermes Agent(API 服务器)

变量默认值描述
API_SERVER_ENABLEDfalse启用 API 服务器
API_SERVER_PORT8642HTTP 服务器端口
API_SERVER_HOST127.0.0.1绑定地址
API_SERVER_KEY(必填)用于认证的 Bearer 令牌。匹配 OPENAI_API_KEY

Open WebUI

变量描述
OPENAI_API_BASE_URLHermes Agent 的 API URL(包含 /v1
OPENAI_API_KEY必须非空。匹配您的 API_SERVER_KEY

故障排查

模型未出现在下拉菜单中

  • 检查 URL 是否包含 /v1 后缀http://host.docker.internal:8642/v1(不仅仅是 :8642
  • 确认网关正在运行curl http://localhost:8642/health 应返回 {"status": "ok"}
  • 检查模型列表curl -H "Authorization: Bearer ***" http://localhost:8642/v1/models 应返回包含 hermes-agent 的列表
  • Docker 网络:从 Docker 内部,localhost 指的是容器,而非您的主机。使用 host.docker.internal--network=host
  • 空 Ollama 后端遮挡选择器:如果您省略了 ENABLE_OLLAMA_API=false,Open WebUI 会在您的 Hermes 模型上方显示一个空的 Ollama 部分。使用 -e ENABLE_OLLAMA_API=false 重启容器,或在 管理员设置 → 连接 中禁用 Ollama。

连接测试通过但没有模型加载

这几乎总是缺少 /v1 后缀。Open WebUI 的连接测试是基本连通性检查——它不会验证模型列表是否正常工作。

响应时间过长

Hermes Agent 在生成最终响应之前可能正在执行多个工具调用(读取文件、运行命令、搜索网络)。对于复杂查询,这是正常现象。代理完成时响应会一次性出现。

“Invalid API key” 错误

确保 Open WebUI 中的 OPENAI_API_KEY 与 Hermes Agent 中的 API_SERVER_KEY 匹配。

:::warning Open WebUI 在首次启动后会将兼容 OpenAI 的连接设置持久化到自己的数据库中。如果您在管理 UI 中意外保存了错误的密钥,仅修复环境变量是不够的——请在 管理员设置 → 连接 中更新或删除已保存的连接,或重置 Open WebUI 数据目录/数据库。 :::

多用户设置与配置文件

要为每个用户运行独立的 Hermes 实例——各有其自己的配置、记忆和技能——请使用配置文件。每个配置文件在不同的端口上运行自己的 API 服务器,并在 Open WebUI 中自动将配置文件名广告为模型名称。

1. 创建配置文件并配置 API 服务器

API_SERVER_* 是环境变量而非 YAML 配置键,因此请将它们写入每个配置文件的 .env。选择默认平台范围之外的端口(8644 是 webhook 适配器,8645 是 wecom-callback,8646 是 msgraph-webhook),例如 8650+

hermes profile create alice
cat >> ~/.hermes/profiles/alice/.env <<EOF
API_SERVER_ENABLED=true
API_SERVER_PORT=8650
API_SERVER_KEY=alice-secret
EOF
 
hermes profile create bob
cat >> ~/.hermes/profiles/bob/.env <<EOF
API_SERVER_ENABLED=true
API_SERVER_PORT=8651
API_SERVER_KEY=bob-secret
EOF

2. 启动每个网关

hermes -p alice gateway &
hermes -p bob gateway &

3. 在 Open WebUI 中添加连接

管理员设置连接OpenAI API管理 中,为每个配置文件添加一个连接:

连接URLAPI Key
Alicehttp://host.docker.internal:8650/v1alice-secret
Bobhttp://host.docker.internal:8651/v1bob-secret

模型下拉菜单将显示 alicebob 作为不同的模型。您可以通过管理面板将模型分配给 Open WebUI 用户,使每个用户拥有自己独立的 Hermes 代理。

:::tip 自定义模型名称 模型名称默认为配置文件名。要覆盖它,在配置文件的 .env 中设置 API_SERVER_MODEL_NAME

hermes -p alice config set API_SERVER_MODEL_NAME "Alice's Agent"

:::

Linux Docker(无需 Docker Desktop)

在没有 Docker Desktop 的 Linux 上,host.docker.internal 默认不解析。选项:

# 选项 1:添加主机映射
docker run --add-host=host.docker.internal:host-gateway ...
 
# 选项 2:使用主机网络
docker run --network=host -e OPENAI_API_BASE_URL=http://localhost:8642/v1 ...
 
# 选项 3:使用 Docker 桥接 IP
docker run -e OPENAI_API_BASE_URL=http://172.17.0.1:8642/v1 ...