mirror of
https://github.com/open-webui/docs.git
synced 2026-01-02 17:59:41 +07:00
refac
This commit is contained in:
@@ -8,7 +8,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
|
||||
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
:::info
|
||||
|
||||
@@ -4,7 +4,7 @@ title: 🐳 Installing Docker
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Installing Docker
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🔒 HTTPS using Nginx"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# HTTPS using Nginx
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🎨 Image Generation"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# 🎨 Image Generation
|
||||
|
||||
7
docs/tutorials/integrations/_category_.json
Normal file
7
docs/tutorials/integrations/_category_.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "🔗 Integrations",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ title: "🪶 Apache Tika Extraction"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
## 🪶 Apache Tika Extraction
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🌐 Browser Search Engine"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Browser Search Engine Integration
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "⚛️ Continue.dev VSCode Extension with Open WebUI"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Integrating Continue.dev VSCode Extension with Open WebUI
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🛃 Setting up with Custom CA Store"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
If you get an `[SSL: CERTIFICATE_VERIFY_FAILED]` error when trying to run OI, most likely the issue is that you are on a network which intercepts HTTPS traffic (e.g. a corporate network).
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: "🔗 Integrations"
|
||||
---
|
||||
@@ -4,7 +4,7 @@ title: "🖥️ Local LLM Setup with IPEX-LLM on Intel GPU"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
:::note
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🔗 Redis Websocket Support"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# 🔗 Redis Websocket Support
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🗨️ Kokoro-FastAPI Using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Integrating `Kokoro-FastAPI` 🗣️ with Open WebUI
|
||||
|
||||
7
docs/tutorials/text-to-speech/_category_.json
Normal file
7
docs/tutorials/text-to-speech/_category_.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "🗨️ Text-to-Speech",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: "🗨️ Text-to-Speech"
|
||||
---
|
||||
@@ -4,7 +4,7 @@ title: "🗨️ Edge TTS Using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Integrating `openai-edge-tts` 🗣️ with Open WebUI
|
||||
|
||||
@@ -4,7 +4,7 @@ title: "🗨️ Openedai-speech Using Docker"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
**Integrating `openedai-speech` into Open WebUI using Docker**
|
||||
|
||||
7
docs/tutorials/tips/_category_.json
Normal file
7
docs/tutorials/tips/_category_.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "💡 Tips & Tricks",
|
||||
"position": 900,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ title: "🤝 Contributing Tutorials"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Contributing Tutorials
|
||||
@@ -98,7 +98,7 @@ Community-contributed tutorials must include the the following:
|
||||
|
||||
```
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
```
|
||||
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
sidebar_position: 900
|
||||
title: "💡 Tips & Tricks"
|
||||
---
|
||||
@@ -4,12 +4,12 @@ title: "🔎 Open WebUI RAG Tutorial"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
# Tutorial: Configuring RAG with OpenWebUI Documentation
|
||||
# Tutorial: Configuring RAG with Open WebUI Documentation
|
||||
|
||||
In this tutorial, you will learn how to use **Retrieval-Augmented Generation (RAG)** with OpenWebUI to load real-world documentation as a knowledge base. We will walk through how to use the latest **OpenWebUI Documentation** as an example for this setup.
|
||||
In this tutorial, you will learn how to use **Retrieval-Augmented Generation (RAG)** with Open WebUI to load real-world documentation as a knowledge base. We will walk through how to use the latest **Open WebUI Documentation** as an example for this setup.
|
||||
|
||||
---
|
||||
|
||||
@@ -21,7 +21,7 @@ Retrieval-Augmented Generation (RAG) combines **LLMs** with **retrieved knowledg
|
||||
|
||||
This tutorial demonstrates how to:
|
||||
|
||||
- Upload the latest OpenWebUI Documentation as a knowledge base.
|
||||
- Upload the latest Open WebUI Documentation as a knowledge base.
|
||||
- Connect it to a custom model.
|
||||
- Query the knowledge base for enhanced assistance.
|
||||
|
||||
@@ -29,9 +29,9 @@ This tutorial demonstrates how to:
|
||||
|
||||
## Setup
|
||||
|
||||
### Step-by-Step Setup: OpenWebUI Documentation as Knowledge Base
|
||||
### Step-by-Step Setup: Open WebUI Documentation as Knowledge Base
|
||||
|
||||
Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
Follow these steps to set up RAG with **Open WebUI Documentation**:
|
||||
|
||||
1. **Download the Documentation**:
|
||||
- Download the latest documentation:
|
||||
@@ -45,13 +45,13 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
|
||||
4. **Create a Knowledge Base**:
|
||||
- Navigate to **Workspace** > **Knowledge** > **+ Create a Knowledge Base**.
|
||||
- Name it: `OpenWebUI Documentation`
|
||||
- Name it: `Open WebUI Documentation`
|
||||
- Purpose: **Assistance**
|
||||
|
||||
> Click **Create Knowledge**.
|
||||
|
||||
5. **Upload the Files**:
|
||||
- Drag and drop the `.md` and `.mdx` files from the extracted folder into the **OpenWebUI Documentation** knowledge base.
|
||||
- Drag and drop the `.md` and `.mdx` files from the extracted folder into the **Open WebUI Documentation** knowledge base.
|
||||
|
||||
---
|
||||
|
||||
@@ -63,9 +63,9 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
- Go to **Workspace** > **Models** > **+ Add New Model**.
|
||||
|
||||
2. **Configure the Model**:
|
||||
- **Name**: `OpenWebUI`
|
||||
- **Name**: `Open WebUI`
|
||||
- **Base Model**: *(Select the appropriate Llama or other available model)*
|
||||
- **Knowledge Source**: Select **OpenWebUI Documentation** from the dropdown.
|
||||
- **Knowledge Source**: Select **Open WebUI Documentation** from the dropdown.
|
||||
|
||||
3. **Save the Model**.
|
||||
|
||||
@@ -73,10 +73,10 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
|
||||
## Examples and Usage
|
||||
|
||||
### Query the OpenWebUI Documentation Model
|
||||
### Query the Open WebUI Documentation Model
|
||||
|
||||
1. **Start a New Chat**:
|
||||
- Navigate to **New Chat** and select the `OpenWebUI` model.
|
||||
- Navigate to **New Chat** and select the `Open WebUI` model.
|
||||
|
||||
2. **Example Queries**:
|
||||
|
||||
@@ -86,7 +86,7 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
```
|
||||
|
||||
```
|
||||
User: "How do I update OpenWebUI using Docker?"
|
||||
User: "How do I update Open WebUI using Docker?"
|
||||
System: "Refer to `docker/updating.md`: Use `docker pull` and restart the container."
|
||||
```
|
||||
|
||||
@@ -102,4 +102,4 @@ Follow these steps to set up RAG with **OpenWebUI Documentation**:
|
||||
|
||||
---
|
||||
|
||||
With this setup, you can effectively use the **OpenWebUI Documentation** to assist users by retrieving relevant information for their queries. Enjoy building and querying your custom knowledge-enhanced models!
|
||||
With this setup, you can effectively use the **Open WebUI Documentation** to assist users by retrieving relevant information for their queries. Enjoy building and querying your custom knowledge-enhanced models!
|
||||
|
||||
Reference in New Issue
Block a user