Open WebUI
Open WebUI
Start with meaning, then move to detail.
This lesson explains Open WebUI as part of Hermes internals and extension points. You will learn what it does, when it matters, and the smallest safe test that proves it works.
If you are new, do not memorize names. Focus on three questions: what problem does this solve, what access does it need, and how can you verify the result?
For practice, inspect the first example, identify its effects, run it on test data, and compare the result with the source claim.
For advanced readers, inspect Architecture, Quick Setup, 1. Enable the API server, then verify failure modes and version compatibility.
Know Python, Git, and basic project structure before changing code.
A clear outcome before you read.
- Understand Open WebUI without assumed prior knowledge.
- Separate the source description from what still needs testing in your environment.
- Read the first command and identify its inputs and outputs before copying it.
Short definitions before the details.
- Gateway
- The process that connects Hermes to channels such as Telegram or Discord and routes messages.
Connect Open WebUI to Hermes Agent via the OpenAI-compatible API server
What does the source say, and in what order?
- 01Architecture
Start here to understand the core idea or structure.
- 02Quick Setup
Read this after the foundation, then connect it to the previous step.
- 031. Enable the API server
Read this after the foundation, then connect it to the previous step.
- 042. Start Hermes Agent gateway
Read this after the foundation, then connect it to the previous step.
- 053. Verify the API server is reachable
Read this after the foundation, then connect it to the previous step.
- 064. Start Open WebUI
Read this after the foundation, then connect it to the previous step.
- 075. Open the UI
Read this after the foundation, then connect it to the previous step.
- 08Docker Compose Setup
Read this after the foundation, then connect it to the previous step.
- 09Configuring via the Admin UI
Read this after the foundation, then connect it to the previous step.
- 10API Type: Chat Completions vs Responses
Finish here to verify the result and special cases.
Copy only after you understand the effect.
Open WebUI connects to Hermes Agent's API server just like it would connect to OpenAI. Hermes handles the requests with its full toolset — terminal, file operations, web search, memory, skills — and returns the final response.
:::important Runtime location
The API server is a **Hermes agent runtime**, not a pure LLM proxy. For each request, Hermes creates a server-side `AIAgent` on the API-server host. Tool calls run where that API server is running.
For example, if a laptop points Open WebUI or another OpenAI-compatible client at a Hermes API server on a remote machine, `pwd`, file tools, b`hermes config set` auto-routes the flag to `config.yaml` and the secret to `~/.hermes/.env`. If the gateway is already running, restart it so the change takes effect:### 2. Start Hermes Agent gatewayRead the first command and identify its inputs and outputs before copying it.
Match every command to your installed Hermes version, review the files and accounts it can reach, and use non-sensitive data for the first test. If this explanation differs from the source, the official source wins.