centersl/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-03-26 13:18:42 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update index.md

Browse Source
This commit is contained in:
DrMelone
2026-02-21 23:53:52 +01:00
parent 5f653c47e6
commit 091e1169c1
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/features/extensibility/open-terminal/index.md
View File

@@ -7,7 +7,7 @@ title: "Open Terminal"
:::info
This page is up-to-date with Open Terminal release version [v0.2.3](https://github.com/open-webui/open-terminal).
This page is up-to-date with Open Terminal release version [v0.2.4](https://github.com/open-webui/open-terminal).
:::
@@ -64,6 +64,10 @@ docker run -p 8000:8000 open-terminal
### pip Install (Bare Metal)
```bash
# One-liner with uvx (no install needed)
uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key
# Or install globally with pip
pip install open-terminal
open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key
```
@@ -143,6 +147,10 @@ When no API key is provided, Open Terminal generates a random key using a crypto
Process output is persisted to **JSONL log files** under `OPEN_TERMINAL_LOG_DIR/processes/`. These files provide a full audit trail that survives process cleanup and server restarts.
:::note Performance
As of v0.2.4, all file and upload endpoints use **fully async I/O** via `aiofiles`. Directory listing and file search operations run in a background thread via `asyncio.to_thread`. This means the server's event loop is never blocked by filesystem operations, even on large directories or slow storage.
:::
## Connecting to Open WebUI
Open Terminal is a FastAPI application and automatically exposes an OpenAPI specification at `/openapi.json`. This means it works out of the box as an [OpenAPI Tool Server](/features/extensibility/plugin/tools/openapi-servers/open-webui) — no manual tool creation required.