mirror of
https://github.com/open-webui/docs.git
synced 2025-12-12 07:29:49 +07:00
Merge pull request #816 from open-webui/main
This commit is contained in:
Classic298
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "🛠️ Local Development Guide"
|
||||
title: "Local Development Guide"
|
||||
---
|
||||
|
||||
# Ready to Contribute to Open WebUI? Let's Get Started! 🚀
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: "🔒 Enabling HTTPS Encryption"
|
||||
title: "Enabling HTTPS Encryption"
|
||||
---
|
||||
|
||||
# Secure Your Open WebUI with HTTPS 🔒
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: "📚 Advanced Topics"
|
||||
title: "Advanced Topics"
|
||||
---
|
||||
|
||||
# 📚 Advanced Topics
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "📜 Logging in Open WebUI"
|
||||
title: "Logging in Open WebUI"
|
||||
---
|
||||
|
||||
# Understanding Open WebUI Logging 🪵
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: "📊 Monitoring Your Open WebUI"
|
||||
title: "Monitoring Your Open WebUI"
|
||||
---
|
||||
|
||||
# Keep Your Open WebUI Healthy with Monitoring 🩺
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: "🔭 OpenTelemetry"
|
||||
title: "OpenTelemetry"
|
||||
---
|
||||
|
||||
Open WebUI supports **distributed tracing and metrics** export via the OpenTelemetry (OTel) protocol (OTLP). This enables integration with modern observability stacks such as **Grafana LGTM (Loki, Grafana, Tempo, Mimir)**, as well as **Jaeger**, **Tempo**, and **Prometheus** to monitor requests, database/Redis queries, response times, and more in real-time.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: "🕸️ Network Diagrams"
|
||||
title: "Network Diagrams"
|
||||
---
|
||||
|
||||
Here, we provide clear and structured diagrams to help you understand how various components of the network interact within different setups. This documentation is designed to assist both macOS/Windows and Linux users. Each scenario is illustrated using Mermaid diagrams to show how the interactions are set up depending on the different system configurations and deployment strategies.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 400
|
||||
title: "🔗 API Endpoints"
|
||||
title: "API Endpoints"
|
||||
---
|
||||
|
||||
This guide provides essential information on how to interact with the API endpoints effectively to achieve seamless integration and automation using our models. Please note that this is an experimental setup and may undergo future updates for enhancement.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: "🌍 Environment Variable Configuration"
|
||||
title: "Environment Variable Configuration"
|
||||
---
|
||||
|
||||
## Overview
|
||||
@@ -1113,7 +1113,7 @@ If `OFFLINE_MODE` is enabled, this `ENABLE_VERSION_UPDATE_CHECK` flag is always
|
||||
- OAuth authentication providers
|
||||
- Web search and RAG with external APIs
|
||||
|
||||
Read more about `offline mode` in the [offline mode guide](/docs/tutorials/offline-mode.md).
|
||||
Read more about `offline mode` in the [offline mode guide](/tutorials/offline-mode).
|
||||
|
||||
:::
|
||||
|
||||
@@ -1133,7 +1133,26 @@ Read more about `offline mode` in the [offline mode guide](/docs/tutorials/offli
|
||||
|
||||
- Type: `str`
|
||||
- Default: `*`
|
||||
- Description: Sets the allowed origins for Cross-Origin Resource Sharing (CORS).
|
||||
- Description: Sets the allowed origins for Cross-Origin Resource Sharing (CORS). Smicolon ';' separated list of allowed origins.
|
||||
|
||||
:::warning
|
||||
|
||||
**This variable is required to be set**, otherwise you may experience Websocket issues and weird "\{\}" responses or "Unexpected token 'd', "data: \{"id"... is not valid JSON".
|
||||
|
||||
:::
|
||||
|
||||
:::info
|
||||
|
||||
If you experience Websocket issues, check the logs of Open WebUI.
|
||||
If you see lines like this `engineio.base_server:_log_error_once:354 - https://yourdomain.com is not an accepted origin.` then you need to configure your CORS_ALLOW_ORIGIN more broadly.
|
||||
|
||||
Example:
|
||||
CORS_ALLOW_ORIGIN: "https://yourdomain.com;http://yourdomain.com;https://yourhostname;http://youripaddress;http://localhost:3000"
|
||||
|
||||
Add all valid IPs, Domains and Hostnames one might access your Open WebUI to the variable.
|
||||
Once you did, no more websocket issues or warnings in the console should occur.
|
||||
|
||||
:::
|
||||
|
||||
#### `CORS_ALLOW_CUSTOM_SCHEME`
|
||||
|
||||
@@ -1315,23 +1334,26 @@ If you want to use Milvus, be careful when upgrading Open WebUI (crate backups a
|
||||
|
||||
:::
|
||||
|
||||
#### `MILVUS_URI`
|
||||
#### `MILVUS_URI` **(Required)**
|
||||
|
||||
- Type: `str`
|
||||
- Default: `${DATA_DIR}/vector_db/milvus.db`
|
||||
- Example (Remote): `http://your-server-ip:19530`
|
||||
- Description: Specifies the URI for connecting to the Milvus vector database. This can point to a local or remote Milvus server based on the deployment configuration.
|
||||
|
||||
#### `MILVUS_DB`
|
||||
|
||||
- Type: `str`
|
||||
- Default: `default`
|
||||
- Example: `default`
|
||||
- Description: Specifies the database to connect to within a Milvus instance.
|
||||
|
||||
#### `MILVUS_TOKEN`
|
||||
#### `MILVUS_TOKEN` **(Required for remote connections with authentication)**
|
||||
|
||||
- Type: `str`
|
||||
- Default: `None`
|
||||
- Description: Specifies an optional connection token for Milvus.
|
||||
- Example: `root:password` (format: `username:password`)
|
||||
- Description: Specifies an optional connection token for Milvus. Required when connecting to a remote Milvus server with authentication enabled. Format is `username:password`.
|
||||
|
||||
#### `MILVUS_INDEX_TYPE`
|
||||
|
||||
@@ -2038,7 +2060,7 @@ When configuring `RAG_FILE_MAX_SIZE` and `RAG_FILE_MAX_COUNT`, ensure that the v
|
||||
|
||||
- Type: `int`
|
||||
- Default: `1`
|
||||
- Description: Sets the batch size for embedding in RAG (Retrieval-Augmented Generator) models.
|
||||
- Description: Controls how many text chunks are embedded in a single API request when using external embedding providers (Ollama, OpenAI, or Azure OpenAI). Higher values (20-100+; max 16000) process documents faster by sending more API requests, but may exceed API rate limits, while lower values (1-10) are more stable but slower. Default is 1 (safest option if you are API rate limit constrained, but slowest option). This setting only applies to external embedding engines, not the default SentenceTransformers engine.
|
||||
- Persistence: This environment variable is a `PersistentConfig` variable.
|
||||
|
||||
#### `RAG_EMBEDDING_CONTENT_PREFIX`
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 200
|
||||
sidebar_position: 100
|
||||
title: "🚀 Getting Started"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: "⏱️ Quick Start"
|
||||
title: "Quick Start"
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "🔌 Getting Started with Functions"
|
||||
title: "Getting Started with Functions"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: "🦙Starting with Llama.cpp"
|
||||
title: "Starting with Llama.cpp"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: "👉 Starting With Ollama"
|
||||
title: "Starting With Ollama"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
|
||||
sidebar_position: 4
|
||||
title: "🌐 Starting with OpenAI-Compatible Servers"
|
||||
title: "Starting with OpenAI-Compatible Servers"
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
|
||||
sidebar_position: 2
|
||||
title: "🤖 Starting With OpenAI"
|
||||
title: "Starting With OpenAI"
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
|
||||
Using Docker Compose simplifies the management of multi-container Docker applications.
|
||||
|
||||
If you don't have Docker installed, check out our [Docker installation tutorial](docs/tutorials/docker-install.md).
|
||||
|
||||
Docker Compose requires an additional package, `docker-compose-v2`.
|
||||
|
||||
:::warning
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
sidebar_position: 300
|
||||
title: "🔄 Updating Open WebUI"
|
||||
title: "Updating Open WebUI"
|
||||
---
|
||||
|
||||
## Why isn't my Open WebUI updating?
|
||||
|
||||
Reference in New Issue
Block a user