mirror of
https://github.com/open-webui/docs.git
synced 2026-01-02 01:39:43 +07:00
Markdownlit corrections in formatting
Markdownlit corrections in formatting
This commit is contained in:
@@ -29,7 +29,6 @@ We appreciate your interest in contributing tutorials to the Open WebUI document
|
||||
- Under **Source**, select the branch you want to deploy (e.g., `main`) and the folder (e.g.,`/docs`).
|
||||
- Click **Save** to enable GitHub Pages.
|
||||
|
||||
|
||||
4. **Configure GitHub Environment Variables**
|
||||
|
||||
- In your forked repository, go to **Settings** > **Secrets and variables** > **Actions** > **Variables**.
|
||||
@@ -42,7 +41,9 @@ We appreciate your interest in contributing tutorials to the Open WebUI document
|
||||
If you need to adjust deployment settings to fit your custom setup, here’s what to do:
|
||||
|
||||
a. **Update `.github/workflows/gh-pages.yml`**
|
||||
- Add environment variables for `BASE_URL` and `SITE_URL` to the build step if necessary:
|
||||
|
||||
- Add environment variables for `BASE_URL` and `SITE_URL` to the build step if necessary:
|
||||
|
||||
```yaml
|
||||
- name: Build
|
||||
env:
|
||||
@@ -52,7 +53,9 @@ a. **Update `.github/workflows/gh-pages.yml`**
|
||||
```
|
||||
|
||||
b. **Modify `docusaurus.config.ts` to Use Environment Variables**
|
||||
- Update `docusaurus.config.ts` to use these environment variables, with default values for local or direct deployment:
|
||||
|
||||
- Update `docusaurus.config.ts` to use these environment variables, with default values for local or direct deployment:
|
||||
|
||||
```typescript
|
||||
const config: Config = {
|
||||
title: "Open WebUI",
|
||||
@@ -63,7 +66,8 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
|
||||
...
|
||||
};
|
||||
```
|
||||
- This setup ensures consistent deployment behavior for forks and custom setups.
|
||||
|
||||
- This setup ensures consistent deployment behavior for forks and custom setups.
|
||||
|
||||
5. **Run the `gh-pages` GitHub Workflow**
|
||||
|
||||
@@ -91,6 +95,7 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
|
||||
## Important
|
||||
|
||||
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.
|
||||
@@ -110,4 +115,4 @@ npm run build # Build the site for production
|
||||
This will help you catch any issues before deploying
|
||||
:::
|
||||
|
||||
---
|
||||
---
|
||||
|
||||
@@ -20,6 +20,7 @@ In this tutorial, you will learn how to use **Retrieval-Augmented Generation (RA
|
||||
Retrieval-Augmented Generation (RAG) combines **LLMs** with **retrieved knowledge** from external sources. The system retrieves relevant data from uploaded documents or knowledge bases, enhancing the quality and accuracy of responses.
|
||||
|
||||
This tutorial demonstrates how to:
|
||||
|
||||
- Upload the latest OpenWebUI Documentation as a knowledge base.
|
||||
- Connect it to a custom model.
|
||||
- Query the knowledge base for enhanced assistance.
|
||||
@@ -102,4 +103,3 @@ 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!
|
||||
|
||||
|
||||
@@ -18,6 +18,7 @@ Set the following environment variables (or the respective UI settings for an ex
|
||||
Much of the memory consumption is due to loaded ML models. Even if you are using an external language model (OpenAI or unbundled ollama), many models may be loaded for additional purposes.
|
||||
|
||||
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)
|
||||
|
||||
Reference in New Issue
Block a user