mirror of
https://github.com/open-webui/docs.git
synced 2026-01-03 18:26:47 +07:00
revert: ## -> #
This commit is contained in:
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## HAProxy Configuration for Open WebUI
|
||||
# HAProxy Configuration for Open WebUI
|
||||
|
||||
HAProxy (High Availability Proxy) is specialized load-balancing and reverse proxy solution that is highly configurable and designed to handle large amounts of connections with a relatively low resource footprint. for more information, please see: https://www.haproxy.org/
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## HTTPS using Nginx
|
||||
# HTTPS using Nginx
|
||||
|
||||
Ensuring secure communication between your users and the Open WebUI is paramount. HTTPS (HyperText Transfer Protocol Secure) encrypts the data transmitted, protecting it from eavesdroppers and tampering. By configuring Nginx as a reverse proxy, you can seamlessly add HTTPS to your Open WebUI deployment, enhancing both security and trustworthiness.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## 🎨 Image Generation
|
||||
# 🎨 Image Generation
|
||||
|
||||
Open WebUI supports image generation through three backends: **AUTOMATIC1111**, **ComfyUI**, and **OpenAI DALL·E**. This guide will help you set up and use either of these options.
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
---
|
||||
|
||||
## Integrating Open-WebUI with Amazon Bedrock
|
||||
# Integrating Open-WebUI with Amazon Bedrock
|
||||
|
||||
In this tutorial, we'll explore one of the most common and popular approaches to integrate Open-WebUI with Amazon Bedrock.
|
||||
|
||||
@@ -32,7 +32,7 @@ Direct from AWS' website:
|
||||
|
||||
To learn more about Bedrock, visit: [Amazon Bedrock's Official Page](https://aws.amazon.com/bedrock/)
|
||||
|
||||
## Integration Steps
|
||||
# Integration Steps
|
||||
|
||||
## Step 1: Verify access to Amazon Bedrock Base Models
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
---
|
||||
|
||||
## Backend-Controlled, UI-Compatible API Flow
|
||||
# Backend-Controlled, UI-Compatible API Flow
|
||||
|
||||
This tutorial demonstrates how to implement server-side orchestration of Open WebUI conversations while ensuring that assistant replies appear properly in the frontend UI. This approach requires zero frontend involvement and allows complete backend control over the chat flow.
|
||||
This tutorial has been verified to work with Open WebUI version v0.6.15. Future versions may introduce changes in behavior or API structure.
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## Browser Search Engine Integration
|
||||
# Browser Search Engine Integration
|
||||
|
||||
Open WebUI allows you to integrate directly into your web browser. This tutorial will guide you through the process of setting up Open WebUI as a custom search engine, enabling you to execute queries easily from your browser's address bar.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## Integrating Continue.dev VS Code Extension with Open WebUI
|
||||
# Integrating Continue.dev VS Code Extension with Open WebUI
|
||||
|
||||
## Download Extension
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
## 🦊 Firefox AI Chatbot Sidebar
|
||||
|
||||
## Integrating Open WebUI as a Local AI Chatbot Browser Assistant in Mozilla Firefox
|
||||
# Integrating Open WebUI as a Local AI Chatbot Browser Assistant in Mozilla Firefox
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## Helicone Integration with Open WebUI
|
||||
# Helicone Integration with Open WebUI
|
||||
|
||||
Helicone is an open-source LLM observability platform for developers to monitor, debug, and improve **production-ready** applications, including your Open WebUI deployment.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## 🔗 Okta OIDC SSO Integration
|
||||
# 🔗 Okta OIDC SSO Integration
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## 🔗 Redis Websocket Support
|
||||
# 🔗 Redis Websocket Support
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
> [!WARNING]
|
||||
> This documentation was created based on the current version (0.5.16) and is constantly being updated.
|
||||
|
||||
## Jupyter Notebook Integration
|
||||
# Jupyter Notebook Integration
|
||||
|
||||
Starting in v0.5.11, Open-WebUI released a new feature called `Jupyter Notebook Support in Code Interpreter`. This feature allow you to integrate Open-WebUI with Jupyter. There have already been several improvements to this feauture over the subsequent releases, so review the release notes carefully.
|
||||
|
||||
@@ -33,7 +33,7 @@ Here is the target configuration we're going to set-up through this tutorial.
|
||||
|
||||

|
||||
|
||||
## Step 1: Launch OUI and Jupyter
|
||||
# Step 1: Launch OUI and Jupyter
|
||||
|
||||
To accomplish this, I used `docker-compose` to launch a stack that includes both services, along with my LLMs, but this should also work if run each docker container separately.
|
||||
|
||||
@@ -82,7 +82,7 @@ When accessing the Jupyter service, you will need the `JUPYTER_TOKEN` defined ab
|
||||
|
||||

|
||||
|
||||
## Step 2: Configure Code Execution for Jupyter
|
||||
# Step 2: Configure Code Execution for Jupyter
|
||||
|
||||
Now that we have Open-WebUI and Jupter running, we need to configure Open-WebUI's Code Execution to use Jupyter under Admin Panel -> Settings -> Code Execution. Since Open-WebUI is constantly releasing and improving this feature, I recommend always reviewing the possible configuraitons in the [`configs.py` file](https://github.com/open-webui/open-webui/blob/6fedd72e3973e1d13c9daf540350cd822826bf27/backend/open_webui/routers/configs.py#L72) for the latest and greatest. As of v0.5.16, this includes the following:
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## Backing Up Your Instance
|
||||
# Backing Up Your Instance
|
||||
|
||||
Nobody likes losing data!
|
||||
|
||||
@@ -93,7 +93,7 @@ However your instance is provisioned, it's worth inspecting the app's data store
|
||||
| `vector_db/` | Directory containing the ChromaDB vector database. |
|
||||
| `webui.db` | SQLite database for persistent storage of other instance data |
|
||||
|
||||
## File Level Backup Approaches
|
||||
# File Level Backup Approaches
|
||||
|
||||
The first way to back up the application data is to take a file level backup approach ensuring that the persistent Open Web UI data is properly backed up.
|
||||
|
||||
@@ -359,13 +359,13 @@ Once you've added your backup script and provisioned your backup storage, you'll
|
||||
|
||||
Set your new script(s) up to run using crontabs according to your desired run frequency.
|
||||
|
||||
## Commercial Utilities
|
||||
# Commercial Utilities
|
||||
|
||||
In addition to scripting your own backup jobs, you can find commercial offerings which generally work by installing agents on your server that will abstract the complexities of running backups. These are beyond the purview of this article but provide convenient solutions.
|
||||
|
||||
---
|
||||
|
||||
## Host Level Backups
|
||||
# Host Level Backups
|
||||
|
||||
Your Open WebUI instance might be provisioned on a host (physical or virtualised) which you control.
|
||||
|
||||
@@ -373,7 +373,7 @@ Host level backups involve creating snapshots or backups but of the entire VM ra
|
||||
|
||||
Some may wish to leverage them as their primary or only protection while others may wish to layer them in as additional data protections.
|
||||
|
||||
## How Many Backups Do I Need?
|
||||
# How Many Backups Do I Need?
|
||||
|
||||
The amount of backups that you will wish to take depends on your personal level of risk tolerance. However, remember that it's best practice to *not* consider the application itself to be a backup copy (even if it lives in the cloud!). That means that if you've provisioned your instance on a VPS, it's still a reasonable recommendation to keep two (independent) backup copies.
|
||||
|
||||
@@ -396,7 +396,7 @@ This backup plan is a little more complicated but also more comprehensive .. it
|
||||
| Daily Incremental | Cloud Storage (B2) | rsync | Daily incremental backup pushed to a Backblaze B2 cloud storage bucket. |
|
||||
| Weekly Incremental | On-site Storage (Home NAS) | rsync | Weekly incremental backup pulled from the server to on-site storage (e.g., a home NAS). |
|
||||
|
||||
## Additional Topics
|
||||
# Additional Topics
|
||||
|
||||
In the interest of keeping this guide reasonably thorough these additional subjects were ommitted but may be worth your consideration depending upon how much time you have to dedicate to setting up and maintaining a data protection plan for your instance:
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## Running Open WebUI in offline mode 🔌
|
||||
# Running Open WebUI in offline mode 🔌
|
||||
|
||||
If you want to run Open WebUI in offline mode, you have to consider your installation approach and adjust your desired features accordingly. In this guide, we will go over the different ways of achieving a mostly similar setup to the online version.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## 🪣 Switching to S3 Storage
|
||||
# 🪣 Switching to S3 Storage
|
||||
|
||||
This guide provides instructions on how to switch the default `local` storage in Open WebUI config to Amazon S3.
|
||||
|
||||
@@ -30,7 +30,7 @@ Direct from AWS' website:
|
||||
|
||||
To learn more about S3, visit: [Amazon S3's Official Page](https://aws.amazon.com/s3/)
|
||||
|
||||
## How to Set-Up
|
||||
# How to Set-Up
|
||||
|
||||
## 1. Required environment variables
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ For a complete list of all Open WebUI environment variables, see the [Environmen
|
||||
|
||||
The following is a summary of the environment variables for speech to text (STT).
|
||||
|
||||
## Environment Variables For Speech To Text (STT)
|
||||
# Environment Variables For Speech To Text (STT)
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
|
||||
@@ -3,7 +3,7 @@ sidebar_position: 3
|
||||
title: "🗨️ Chatterbox TTS — Voice Cloning"
|
||||
---
|
||||
|
||||
## Chatterbox TTS — Voice Cloning
|
||||
# Chatterbox TTS — Voice Cloning
|
||||
|
||||
:::warning
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## Integrating `openai-edge-tts` 🗣️ with Open WebUI
|
||||
# Integrating `openai-edge-tts` 🗣️ with Open WebUI
|
||||
|
||||
## What is `openai-edge-tts`?
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI
|
||||
|
||||
:::
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user