Merge branch 'main' into patch-1

docs/contributing.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 9
+sidebar_position: 1000
 title: "🤝 Contributing"
 ---
 

docs/faq.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 600
 title: "📋 FAQ"
 ---
 

docs/features.md

@@ -0,0 +1,180 @@
+---
+sidebar_position: 3
+title: "⭐ Features"
+---
+
+## Key Features of Open WebUI ⭐
+
+- 🚀 **Effortless Setup**: Install seamlessly using Docker or Kubernetes (kubectl, kustomize or helm) for a hassle-free experience with support for both `:ollama` and `:cuda` tagged images.
+
+- 🤝 **OpenAI API Integration**: Effortlessly integrate OpenAI-compatible APIs for versatile conversations alongside Ollama models. Customize the OpenAI API URL to link with **LMStudio, GroqCloud, Mistral, OpenRouter, and more**.
+
+- 📱 **Responsive Design**: Enjoy a seamless experience across Desktop PC, Laptop, and Mobile devices.
+
+- 📱 **Progressive Web App (PWA) for Mobile**: Enjoy a native app-like experience on your mobile device with our PWA, providing offline access on localhost and a seamless user interface.
+
+- ✒️🔢 **Full Markdown and LaTeX Support**: Elevate your LLM experience with comprehensive Markdown and LaTeX capabilities for enriched interaction.
+
+- 🧩 **Model Builder**: Easily create Ollama models via the Web UI. Create and add custom characters/agents, customize chat elements, and import models effortlessly through [Open WebUI Community](https://openwebui.com/) integration.
+
+- 📚 **Local RAG Integration**: Dive into the future of chat interactions with groundbreaking Retrieval Augmented Generation (RAG) support. This feature seamlessly integrates document interactions into your chat experience. You can load documents directly into the chat or add files to your document library, effortlessly accessing them using the `#` command before a query.
+
+- 🔍 **Web Search for RAG**: Perform web searches using providers like `SearXNG`, `Google PSE`, `Brave Search`, `serpstack`, and `serper`, and inject the results directly into your chat experience.
+
+- 🌐 **Web Browsing Capability**: Seamlessly integrate websites into your chat experience using the `#` command followed by a URL. This feature allows you to incorporate web content directly into your conversations, enhancing the richness and depth of your interactions.
+
+- 🎨 **Image Generation Integration**: Seamlessly incorporate image generation capabilities using options such as AUTOMATIC1111 API or ComfyUI (local), and OpenAI's DALL-E (external), enriching your chat experience with dynamic visual content.
+
+- ⚙️ **Many Models Conversations**: Effortlessly engage with various models simultaneously, harnessing their unique strengths for optimal responses. Enhance your experience by leveraging a diverse set of models in parallel.
+
+- 🔐 **Role-Based Access Control (RBAC)**: Ensure secure access with restricted permissions; only authorized individuals can access your Ollama, and exclusive model creation/pulling rights are reserved for administrators.
+
+- 🌐🌍 **Multilingual Support**: Experience Open WebUI in your preferred language with our internationalization (i18n) support. Join us in expanding our supported languages! We're actively seeking contributors!
+
+- 🌟 **Continuous Updates**: We are committed to improving Open WebUI with regular updates, fixes, and new features.
+
+## And many more remarkable features including... ⚡️
+
+---
+
+### 🖥️ User Experience
+
+- 🖥️ **Intuitive Interface**: Our chat interface takes inspiration from ChatGPT user interface, ensuring a user-friendly experience.
+
+- ⚡ **Swift Responsiveness**: Enjoy reliably fast and responsive performance.
+
+- 🎨 **Splash Screen**: A simple loading splash screen for a smoother user experience.
+
+- 📦 **Pip Install Method (Soon/WIP)**: Install Open WebUI using pip, simplifying the installation process and making it even easier for newcomers to get started.
+
+- 🌈 **Theme Customization**: Choose from a variety of solid, yet sleek themes to personalize your Open WebUI experience. Choose between either Light, Dark, or OLED Dark mode; or simply let your system choose for you!
+
+- 💻 **Code Syntax Highlighting**: Enjoy enhanced code readability with our syntax highlighting feature.
+
+- ↕️ **Bi-Directional Chat Support**: Easily switch between left-to-right and right-to-left chat directions to accommodate various language preferences.
+
+- 📱 **Mobile Accessibility**: Seamlessly open and close the sidebar on mobile devices with intuitive swipe gestures.
+
+- 💾 **Persistent Settings**: Enjoy the convenience of saved settings, stored in a config.json file for easy access and reuse.
+
+---
+
+### 💬 Conversations
+
+- 📂 **Unified Workspace**: Access all your model files, prompts, documents, and a playground in one convenient location, streamlining your workflow.
+
+- 🔍 **RAG Embedding Support**: Change the RAG embedding model directly in document settings, enhancing document processing. This feature supports Ollama and OpenAI models.
+
+- 🔄 **Multi-Modal Support**: Seamlessly engage with models that support multimodal interactions, including images (e.g., LLava).
+
+- 🤖 **Multiple Model Support**: Seamlessly switch between different chat models for diverse interactions.
+
+- ⚙️ **Fine-Tuned Control with Advanced Parameters**: Gain a deeper level of control by adjusting parameters such as temperature, context length, and seed, and define your system prompts to tailor the conversation to your specific preferences and needs.
+
+- 🏷️ **Conversation Tagging**: Effortlessly categorize and locate specific chats for quick reference and streamlined data collection.
+
+- 📜 **Prompt Preset Support**: Instantly access preset prompts using the `/` command in the chat input. Load predefined conversation starters effortlessly and expedite your interactions. Effortlessly import prompts through [Open WebUI Community](https://openwebui.com/) integration.
+
+- ⬆️ **GGUF File Model Creation**: Effortlessly create Ollama models by uploading GGUF files directly from the Web UI. Streamlined process with options to upload from your machine or download GGUF files from Hugging Face.
+
+- 🧠 **Experimental Memory Feature**: Manually input personal information you want LLMs to remember via Settings > Personalization > Memory.
+
+- 📜 **Citations in RAG Feature**: Easily track the context fed to the LLM with added citations in the RAG feature.
+
+- 🌟 **Enhanced RAG Pipeline**: With hybrid searching via `BM25`, reranking powered by `CrossEncoder`, and configurable relevance score thresholds.
+
+- 📹 **Youtube RAG Pipeline**: Dedicated RAG pipeline for YouTube videos, enabling interaction with video transcriptions directly.
+
+---
+
+### 💻 Model Management
+
+- 🔍 **Model Selector**: Easily find and select custom models with search filter and detailed model information.
+
+- 📥🗑️ **Download/Delete Models**: Easily download or delete models directly from Open WebUI.
+
+- 🔄 **Seamless Integration**: Copy `ollama run {model:tag}` directly from a model's page on [Ollama library](https://ollama.com/library/) to easily select and pull models.
+
+- 🔄 **Update All Ollama Models**: Easily update locally installed models all at once with a convenient button, streamlining model management.
+
+- 💡 **LLM Response Insights**: View generation details for every response, including external model API insights and comprehensive local model info.
+
+---
+
+### 👥 Collaboration
+
+- 🗨️ **Local Chat Sharing**: Generate and share chat links seamlessly between users, enhancing collaboration and communication.
+
+- 👍👎 **RLHF Annotation**: Empower your messages by rating them with thumbs up and thumbs down, followed by the option to provide textual feedback, facilitating the creation of datasets for Reinforcement Learning from Human Feedback (RLHF). Utilize your messages to train or fine-tune models, all while ensuring the confidentiality of locally saved data.
+
+---
+
+### 📚 History and Archive
+
+- 🔄 **Regeneration History Access**: Easily revisit and explore your entire regeneration history.
+
+- 📜 **Chat History**: Effortlessly access and manage your conversation history.
+
+- 📬 **Archive Chats**: Effortlessly store away completed conversations with LLMs for future reference or interaction, maintaining a tidy and clutter-free chat interface while allowing for easy retrieval.
+
+- 📤📥 **Import/Export Chat History**: Seamlessly move your chat data in and out of the platform.
+
+- 📄 **Chat Download as PDF/TXT**: Easily download chats in .PDF or .txt format.
+
+---
+
+### 🎙️ Accessibility
+
+- 🗣️ **Voice Input Support**: Engage with your model through voice interactions; enjoy the convenience of talking to your model directly. Additionally, explore the option for sending voice input automatically after 3 seconds of silence for a streamlined experience.
+
+- 👥 **'@' Model Integration**: Harness the collective intelligence of multiple models in a single chat by seamlessly switching to any acessible local or external model during conversations by using the `@` command to specify the model by name.
+
+- 🔊 **Configurable Text-to-Speech Endpoint**: Customize your Text-to-Speech experience with configurable OpenAI endpoints.
+
+---
+
+### 🐍 Code Execution
+
+- 🐍 **Python Code Execution**: Execute Python code locally in the browser via Pyodide with libraries like `requests`, `beautifulsoup4`, `numpy`, `pandas`, `seaborn`, `matplotlib`, `scikit-learn`, `scipy`, & `regex`.
+
+- 🚀 **Flexible, UI-Agnostic OpenAI-Compatible Pipelines (WIP)**: Seamlessly integrate and customize pipelines for efficient data processing and model training, ensuring ultimate flexibility and scalability.
+
+---
+
+### 🔒 Integration and Security
+
+- ✨ **Multiple OpenAI-Compatible API Support**: Seamlessly integrate and customize various OpenAI-compatible APIs, enhancing the versatility of your chat interactions.
+
+- 🔑 **Simplified API Key Management**: Easily generate and manage secret keys to leverage Open WebUI with OpenAI libraries, streamlining integration and development.
+
+- 🌐🔗 **External Ollama Server Connectivity**: Seamlessly link to an external Ollama server hosted on a different address by configuring the environment variable.
+
+- 🛢️ **External Database Support**: Seamlessly connect to custom SQLite or Postgres databases using the `DATABASE_URL` environment variable.
+
+- 🌐 **Remote ChromaDB Support**: Expand your database capabilities with the ability to connect to remote ChromaDB servers.
+
+- 🔀 **Multiple Ollama Instance Load Balancing**: Effortlessly distribute chat requests across multiple Ollama instances for enhanced performance and reliability.
+
+---
+
+### 👑 Administration
+
+- 👑 **Super Admin Assignment**: Automatically assign the first signup as a super admin as an unchangeable role that cannot be modified by other admins.
+
+- 🛡️ **Granular User Permissions**: Restrict user actions and access with customizable role-based permissions, ensuring that only authorized individuals can perform specific tasks.
+
+- 👥 **Multi-User Management**: Seamlessly manage multiple users through our intuitive admin panel with pagination, streamlining user administration and simplifying user lifecycle management.
+
+- 🔧 **Admin Panel**: Streamlined user management with options to add users directly or in bulk via CSV import, making user onboarding and management efficient.
+
+- 🔗 **Webhook Integration**: Subscribe to new user sign-up events via webhook (compatible with Discord, Google Chat and Microsoft Teams), providing real-time notifications and automation capabilities.
+
+- 📣 **Configurable Notification Banners**: Admins can create customizable banners with persistence in config.json, featuring options for content, background color (info, warning, error, or success), and dismissibility. These banners are only accessible to logged-in users, ensuring sensitive information remains private.
+
+- 🛡️ **Model Whitelisting**: Enhance security and access control by allowing admins to whitelist models for users with the `user` role, ensuring that only authorized models can be accessed.
+
+- 📧 **Trusted Email Authentication**: Authenticate using a trusted email header, adding an extra layer of security and authentication to protect your Web UI.
+
+- 🔒 **Backend Reverse Proxy Support**: Bolster security through direct communication between Open WebUI backend and Ollama. This key feature eliminates the need to expose Ollama over LAN. Requests made to the `/ollama/api` route from the Web UI are seamlessly redirected to Ollama from the backend, enhancing overall system security.
+
+- 🔓 **Optional Authentication**: Enjoy the flexibility to disable authentication by setting WEBUI_AUTH to False, ideal for fresh installations without existing users.

docs/getting-started/env-configuration.md

@@ -16,7 +16,7 @@ Here is a list of supported environment variables used by `backend/config.py` in
   - **Docker Default**: `prod`
 - Description: Environment setting.
 
-### `WEBUI_AUTH`
+#### `WEBUI_AUTH`
 
 - Default Setting: `True`
 - Description: This setting enables or disables authentication. If set to False, authentication is disabled. However, it's important to note that turning off authentication is only possible for fresh installations without any existing users. If there are already users registered, you cannot disable authentication directly. Ensure that no users are present in the database if you intend to turn off `WEBUI_AUTH`.
@@ -109,6 +109,12 @@ Here is a list of supported environment variables used by `backend/config.py` in
 - Docker Default: Randomly generated on first start
 - Description: Overrides the randomly generated string used for JSON Web Token.
 
+#### `JWT_EXPIRES_IN`
+
+- Default: `-1`
+- Description: Sets the JWT expiration time in seconds. A value of -1 disables expiration.
+
+
 #### `USE_CUDA_DOCKER`
 
 - Default: `False`
@@ -280,6 +286,41 @@ Query: [query]
 
 - Description: Template to use when injecting RAG documents into chat completion
 
+#### `RAG_RERANKING_MODEL`
+
+- Default: ``
+- Description: Sets a model for reranking results. Locally, a Sentence-Transformer model is used.
+
+#### `RAG_RERANKING_MODEL_AUTO_UPDATE`
+
+- Default: `False`
+- Description: Toggles automatic update of the reranking model.
+
+#### `RAG_RERANKING_MODEL_TRUST_REMOTE_CODE`
+
+- Default: `False`
+- Description: Determines whether or not to allow custom models defined on the Hub in their own modeling files for reranking.
+
+#### `RAG_OPENAI_API_BASE_URL`
+
+- Default: `${OPENAI_API_BASE_URL}`
+- Description: Sets the OpenAI base API URL to use for RAG embeddings.
+
+#### `RAG_OPENAI_API_KEY`
+
+- Default: `${OPENAI_API_KEY}`
+- Description: Sets the OpenAI API key to use for RAG embeddings.
+
+#### `ENABLE_RAG_LOCAL_WEB_FETCH`
+
+- Default: `False`
+- Description: Enables local web fetching for RAG. Enabling this allows Server Side Request Forgery attacks against local network resources.
+
+#### `YOUTUBE_LOADER_LANGUAGE`
+
+- Default: `en`
+- Description: Sets the language to use for YouTube video loading.
+
 #### `CHUNK_SIZE`
 
 - Default: `1500`
@@ -319,6 +360,16 @@ Query: [query]
 - Default: `${OPENAI_API_KEY}`
 - Description: Sets the API key to use for text-to-speech.
 
+#### `AUDIO_OPENAI_API_MODEL`
+
+- Default: `tts-1`
+- Description: Specifies the OpenAI text-to-speech model to use.
+
+#### `AUDIO_OPENAI_API_VOICE`
+
+- Default: `alloy`
+- Description: Sets the OpenAI text-to-speech voice to use.
+
 ### Image Generation
 
 #### `ENABLE_IMAGE_GENERATION`

docs/intro.md → docs/intro.mdx

@@ -5,6 +5,29 @@ title: 🏡 Home
 hide_title: true
 ---
 
+import { TopBanner } from "@site/src/components/Sponsors/TopBanner";
+
+<TopBanner
+  items={[
+    {
+      imgSrc: "/ads/pipelines-banner.png",
+      mobileImgSrc: "/ads/pipelines-banner-mobile.png",
+      url: "https://github.com/open-webui/pipelines",
+      name: "Open WebUI Pipelines",
+      description:
+        "Pipelines: Versatile, UI-Agnostic OpenAI-Compatible Plugin Framework",
+    },
+    {
+      imgSrc: "/ads/placeholder.png",
+      mobileImgSrc: "/ads/placeholder-mobile.png",
+      url: "https://github.com/sponsors/tjbck",
+      name: "Open WebUI",
+      description:
+        "The top banner spot is reserved for only two Enterprise Diamond sponsors on a first-come, first-served basis",
+    },
+  ]}
+/>
+
 # Open WebUI
 
 **Open WebUI is an extensible, feature-rich, and user-friendly self-hosted WebUI designed to operate entirely offline.** It supports various LLM runners, including Ollama and OpenAI-compatible APIs.

docs/migration.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 800
 title: "🔄 Migration"
 ---
 

docs/research.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 8
+sidebar_position: 900
 title: "🧑‍🔬 Open WebUI for Research"
 ---
 

docs/roadmap.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 700
 title: "🛣️ Roadmap"
 ---
 

docs/sponsorships.md

@@ -0,0 +1,22 @@
+---
+sidebar_position: 1100
+title: "🌐 Sponsorships"
+---
+
+# 🤝 Sponsorships
+
+At Open WebUI, our community always comes first. Sponsors are welcome, but they must respect our community-first approach. This philosophy guides all our sponsorship policies.
+
+## Hard Rules
+
+These are the non-negotiable rules for sponsors:
+
+- Sponsors will always be clearly identified as sponsors.
+- Aggressive sales tactics directed at our community members are strictly prohibited.
+- We don’t sell personal information about our community members to sponsors (e.g., to add to their mailing list).
+
+## Soft Rules
+
+Our community members should not be treated as sales leads.
+
+We expect sponsors to be exemplary community members. It’s acceptable to subtly promote job openings at your company and showcase your product, but hard selling is not allowed. Additionally, do not ask community members to join your mailing list.

docs/troubleshooting/index.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 400
 title: "🛠️ Troubleshooting"
 ---
 

docs/tutorial-deployment/index.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 500
 title: "☁️  Deployment"
 ---
 
@@ -12,7 +12,10 @@ title: "☁️  Deployment"
 👋 Calling all youtubers! Want to showcase Open WebUI's features in a video? We'll feature it at the top of our guide section!
 :::
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/QHuTBksNt_w?si=l99ZFxeNbbPcyfch" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/QHuTBksNt_w?si=l99ZFxeNbbPcyfch" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Gyvy9JpDVBw?si=qUf0DVd4bnp_ndzH" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 
 <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Ic5BRW_nLok?si=zhQXPqb0PuKqg3u1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 

docs/tutorial/_category_.json

@@ -1,6 +1,6 @@
 {
     "label": "📝 Tutorial",
-    "position": 3,
+    "position": 300,
     "link": {
         "type": "generated-index"
     }

docs/tutorial/apache.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 7
+title: "Hosting UI and Models separately"
+---
+
 # Hosting UI and Models separately
 
 :::note