From 06fe790116ba023f0ca2c9619be668b32470650e Mon Sep 17 00:00:00 2001 From: silentoplayz Date: Thu, 9 Oct 2025 15:22:08 -0400 Subject: [PATCH] revert: ## -> # --- docs/features/rag/document-extraction/apachetika.md | 2 +- docs/features/rag/document-extraction/docling.md | 2 +- docs/features/rag/document-extraction/mistral-ocr.md | 2 +- docs/getting-started/advanced-topics/development.md | 2 +- .../advanced-topics/https-encryption.md | 2 +- docs/getting-started/advanced-topics/logging.md | 2 +- .../advanced-topics/monitoring/index.md | 2 +- docs/tutorials/https-haproxy.md | 2 +- docs/tutorials/https-nginx.md | 2 +- docs/tutorials/images.md | 2 +- docs/tutorials/integrations/amazon-bedrock.md | 4 ++-- .../backend-controlled-ui-compatible-flow.md | 2 +- docs/tutorials/integrations/browser-search-engine.md | 2 +- docs/tutorials/integrations/continue-dev.md | 2 +- docs/tutorials/integrations/firefox-sidebar.md | 2 +- docs/tutorials/integrations/helicone.md | 2 +- docs/tutorials/integrations/okta-oidc-sso.md | 2 +- docs/tutorials/integrations/redis.md | 2 +- docs/tutorials/jupyter.md | 6 +++--- docs/tutorials/maintenance/backups.md | 12 ++++++------ docs/tutorials/offline-mode.md | 2 +- docs/tutorials/s3-storage.md | 4 ++-- docs/tutorials/speech-to-text/env-variables.md | 2 +- .../text-to-speech/chatterbox-tts-api-integration.md | 2 +- .../text-to-speech/openai-edge-tts-integration.md | 2 +- docs/tutorials/tips/contributing-tutorial.md | 2 +- 26 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/features/rag/document-extraction/apachetika.md b/docs/features/rag/document-extraction/apachetika.md index 128a8ffa..e67e6979 100644 --- a/docs/features/rag/document-extraction/apachetika.md +++ b/docs/features/rag/document-extraction/apachetika.md @@ -19,7 +19,7 @@ This documentation provides a step-by-step guide to integrating Apache Tika with - Docker installed on your system - Docker network set up for Open WebUI -## Integration Steps +# Integration Steps ### Step 1: Create a Docker Compose File or Run the Docker Command for Apache Tika diff --git a/docs/features/rag/document-extraction/docling.md b/docs/features/rag/document-extraction/docling.md index 13021b4f..2be419fe 100644 --- a/docs/features/rag/document-extraction/docling.md +++ b/docs/features/rag/document-extraction/docling.md @@ -19,7 +19,7 @@ This documentation provides a step-by-step guide to integrating Docling with Ope - Docker installed on your system - Docker network set up for Open WebUI -## Integration Steps +# Integration Steps ### Step 1: Run the Docker Command for Docling-Serve diff --git a/docs/features/rag/document-extraction/mistral-ocr.md b/docs/features/rag/document-extraction/mistral-ocr.md index d8bbac70..188f9e7b 100644 --- a/docs/features/rag/document-extraction/mistral-ocr.md +++ b/docs/features/rag/document-extraction/mistral-ocr.md @@ -18,7 +18,7 @@ This documentation provides a step-by-step guide to integrating Mistral OCR with - Open WebUI instance - Mistral AI account -## Integration Steps +# Integration Steps ### Step 1: Sign Up or Login to Mistral AI console diff --git a/docs/getting-started/advanced-topics/development.md b/docs/getting-started/advanced-topics/development.md index db867838..06f696fb 100644 --- a/docs/getting-started/advanced-topics/development.md +++ b/docs/getting-started/advanced-topics/development.md @@ -3,7 +3,7 @@ sidebar_position: 1 title: "πŸ› οΈ Local Development Guide" --- -## Ready to Contribute to Open WebUI? Let's Get Started! πŸš€ +# Ready to Contribute to Open WebUI? Let's Get Started! πŸš€ Excited to dive into Open WebUI development? This comprehensive guide will walk you through setting up your **local development environment** quickly and easily. Whether you're a seasoned developer or just starting out, we'll get you ready to tweak the frontend, enhance the backend, and contribute to the future of Open WebUI! Let's get your development environment up and running in simple, detailed steps! diff --git a/docs/getting-started/advanced-topics/https-encryption.md b/docs/getting-started/advanced-topics/https-encryption.md index cd0f9d70..908cae7b 100644 --- a/docs/getting-started/advanced-topics/https-encryption.md +++ b/docs/getting-started/advanced-topics/https-encryption.md @@ -3,7 +3,7 @@ sidebar_position: 6 title: "πŸ”’ Enabling HTTPS Encryption" --- -## Secure Your Open WebUI with HTTPS πŸ”’ +# Secure Your Open WebUI with HTTPS πŸ”’ This guide explains how to enable HTTPS encryption for your Open WebUI instance. While **HTTPS is not strictly required** for basic operation, it's highly recommended for security and is **necessary for certain features like Voice Calls** to function in modern web browsers. diff --git a/docs/getting-started/advanced-topics/logging.md b/docs/getting-started/advanced-topics/logging.md index 57de8043..0c33977a 100644 --- a/docs/getting-started/advanced-topics/logging.md +++ b/docs/getting-started/advanced-topics/logging.md @@ -3,7 +3,7 @@ sidebar_position: 5 title: "πŸ“œ Logging in Open WebUI" --- -## Understanding Open WebUI Logging πŸͺ΅ +# Understanding Open WebUI Logging πŸͺ΅ Logging is essential for debugging, monitoring, and understanding how Open WebUI is behaving. This guide explains how logging works in both the **browser client** (frontend) and the **application server/backend**. diff --git a/docs/getting-started/advanced-topics/monitoring/index.md b/docs/getting-started/advanced-topics/monitoring/index.md index 640872cd..4cc2c3eb 100644 --- a/docs/getting-started/advanced-topics/monitoring/index.md +++ b/docs/getting-started/advanced-topics/monitoring/index.md @@ -3,7 +3,7 @@ sidebar_position: 6 title: "πŸ“Š Monitoring Your Open WebUI" --- -## Keep Your Open WebUI Healthy with Monitoring 🩺 +# Keep Your Open WebUI Healthy with Monitoring 🩺 Monitoring your Open WebUI instance is crucial for ensuring it runs reliably, performs well, and allows you to quickly identify and resolve any issues. This guide outlines three levels of monitoring, from basic availability checks to in-depth model response testing. diff --git a/docs/tutorials/https-haproxy.md b/docs/tutorials/https-haproxy.md index 62aca46f..c18a5465 100644 --- a/docs/tutorials/https-haproxy.md +++ b/docs/tutorials/https-haproxy.md @@ -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/ diff --git a/docs/tutorials/https-nginx.md b/docs/tutorials/https-nginx.md index 39708d36..0d3b0241 100644 --- a/docs/tutorials/https-nginx.md +++ b/docs/tutorials/https-nginx.md @@ -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. diff --git a/docs/tutorials/images.md b/docs/tutorials/images.md index 5a97d4c3..c9476904 100644 --- a/docs/tutorials/images.md +++ b/docs/tutorials/images.md @@ -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. diff --git a/docs/tutorials/integrations/amazon-bedrock.md b/docs/tutorials/integrations/amazon-bedrock.md index c299d67e..d0040b01 100644 --- a/docs/tutorials/integrations/amazon-bedrock.md +++ b/docs/tutorials/integrations/amazon-bedrock.md @@ -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 diff --git a/docs/tutorials/integrations/backend-controlled-ui-compatible-flow.md b/docs/tutorials/integrations/backend-controlled-ui-compatible-flow.md index 265aa51c..16feca2d 100644 --- a/docs/tutorials/integrations/backend-controlled-ui-compatible-flow.md +++ b/docs/tutorials/integrations/backend-controlled-ui-compatible-flow.md @@ -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. diff --git a/docs/tutorials/integrations/browser-search-engine.md b/docs/tutorials/integrations/browser-search-engine.md index 0cec8398..3849bde1 100644 --- a/docs/tutorials/integrations/browser-search-engine.md +++ b/docs/tutorials/integrations/browser-search-engine.md @@ -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. diff --git a/docs/tutorials/integrations/continue-dev.md b/docs/tutorials/integrations/continue-dev.md index 5806e256..c8aa902e 100644 --- a/docs/tutorials/integrations/continue-dev.md +++ b/docs/tutorials/integrations/continue-dev.md @@ -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 diff --git a/docs/tutorials/integrations/firefox-sidebar.md b/docs/tutorials/integrations/firefox-sidebar.md index d8c7aa27..8942aafb 100644 --- a/docs/tutorials/integrations/firefox-sidebar.md +++ b/docs/tutorials/integrations/firefox-sidebar.md @@ -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 diff --git a/docs/tutorials/integrations/helicone.md b/docs/tutorials/integrations/helicone.md index affb2580..e27cf672 100644 --- a/docs/tutorials/integrations/helicone.md +++ b/docs/tutorials/integrations/helicone.md @@ -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. diff --git a/docs/tutorials/integrations/okta-oidc-sso.md b/docs/tutorials/integrations/okta-oidc-sso.md index 308d94a0..bdad5614 100644 --- a/docs/tutorials/integrations/okta-oidc-sso.md +++ b/docs/tutorials/integrations/okta-oidc-sso.md @@ -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 diff --git a/docs/tutorials/integrations/redis.md b/docs/tutorials/integrations/redis.md index 783eade9..8f073a42 100644 --- a/docs/tutorials/integrations/redis.md +++ b/docs/tutorials/integrations/redis.md @@ -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 diff --git a/docs/tutorials/jupyter.md b/docs/tutorials/jupyter.md index 8e73df82..ee20831c 100644 --- a/docs/tutorials/jupyter.md +++ b/docs/tutorials/jupyter.md @@ -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. ![Code Execution Configuration](/images/tutorials/jupyter/jupyter-code-execution.png) -## 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 ![Code Execution Configuration](/images/tutorials/jupyter/jupyter-token.png) -## 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: diff --git a/docs/tutorials/maintenance/backups.md b/docs/tutorials/maintenance/backups.md index 49db7abe..1e04e9da 100644 --- a/docs/tutorials/maintenance/backups.md +++ b/docs/tutorials/maintenance/backups.md @@ -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: diff --git a/docs/tutorials/offline-mode.md b/docs/tutorials/offline-mode.md index 019e517a..569c9cd6 100644 --- a/docs/tutorials/offline-mode.md +++ b/docs/tutorials/offline-mode.md @@ -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. diff --git a/docs/tutorials/s3-storage.md b/docs/tutorials/s3-storage.md index d543ae52..ab95a37b 100644 --- a/docs/tutorials/s3-storage.md +++ b/docs/tutorials/s3-storage.md @@ -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 diff --git a/docs/tutorials/speech-to-text/env-variables.md b/docs/tutorials/speech-to-text/env-variables.md index 244f9b66..1d4fd926 100644 --- a/docs/tutorials/speech-to-text/env-variables.md +++ b/docs/tutorials/speech-to-text/env-variables.md @@ -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 | |----------|-------------| diff --git a/docs/tutorials/text-to-speech/chatterbox-tts-api-integration.md b/docs/tutorials/text-to-speech/chatterbox-tts-api-integration.md index 492760ac..5b0ebb06 100644 --- a/docs/tutorials/text-to-speech/chatterbox-tts-api-integration.md +++ b/docs/tutorials/text-to-speech/chatterbox-tts-api-integration.md @@ -3,7 +3,7 @@ sidebar_position: 3 title: "πŸ—¨οΈ Chatterbox TTS β€” Voice Cloning" --- -## Chatterbox TTS β€” Voice Cloning +# Chatterbox TTS β€” Voice Cloning :::warning diff --git a/docs/tutorials/text-to-speech/openai-edge-tts-integration.md b/docs/tutorials/text-to-speech/openai-edge-tts-integration.md index 5f2a20c8..0fdf4395 100644 --- a/docs/tutorials/text-to-speech/openai-edge-tts-integration.md +++ b/docs/tutorials/text-to-speech/openai-edge-tts-integration.md @@ -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`? diff --git a/docs/tutorials/tips/contributing-tutorial.md b/docs/tutorials/tips/contributing-tutorial.md index a36623f7..ba39c1be 100644 --- a/docs/tutorials/tips/contributing-tutorial.md +++ b/docs/tutorials/tips/contributing-tutorial.md @@ -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.