mirror of
https://github.com/open-webui/docs.git
synced 2026-01-04 10:46:26 +07:00
chore: format
This commit is contained in:
@@ -4,14 +4,16 @@ title: "🤝 Contributing Tutorials"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
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
|
||||
## Contributing Tutorials
|
||||
|
||||
We appreciate your interest in contributing tutorials to the Open WebUI documentation. Follow the steps below to set up your environment and submit your tutorial.
|
||||
|
||||
## Steps
|
||||
## Contributing Steps
|
||||
|
||||
1. **Fork the `openwebui/docs` GitHub Repository**
|
||||
|
||||
@@ -96,15 +98,21 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
|
||||
|
||||
Community-contributed tutorials must include the the following:
|
||||
|
||||
```
|
||||
```txt
|
||||
|
||||
:::warning
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
:::tip How to Test Docusaurus Locally
|
||||
:::tip
|
||||
|
||||
How to Test Docusaurus Locally
|
||||
You can test your Docusaurus site locally with the following commands:
|
||||
|
||||
```bash
|
||||
@@ -113,6 +121,7 @@ npm run build # Build the site for production
|
||||
```
|
||||
|
||||
This will help you catch any issues before deploying
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
@@ -3,7 +3,7 @@ sidebar_position: 12
|
||||
title: "⚡ Improve Local LLM Performance with Dedicated Task Models"
|
||||
---
|
||||
|
||||
# Improve Performance with Dedicated Task Models
|
||||
## Improve Performance with Dedicated Task Models
|
||||
|
||||
Open-WebUI provides several automated features—such as title generation, tag creation, autocomplete, and search query generation—to enhance the user experience. However, these features can generate multiple simultaneous requests to your local model, which may impact performance on systems with limited resources.
|
||||
|
||||
@@ -12,8 +12,11 @@ This guide explains how to optimize your setup by configuring a dedicated, light
|
||||
---
|
||||
|
||||
> [!TIP]
|
||||
>
|
||||
>## Why Does Open-WebUI Feel Slow?
|
||||
>
|
||||
>By default, Open-WebUI has several background tasks that can make it feel like magic but can also place a heavy load on local resources:
|
||||
>
|
||||
>- **Title Generation**
|
||||
>- **Tag Generation**
|
||||
>- **Autocomplete Generation** (this function triggers on every keystroke)
|
||||
|
||||
@@ -4,7 +4,9 @@ title: "🚀 One-Click Ollama + Open WebUI Launcher"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
# One-Click Ollama + Open WebUI Launcher (Linux)
|
||||
@@ -91,8 +93,11 @@ Add the following content (make sure to replace `yourusername` with your actual
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
|
||||
######################################################
|
||||
|
||||
# A script to start up Ollama and Open WebUI #
|
||||
|
||||
######################################################
|
||||
|
||||
# Stop Ollama service to prevent port conflicts
|
||||
|
||||
@@ -4,10 +4,12 @@ title: "🔎 Open WebUI RAG Tutorial"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
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 Open WebUI Documentation
|
||||
## Tutorial: Configuring RAG with Open WebUI Documentation
|
||||
|
||||
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.
|
||||
|
||||
@@ -80,12 +82,12 @@ Follow these steps to set up RAG with **Open WebUI Documentation**:
|
||||
|
||||
2. **Example Queries**:
|
||||
|
||||
```
|
||||
```txt
|
||||
User: "How do I configure environment variables?"
|
||||
System: "Refer to Section 3.2: Use the `.env` file to manage configurations."
|
||||
```
|
||||
|
||||
```
|
||||
```txt
|
||||
User: "How do I update Open WebUI using Docker?"
|
||||
System: "Refer to `docker/updating.md`: Use `docker pull` and restart the container."
|
||||
```
|
||||
|
||||
@@ -3,7 +3,7 @@ sidebar_position: 10
|
||||
title: "✂️ Reduce RAM Usage"
|
||||
---
|
||||
|
||||
# Reduce RAM Usage
|
||||
## Reduce RAM Usage
|
||||
|
||||
If you are deploying this image in a RAM-constrained environment, there are a few things you can do to slim down the image.
|
||||
|
||||
@@ -19,9 +19,9 @@ Much of the memory consumption is due to loaded ML models. Even if you are using
|
||||
|
||||
As of v0.3.10 this includes:
|
||||
|
||||
* Speech-to-text (whisper by default)
|
||||
* RAG embedding engine (defaults to local SentenceTransformers model)
|
||||
* Image generation engine (disabled by default)
|
||||
- Speech-to-text (whisper by default)
|
||||
- RAG embedding engine (defaults to local SentenceTransformers model)
|
||||
- Image generation engine (disabled by default)
|
||||
|
||||
The first 2 are enabled and set to local models by default. You can change the models in the admin panel (RAG: Documents category, set it to Ollama or OpenAI, Speech-to-text: Audio section, work with OpenAI or WebAPI).
|
||||
If you are deploying a fresh Docker image, you can also set them with the following environment variables: `RAG_EMBEDDING_ENGINE: ollama`, `AUDIO_STT_ENGINE: openai`. Note that these environment variables have no effect if a `config.json` already exists.
|
||||
|
||||
@@ -4,7 +4,9 @@ title: "💡 Special Arguments"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
# 💡 Special Arguments
|
||||
@@ -60,7 +62,6 @@ A `dict` usually destined to go almost directly to the model. Although it is not
|
||||
"files": "[The exact same list as __files__]"
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
|
||||
</details>
|
||||
@@ -212,7 +213,6 @@ A `list` of the previous messages.
|
||||
|
||||
See the `body["messages"]` value above.
|
||||
|
||||
|
||||
### `__chat_id__`
|
||||
|
||||
The `str` of the `chat_id`.
|
||||
@@ -295,14 +295,13 @@ Note that the same files dict can also be accessed via `__metadata__["files"]` (
|
||||
}
|
||||
]
|
||||
|
||||
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### `__request__`
|
||||
|
||||
An instance of `fastapi.Request`. You can read more at the [migration page](../../features/plugin/migration/index.mdx) or at [fastapi's documentation](https://fastapi.tiangolo.com/reference/request/).
|
||||
An instance of `fastapi.Request`. You can read more in the [migration page](/docs/features/plugin/migration/index.mdx) or in [fastapi's documentation](https://fastapi.tiangolo.com/reference/request/).
|
||||
|
||||
### `__task__`
|
||||
|
||||
@@ -333,7 +332,6 @@ A `dict` containing the `body` needed to accomplish a given `__task__`. Its valu
|
||||
|
||||
Its structure is the same as `body` above, with modifications like using the appropriate model and system message etc.
|
||||
|
||||
|
||||
### `__tools__`
|
||||
|
||||
A `list` of `ToolUserModel` instances.
|
||||
|
||||
@@ -4,13 +4,15 @@ title: "💠 SQLite Database Overview"
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
> [!WARNING]
|
||||
> [!WARNING]
|
||||
> This documentation was created/updated based on version 0.6.30.
|
||||
|
||||
# Open-WebUI Internal SQLite Database
|
||||
## Open-WebUI Internal SQLite Database
|
||||
|
||||
For Open-WebUI, the SQLite database serves as the backbone for user management, chat history, file storage, and various other core functionalities. Understanding this structure is essential for anyone looking to contribute to or maintain the project effectively.
|
||||
|
||||
@@ -18,7 +20,7 @@ For Open-WebUI, the SQLite database serves as the backbone for user management,
|
||||
|
||||
You can find the SQLite database at `root` -> `data` -> `webui.db`
|
||||
|
||||
```
|
||||
```txt
|
||||
📁 Root (/)
|
||||
├── 📁 data
|
||||
│ ├── 📁 cache
|
||||
@@ -177,7 +179,7 @@ Things to know about the auth table:
|
||||
| created_at | BigInteger | - | Creation timestamp |
|
||||
| updated_at | BigInteger | - | Last update timestamp |
|
||||
|
||||
# File Table
|
||||
## File Table
|
||||
|
||||
| **Column Name** | **Data Type** | **Constraints** | **Description** |
|
||||
| --------------- | ------------- | --------------- | --------------------- |
|
||||
@@ -423,7 +425,7 @@ Things to know about the tag table:
|
||||
| info | JSON | nullable | Additional user info |
|
||||
| oauth_sub | Text | UNIQUE | OAuth subject identifier |
|
||||
|
||||
# Entity Relationship Diagram
|
||||
## Entity Relationship Diagram
|
||||
|
||||
To help visualize the relationship between the tables, refer to the below Entity Relationship Diagram (ERD) generated with Mermaid.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user