Skip to content

Commit d09c3d0

Browse files
committed
feat: add openweb ui doc
1 parent 7cb0451 commit d09c3d0

1 file changed

Lines changed: 141 additions & 0 deletions

File tree

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
products:
2+
- Alauda AI
3+
kind:
4+
- Solution
5+
ProductsVersion:
6+
- 4.x
7+
---
8+
9+
# OpenWebUI
10+
11+
## Overview
12+
OpenWebUI is an open-source AI Web interface that supports docking with multiple OpenAI protocol-compatible inference backends (such as vLLM, MLServer, XInference, etc.) through a unified entry point. It is used for scenarios such as text generation, multimodal input, and voice input. It provides an extensible external tool mechanism to facilitate the integration of retrieval, function calling, and third-party services. It is suitable for deployment in containers locally or in the cloud, supporting persistent data and Ingress-based HTTPS access.
13+
14+
## Basic Features
15+
- **Conversation & Text Generation**: Support system prompts, adjustable parameters (temperature, length, etc.), and session management.
16+
- **Multimodal & Voice**: Images/documents as context, voice input/transcription (dependent on backend capabilities).
17+
- **External Tool Extension**: Can call retrieval, databases, HTTP APIs, etc., to build tool-enhanced workflows.
18+
- **Data & Security**: Sessions and configurations can be persisted; can integrate with authentication, rate limiting, logging/monitoring.
19+
20+
## Backend Integration
21+
- **Protocol Compatibility**: Support OpenAI API style backends (such as vLLM, MLServer, XInference, TGI, etc.).
22+
- **Connection Parameters**: Base URL (e.g., `http(s)://{backend}/v1`), API Key, model name, and default inference parameters.
23+
- **Multiple Backends**: configured in the UI, allowing switching between different inference service backends.
24+
25+
## Deployment Scheme
26+
Create the following resources in order. In this case, choose an independent `open-webui-ns` namespace. You can choose an available namespace as needed.
27+
28+
### Namespace
29+
```bash
30+
kubectl create ns open-webui-ns
31+
```
32+
33+
### Create the specific deployment
34+
```yaml
35+
apiVersion: apps/v1
36+
kind: Deployment
37+
metadata:
38+
labels:
39+
app: open-webui
40+
name: open-webui
41+
namespace: open-webui-ns
42+
spec:
43+
replicas: 1
44+
selector:
45+
matchLabels:
46+
app: open-webui
47+
template:
48+
metadata:
49+
labels:
50+
app: open-webui
51+
spec:
52+
volumes:
53+
- name: webui-data
54+
emptyDir: {}
55+
containers:
56+
- image: ghcr.io/open-webui/open-webui
57+
name: open-webui
58+
ports:
59+
- containerPort: 8080
60+
env:
61+
- name: ENABLE_DIRECT_CONNECTIONS
62+
value: "true"
63+
- name: OPENAI_API_BASE_URL
64+
value: http://example-predictor/v1
65+
- name: PORT
66+
value: "8080"
67+
volumeMounts:
68+
- name: webui-data
69+
mountPath: /app/backend/data
70+
resources:
71+
requests:
72+
cpu: 1000m
73+
memory: 128Mi
74+
limits:
75+
cpu: 2000m
76+
memory: 1Gi
77+
```
78+
79+
## Important environment values
80+
81+
Relative environment values should be configured.
82+
83+
### ENABLE_DIRECT_CONNECTIONS
84+
* Set to true to enable external connections.
85+
* Purpose: Allows adding additional external inference service backends within OpenWebUI.
86+
87+
### OPENAI_API_BASE_URL
88+
* Specifies the default inference service endpoint.
89+
* If OpenWebUI and the inference service are deployed in the same cluster, use the service’s internal cluster address.
90+
* For the address details, refer to: **AML Business View / Inference Service / Inference Service Details / Access Method**.
91+
* Value format: `{{Cluster Internal URL}}/v1`.
92+
93+
94+
### Verification
95+
```bash
96+
kubectl get deployment open-webui -n open-webui-ns -w
97+
```
98+
Wait until the deployment status is `1/1 Ready`.
99+
100+
## Access OpenWebUI
101+
102+
### 1. View OpenWebUI via NodePort Service
103+
Create the following resource:
104+
105+
```yaml
106+
apiVersion: v1
107+
kind: Service
108+
metadata:
109+
labels:
110+
app: open-webui
111+
name: svc-open-webui
112+
namespace: open-webui-ns
113+
spec:
114+
type: NodePort
115+
ports:
116+
- port: 8080
117+
protocol: TCP
118+
targetPort: 8080
119+
selector:
120+
app: open-webui
121+
```
122+
Check the relevant port and node IP to access the page.
123+
124+
### 2. Initial Settings
125+
When accessing OpenWebUI for the first time, you need to register. Choose a strong password for the administrator account.
126+
127+
### 3. Add Inference Service
128+
Go to **Settings -> Connections -> Add Connection**.
129+
Here you will be required to add the inference service address.
130+
You can obtain the cluster external access methods via **AML Business View / Inference Service / Inference Service Details / Access Method**.
131+
Fill it in afterwards. Please use the cluster **external** access method.
132+
In the **Add Connection** popup, fill in:
133+
`{{Cluster External URL}}/v1`
134+
135+
Click the icon on the right to verify connectivity. After success, click save. Return to the chat page to select the existing inference service for use.
136+
137+
### 4. Use Inference Service
138+
Enter the chat page, select the uploaded inference service, and explore more features, such as:
139+
- Voice input
140+
- Multimodal input
141+
- External tools

0 commit comments

Comments
 (0)