diff --git a/docs/features/index.mdx b/docs/features/index.mdx index d03e67606..c1a300565 100644 --- a/docs/features/index.mdx +++ b/docs/features/index.mdx @@ -121,6 +121,10 @@ Connect a real computing environment to Open WebUI. The AI writes code, executes [**Learn about Open Terminal โ†’**](/features/open-terminal) +:::tip +Want the whole machine in a browser tab? See [**cptr**](https://github.com/open-webui/computer) (Open WebUI Computer). +::: + --- ## ๐Ÿ”Œ Extensibility diff --git a/docs/features/open-terminal/file-browser.md b/docs/features/open-terminal/file-browser.md index d115dad50..f51a0b301 100644 --- a/docs/features/open-terminal/file-browser.md +++ b/docs/features/open-terminal/file-browser.md @@ -109,3 +109,7 @@ If you have more than one terminal connected, switching between them in the drop - **[Analyze documents & data โ†’](./use-cases/file-analysis)** โ€” drag in a spreadsheet or PDF and ask about it - **[Run code from chat โ†’](./use-cases/code-execution)** โ€” the AI creates files you can see here - **[Build & preview websites โ†’](./use-cases/web-development)** โ€” the files the AI creates appear in the browser + +:::tip +Want to browse and edit your real files from any device? [**cptr**](https://github.com/open-webui/computer) puts your entire machine in a browser tab, with a full file browser, terminal, git, and editor. +::: diff --git a/docs/features/open-terminal/index.md b/docs/features/open-terminal/index.md index 929f9d95f..bfcd75a29 100644 --- a/docs/features/open-terminal/index.md +++ b/docs/features/open-terminal/index.md @@ -84,3 +84,9 @@ Open Terminal requires models with **native function calling** support. Frontier ## Enterprise Multi-User Need isolated, per-user terminal containers for your team? **[Terminals](./terminals/)** provisions a dedicated Open Terminal instance for every user with automatic lifecycle management, resource controls, and policy-based environments. + +--- + +## Your Whole Machine + +Open Terminal adds a computing environment to Open WebUI. [**cptr**](https://github.com/open-webui/computer) (Open WebUI Computer) is the computer itself: files, terminal, git, editor, and AI in a browser tab, accessible from any device. diff --git a/docs/features/open-terminal/setup/installation.mdx b/docs/features/open-terminal/setup/installation.mdx index 3f30a9f8e..e8fd2eca6 100644 --- a/docs/features/open-terminal/setup/installation.mdx +++ b/docs/features/open-terminal/setup/installation.mdx @@ -154,6 +154,10 @@ http://open-terminal:8000 --- +:::tip Looking for the whole machine? +[**cptr**](https://github.com/open-webui/computer) (Open WebUI Computer) is your entire computer in a browser tab: files, terminal, git, editor, and AI, accessible from any device. It also connects to Open WebUI via its gateway API. +::: + ## Next step [**Connect to Open WebUI โ†’**](./connecting) diff --git a/docs/features/open-terminal/use-cases/code-execution.md b/docs/features/open-terminal/use-cases/code-execution.md index 21304e132..761a1dc61 100644 --- a/docs/features/open-terminal/use-cases/code-execution.md +++ b/docs/features/open-terminal/use-cases/code-execution.md @@ -88,3 +88,7 @@ Additional languages (Rust, Go, Java, etc.) can be installed on the fly. - **[Document & data analysis โ†’](./file-analysis)** โ€” spreadsheets, PDFs, Word docs - **[Web development โ†’](./web-development)** โ€” build and preview websites - **[System automation โ†’](./system-automation)** โ€” file management, backups, batch operations + +:::tip +Want a persistent environment on your real machine? [**cptr**](https://github.com/open-webui/computer) puts your computer in a browser tab, accessible from any device. +::: diff --git a/docs/features/open-terminal/use-cases/software-development.md b/docs/features/open-terminal/use-cases/software-development.md index 411531e6d..48b77e4bf 100644 --- a/docs/features/open-terminal/use-cases/software-development.md +++ b/docs/features/open-terminal/use-cases/software-development.md @@ -7,6 +7,10 @@ title: "Software Development" Open Terminal enables the AI to interact with real codebases โ€” cloning repos, running tests, reading errors, installing dependencies, and iterating on fixes. +:::tip +For a full development environment accessible from any device, see [**cptr**](https://github.com/open-webui/computer). Your computer in a browser tab. +::: + --- ## Clone and explore a repo diff --git a/docs/features/open-terminal/use-cases/system-automation.md b/docs/features/open-terminal/use-cases/system-automation.md index ddc49f157..596caac5e 100644 --- a/docs/features/open-terminal/use-cases/system-automation.md +++ b/docs/features/open-terminal/use-cases/system-automation.md @@ -85,3 +85,7 @@ If a tool isn't installed, the AI can install it on the fly (`sudo apt install . - **[Run code from chat โ†’](./code-execution)** โ€” the AI writes, runs, and debugs code - **[Analyze documents & data โ†’](./file-analysis)** โ€” spreadsheets, PDFs, Word docs, emails - **[Build & preview websites โ†’](./web-development)** โ€” create and iterate on web pages + +:::tip +Want to automate tasks on your real machine from anywhere? [**cptr**](https://github.com/open-webui/computer) puts your computer in a browser tab, accessible from any device. +::: diff --git a/docs/features/open-terminal/use-cases/web-development.md b/docs/features/open-terminal/use-cases/web-development.md index 2503a87b7..5fad7e52f 100644 --- a/docs/features/open-terminal/use-cases/web-development.md +++ b/docs/features/open-terminal/use-cases/web-development.md @@ -86,3 +86,7 @@ If the AI starts more than one server (say, a frontend on port 3000 and a backen - **[Run code from chat โ†’](./code-execution)** โ€” the AI writes, runs, and debugs code - **[Analyze documents & data โ†’](./file-analysis)** โ€” spreadsheets, PDFs, Word docs, emails - **[Automate tasks โ†’](./system-automation)** โ€” file management, backups, batch operations + +:::tip +Want to preview and iterate on websites from your phone? [**cptr**](https://github.com/open-webui/computer) gives you your whole machine in a browser tab, accessible from any device. +::: diff --git a/docs/getting-started/advanced-topics/scaling.md b/docs/getting-started/advanced-topics/scaling.md index 3d778ded5..b02872a4d 100644 --- a/docs/getting-started/advanced-topics/scaling.md +++ b/docs/getting-started/advanced-topics/scaling.md @@ -326,27 +326,42 @@ For the full setup guide, see [OpenTelemetry Monitoring](/reference/monitoring/o Here's what a production-ready scaled deployment typically looks like: -``` -โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” -โ”‚ Load Balancer โ”‚ -โ”‚ (Nginx, HAProxy, Cloud LB) โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ - โ”‚ โ”‚ โ”‚ - โ”Œโ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ” - โ”‚ WebUI โ”‚ โ”‚ WebUI โ”‚ โ”‚ WebUI โ”‚ โ† Stateless containers - โ”‚ Pod 1 โ”‚ โ”‚ Pod 2 โ”‚ โ”‚ Pod N โ”‚ - โ””โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”˜ - โ”‚ โ”‚ โ”‚ - โ”Œโ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ” - โ”‚ PostgreSQL โ”‚ โ† Shared database - โ”‚ (+ PGVector for RAG) โ”‚ โ† Vector DB (or other Vector DB) - โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ - โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” - โ”‚ Redis โ”‚ โ† Shared state & websockets - โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ - โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” - โ”‚ Shared Storage (NFS or S3) โ”‚ โ† Shared file storage - โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +```mermaid +flowchart TD + %% Main Flow + LB["Load Balancer
(Nginx, HAProxy, Cloud LB)"] + + subgraph Pods ["Stateless Containers"] + direction LR + P1["WebUI
Pod 1"] + P2["WebUI
Pod 2"] + PN["WebUI
Pod N"] + end + + subgraph Shared ["Shared Infrastructure"] + direction LR + DB[("PostgreSQL
(+ PGVector for RAG)")] + Redis{{"Redis"}} + Storage[/"Shared Storage
(NFS or S3)"/] + end + + %% Annotations + DBNote["Shared database
+ Vector DB"] + RedisNote["Shared state & websockets"] + StoreNote["Shared file storage"] + + %% Connections + LB --> P1 + LB --> P2 + LB --> PN + P1 --> Shared + P2 --> Shared + PN --> Shared + + %% Alignment Links + DB -.-> DBNote + Redis -.-> RedisNote + Storage -.-> StoreNote ``` **Running into issues?** The [Scaling & HA Troubleshooting](/troubleshooting/multi-replica) guide covers common problems (login loops, WebSocket failures, database locks, worker crashes) and their solutions. For performance tuning at scale, see [Optimization, Performance & RAM Usage](/troubleshooting/performance). diff --git a/docs/getting-started/essentials.mdx b/docs/getting-started/essentials.mdx index 5397e6331..b8736b836 100644 --- a/docs/getting-started/essentials.mdx +++ b/docs/getting-started/essentials.mdx @@ -257,6 +257,10 @@ More detail: - [Open Terminal: give your AI a real computer](/features/open-terminal) - [Use cases: software development, data reports, app builder, research assistant, and more](/features/open-terminal/use-cases/advanced-workflows/) +:::info +[**cptr**](https://github.com/open-webui/computer) (Open WebUI Computer) by the Open WebUI team is your entire computer in a browser tab: files, terminal, git, editor, and AI, accessible from any device. It connects to Open WebUI via its gateway API. +::: + --- ## What to do next diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 0a8c33b6a..a6ba97f18 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -30,6 +30,22 @@ Everything you need for a working setup. Choose Docker for the fastest path, Pyt --- +## ๐Ÿ“ฑ Open WebUI as an App + +**Already running Open WebUI? Install it as an app on any device.** + +Open WebUI is a Progressive Web App (PWA). Add it to your phone's home screen, your desktop taskbar, or your dock. No separate download required. Get a full-screen, native-feeling experience from any browser. + +| | | +| :--- | :--- | +| ๐Ÿ“ฑ **iPhone / iPad** | Share โ†’ Add to Home Screen | +| ๐Ÿค– **Android** | Menu โ†’ Install app | +| ๐Ÿ–ฅ๏ธ **Chrome / Edge** | Address bar install icon | + +[**Install as an app โ†’**](/getting-started/open-webui-as-app) + +--- + ## Essentials for Open WebUI **Installed and chatting โ€” now what?** diff --git a/docs/getting-started/open-webui-as-app.md b/docs/getting-started/open-webui-as-app.md new file mode 100644 index 000000000..6c0f9a96d --- /dev/null +++ b/docs/getting-started/open-webui-as-app.md @@ -0,0 +1,56 @@ +--- +sidebar_position: 3 +title: "Open WebUI as an App" +--- + +# Open WebUI as an App + +Every Open WebUI instance is a **Progressive Web App (PWA)**. You can install it as a standalone app on your phone, tablet, or desktop, directly from the browser. No separate download required. + +## What You Get + +- **App icon** on your home screen, taskbar, or dock +- **Full-screen experience** with no browser toolbar or address bar +- **Standalone window** on desktop, full-screen on mobile +- **Separate from the browser** with its own window and task entry +- **Push notifications** (when enabled by your admin) + +--- + +## Install on Your Device + +### Chrome / Edge (Desktop) + +1. Open your Open WebUI instance in Chrome or Edge. +2. Click the **install icon** (โŠ•) in the address bar, or go to **Menu โ†’ Install Open WebUI**. +3. Click **Install**. + +Open WebUI now appears in your app launcher and runs in its own window. + +### Chrome (Android) + +1. Open your Open WebUI instance in Chrome. +2. Tap **Menu (โ‹ฎ) โ†’ Add to Home Screen** or **Install app**. +3. Tap **Install**. + +### Safari (iPhone / iPad) + +1. Open your Open WebUI instance in Safari. +2. Tap the **Share button** (โ†‘). +3. Scroll down and tap **Add to Home Screen**. +4. Tap **Add**. + +:::info +Safari is the only browser that supports PWA installation on iOS. Chrome and Firefox on iOS cannot install PWAs. +::: + +### Firefox (Android) + +1. Open your Open WebUI instance in Firefox. +2. Tap **Menu (โ‹ฎ) โ†’ Install**. + +--- + +## Customizing the PWA (Admins) + +Admins can white-label the PWA by pointing to a custom manifest with the [`EXTERNAL_PWA_MANIFEST_URL`](/reference/env-configuration#external_pwa_manifest_url) environment variable. This lets you set a custom app name, icon, and theme color. diff --git a/docs/getting-started/quick-start/connect-an-agent/cptr.mdx b/docs/getting-started/quick-start/connect-an-agent/cptr.mdx new file mode 100644 index 000000000..e88c404a3 --- /dev/null +++ b/docs/getting-started/quick-start/connect-an-agent/cptr.mdx @@ -0,0 +1,160 @@ +--- +sidebar_position: 0 +title: "Open WebUI Computer (cptr)" +sidebar_label: "Open WebUI Computer (cptr)" +--- + +# Open WebUI Computer (cptr) + +**Open WebUI Computer. Connect `cptr` to Open WebUI.** + +[**cptr**](https://github.com/open-webui/computer) puts your computer in a browser tab. Files, terminal, git, editor, AI, accessible from any device. It runs on your machine and serves it to you over HTTP. + +cptr exposes an **OpenAI-compatible gateway API** (`/v1/chat/completions`). Each workspace appears as a model in Open WebUI with full tool access: file operations, terminal commands, web search, and more. + +:::info What You'll Need +- **cptr** installed on your machine (`pip install cptr` or `uvx cptr@latest run`) +- **Open WebUI** running (via Docker, pip, or desktop app) +- **~5 minutes** to complete this setup +::: + +--- + +## Step 1: Install and Start cptr + +If you haven't installed cptr yet: + +```bash +pip install cptr +cptr run +``` + +Or with [uv](https://docs.astral.sh/uv/): + +```bash +uvx cptr@latest run +``` + +cptr starts on port **8000** by default and opens in your browser. + +To allow access from other devices on the network: + +```bash +cptr run --host 0.0.0.0 +``` + +--- + +## Step 2: Create an API Key + +1. Open cptr in your browser. +2. Go to **Settings > Gateway**. +3. Enter a name for the key and click **Create Key**. +4. Copy the key (`sk-cptr-...`). You will only see it once. + +The Gateway settings page also shows the **Base URL** for your instance (e.g., `http://localhost:8000/v1`). + +--- + +## Step 3: Add the Connection in Open WebUI + +1. Open Open WebUI in your browser. +2. Go to โš™๏ธ **Admin Settings** > **Connections** > **OpenAI**. +3. Click โž• **Add Connection**. +4. Enter the following: + +| Setting | Value | +|---|---| +| **URL** | `http://localhost:8000/v1` | +| **API Key** | The `sk-cptr-...` key from Step 2 | + +5. Click the โœ… checkmark to verify, then **Save**. + +:::tip Running Open WebUI in Docker? +Replace `localhost` with `host.docker.internal`: + +``` +http://host.docker.internal:8000/v1 +``` +::: + +--- + +## Step 4: Configure Custom Headers (Recommended) + +For the best experience, set up custom request headers so that Open WebUI passes conversation metadata to cptr. This enables proper session mapping (conversations stay in sync between both interfaces) and ensures background tasks like title generation are handled efficiently. + +1. In Open WebUI, go to **Admin Settings > Connections**. +2. Find the cptr connection and click the **โ‹ฎ** menu, then **Custom Headers**. +3. Paste the following: + +```json +{ + "X-OpenWebUI-Chat-Id": "{{CHAT_ID}}", + "X-OpenWebUI-Message-Id": "{{MESSAGE_ID}}", + "X-OpenWebUI-User-Message-Id": "{{USER_MESSAGE_ID}}", + "X-OpenWebUI-User-Message-Parent-Id": "{{USER_MESSAGE_PARENT_ID}}", + "X-OpenWebUI-Task": "{{TASK}}" +} +``` + +:::tip +You can copy these headers directly from cptr's **Settings > Gateway** page. +::: + +--- + +## Step 5: Start Chatting + +Your cptr workspaces should now appear in the model dropdown as `cptr/`. Select one and start chatting. The AI has full access to that workspace: files, terminal, web search, and any configured tools. + +Conversations are synced. Work done through Open WebUI appears in cptr's sidebar, and vice versa. + +--- + +## Choosing a Gateway Model + +By default, cptr uses the first available model connection for gateway requests. To use a specific model: + +1. In cptr, go to **Settings > Gateway**. +2. Select a model from the dropdown. +3. Click **Save**. + +You can also set a per-workspace model by creating a `.cptr/model` file in the workspace root: + +```bash +echo "anthropic/claude-sonnet-4-20250514" > /path/to/workspace/.cptr/model +``` + +--- + +## Troubleshooting + +### No models appear in the dropdown + +- Verify the URL includes `/v1`: `http://localhost:8000/v1` (not just `:8000`) +- Check that cptr is running and accessible +- Confirm the API key is correct + +### Connection test passes but no models load + +Almost always the missing `/v1` suffix. Open WebUI's connection test checks basic connectivity, not model discovery. + +### Docker networking issues + +If Open WebUI runs in Docker, `localhost` points to the container itself. Use `host.docker.internal` instead. On Linux without Docker Desktop: + +```bash +docker run --add-host=host.docker.internal:host-gateway ... +``` + +### Conversations not syncing + +Make sure the custom headers from Step 4 are configured. Without them, cptr creates a new chat for each request instead of continuing the existing conversation. + +--- + +## Learn More + +- [cptr on GitHub](https://github.com/open-webui/computer) +- [Open WebUI Connections](/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible) diff --git a/docs/getting-started/quick-start/connect-an-agent/index.md b/docs/getting-started/quick-start/connect-an-agent/index.md index 405076140..71ef61aad 100644 --- a/docs/getting-started/quick-start/connect-an-agent/index.md +++ b/docs/getting-started/quick-start/connect-an-agent/index.md @@ -32,8 +32,9 @@ The agent decides when and how to use these tools based on your message, and Ope | Agent | Description | Guide | |-------|-------------|-------| -| **Hermes Agent** | Autonomous agent by Nous Research with terminal, file ops, web search, memory, and extensible skills | [Set up Hermes Agent โ†’](./hermes-agent) | -| **OpenClaw** | Open-source self-hosted agent framework with shell access, file operations, web browsing, and messaging channel integrations | [Set up OpenClaw โ†’](./openclaw) | +| **cptr** (Open WebUI Computer) | Your computer in a browser tab, by the Open WebUI team. Each workspace connects to Open WebUI as a model with full tool access via an OpenAI-compatible gateway. | [Set up cptr โ†’](/getting-started/quick-start/connect-an-agent/cptr) | +| **Hermes Agent** | Autonomous agent by Nous Research with terminal, file ops, web search, memory, and extensible skills | [Set up Hermes Agent โ†’](/getting-started/quick-start/connect-an-agent/hermes-agent) | +| **OpenClaw** | Open-source self-hosted agent framework with shell access, file operations, web browsing, and messaging channel integrations | [Set up OpenClaw โ†’](/getting-started/quick-start/connect-an-agent/openclaw) | --- @@ -41,13 +42,16 @@ The agent decides when and how to use these tools based on your message, and Ope Regardless of which agent you connect, the architecture is the same: -``` -โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” -โ”‚ โ”‚ HTTP โ”‚ โ”‚ Tools โ”‚ โ”‚ -โ”‚ Open WebUI โ”‚โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ–ถโ”‚ Agent Gateway โ”‚โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ–ถโ”‚ Terminal, โ”‚ -โ”‚ (frontend) โ”‚โ—€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”‚ (API server) โ”‚โ—€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”‚ Files, Web โ”‚ -โ”‚ โ”‚ Stream โ”‚ โ”‚ Resultsโ”‚ โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +```mermaid +flowchart LR + A["Open WebUI
(frontend)"] + B["Agent Gateway
(API server)"] + C["Terminal,
Files, Web"] + + A -- HTTP --> B + B -- Tools --> C + C -- Results --> B + B -- Stream --> A ``` 1. **You type a message** in Open WebUI diff --git a/docs/intro.mdx b/docs/intro.mdx index 343941458..6d8af6e09 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -78,7 +78,7 @@ Installed Open WebUI but not sure where to start? The [**Essentials for Open Web - [**Quick Start**](/getting-started/quick-start) โ€” Docker, Python, Kubernetes install options - [**Connect a Provider**](/getting-started/quick-start/connect-a-provider) โ€” Ollama, OpenAI, Anthropic, vLLM, and more - [**Essentials for Open WebUI**](/getting-started/essentials) - Start here after your first install. Plugins, tool calling, task models, context management, RAG, Open Terminal. -- [**Connect an Agent**](/getting-started/quick-start/connect-an-agent) โ€” Hermes Agent, OpenClaw, and other autonomous AI agents +- [**Connect an Agent**](/getting-started/quick-start/connect-an-agent) โ€” Open WebUI Computer (`cptr`), Hermes Agent, OpenClaw, and other autonomous AI agents - [**Updating**](/getting-started/updating) โ€” Keep your instance current - [**Development Branch**](/getting-started/quick-start) โ€” Help test the latest changes before stable release - [**Advanced Topics**](/getting-started/advanced-topics) โ€” Scaling, logging, and advanced configuration @@ -95,6 +95,15 @@ Installed Open WebUI but not sure where to start? The [**Essentials for Open Web --- +## Also by Open WebUI + +- [**cptr**](https://github.com/open-webui/computer) (Open WebUI Computer) โ€” Your computer in a browser tab. Files, terminal, git, editor, and AI, accessible from any device. [Connect it to Open WebUI โ†’](/getting-started/quick-start/connect-an-agent/cptr) +- [**open-terminal**](https://github.com/open-webui/open-terminal) โ€” Give your AI a real computer. Sandboxed terminal, file browser, and code execution for Open WebUI. +- [**oikb**](https://github.com/open-webui/oikb) โ€” Keep your Open WebUI knowledge bases in sync. Watches local folders, GitHub repos, S3 buckets, Confluence, and 40+ other sources. +- [**mcpo**](https://github.com/open-webui/mcpo) โ€” MCP-to-OpenAPI proxy. Use any MCP tool server with Open WebUI (or any OpenAPI client) without custom glue code. + +--- + ## Enterprise Need **custom branding**, **SLA support**, or **Long-Term Support (LTS)** versions?