doc: describe all the features in detail #3

New Issue

2026-02-15T17:04:57-05:00

yindo commented

2026-02-15 17:04:57 -05:00

Originally created by @tjbck on GitHub (Feb 21, 2024).

yindo added the enhancement help wanted good first issue labels 2026-02-15 17:04:57 -05:00

yindo commented

2026-02-15 17:04:57 -05:00

@silentoplayz commented on GitHub (Aug 30, 2024):

As someone who has gained experience with Open WebUI and identified common pain points for users, I'd like to compile a list of areas where additional documentation would greatly benefit the community. Unfortunately, without sufficient resources, many users have struggled to overcome common hurdles and unlock the full potential of the platform. My hope is that by sharing this list, I can encourage the Open WebUI community to contribute their knowledge and expertise to help create comprehensive and user-friendly documentation.

Connectivity and Authentication

API Key Management: Secure handling and revocation of API keys
Authentication Options: An overview of available authentication methods, including API key, OAuth, email/password, and an explanation of their respective benefits and limitations.
HTTP/S Proxy Support: Configuration and setup for HTTP and HTTPS proxy servers
Progressive Web App (PWA): Step-by-step guide on how to add Open WebUI to your iOS/Android device's homescreen. (Related - https://github.com/open-webui/docs/issues/91)
LDAP

Integration and Configuration

Apache Tika Extraction Engine Integration for RAG: Detailed instructions on using the Tika extraction engine as a document loader for RAG, including setup and troubleshooting. PR: https://github.com/open-webui/docs/pull/336
Redis Websockets Integration: Best practices for enabling effective stateless instances suitable for scalable load balancing. PR: https://github.com/open-webui/docs/pull/335 (Related - https://github.com/open-webui/docs/issues/224)
Webhook Integration: Instructions on setting up webhooks for new sign up notifications. PR: https://github.com/open-webui/docs/pull/320
LibreTranslate Integration: Instructions on setting up pipeline/filter function/action button for LibreTranslate integration.
Azure Speech Service Integration A walk-through on integrating Azure Speech services for Text-to-Speech (TTS), including necessary configurations and requirements.
External Database Support: Instructions on database integration using the DATABASE_URL environment variable, including configuring database connections and migrations.
External Ollama Server Connectivity: Step-by-step guide on connecting to external Ollama servers, including authentication and error handling.
External Speech-to-Text Support: Documentation on integrating with external speech-to-text services, including setup, configuration, and error handling.

External Vector Database Support

Remote ChromaDB Integration: Explanation and setup instructions for connecting to remote ChromaDB databases, including necessary configurations.
PGVector Database Integration: Instructions on connecting to PGVector databases using the DATABASE_URL environment variable, including setup, configuration, and best practices.
Milvus Vector Database Integration: Guide on integrating with Milvus vector databases, covering installation, authentication, and optimizing query performance.
Qdrant Vector Database Integration: Documentation for Qdrant database integration, including setup instructions, configuration options, and troubleshooting tips.

UI Customization and Control

Chat Controls & Chat Overview: Documentation on per-chat basis chat controls & chat overview sidebar (Related - https://github.com/open-webui/docs/issues/223)
Configurable Notification Banners: Customizable notification banners (database overrides what is set in your env var/database takes precedence over env var WEBUI_BANNERS) PR: https://github.com/open-webui/docs/pull/321
MermaidJS Chart Rendering: Provide an overview on how to use MermaidJS chart rendering in Open WebUI. PR: https://github.com/open-webui/docs/pull/332

Advanced Features and Troubleshooting

Call User Interface: In-depth explanation of the Call User Interface, including its features and functionality.
Extended FAQ section: Additional questions and answers for troubleshooting, covering common issues, configuration questions, and usage queries. (Related - https://github.com/open-webui/docs/issues/3)
Memory (Experimental): Information about experimental memory management options and how the feature works
RAG (Reset Vector Storage and Re-import Documents): Step-by-step guide on resetting Vector Storage and re-importing documents for RAG.
RAG: Extensive guide on how RAG works within Open WebUI, including setup, configuration, and troubleshooting.

Model Management and Updates

Model Builder: Comprehensive documentation on creating and managing custom models for the chat interface.
Pull/Update/Delete Models: Instructions on updating, pulling, and deleting models in Open WebUI.
Multi-Modal Conversations: Explain the use cases of switching between models or using more than a single model. (Related - https://github.com/open-webui/docs/issues/26)

@silentoplayz commented on GitHub (Aug 30, 2024): As someone who has gained experience with Open WebUI and identified common pain points for users, I'd like to compile a list of areas where additional documentation would greatly benefit the community. Unfortunately, without sufficient resources, many users have struggled to overcome common hurdles and unlock the full potential of the platform. My hope is that by sharing this list, I can encourage the Open WebUI community to contribute their knowledge and expertise to help create comprehensive and user-friendly documentation. ### Connectivity and Authentication * **API Key Management**: Secure handling and revocation of API keys * **Authentication Options**: An overview of available authentication methods, including API key, OAuth, email/password, and an explanation of their respective benefits and limitations. * **HTTP/S Proxy Support**: Configuration and setup for HTTP and HTTPS proxy servers * **Progressive Web App (PWA)**: Step-by-step guide on how to add Open WebUI to your iOS/Android device's homescreen. (Related - https://github.com/open-webui/docs/issues/91) * **LDAP** ### Integration and Configuration * ~~**Apache Tika Extraction Engine Integration for RAG**: Detailed instructions on using the `Tika` extraction engine as a document loader for RAG, including setup and troubleshooting.~~ **PR: https://github.com/open-webui/docs/pull/336** * ~~**Redis Websockets Integration**: Best practices for enabling effective stateless instances suitable for scalable load balancing.~~ **PR: https://github.com/open-webui/docs/pull/335** (Related - https://github.com/open-webui/docs/issues/224) * ~~**Webhook Integration**: Instructions on setting up webhooks for new sign up notifications.~~ **PR: https://github.com/open-webui/docs/pull/320** * **LibreTranslate Integration**: Instructions on setting up pipeline/filter function/action button for LibreTranslate integration. * **Azure Speech Service Integration** A walk-through on integrating Azure Speech services for Text-to-Speech (TTS), including necessary configurations and requirements. * **External Database Support**: Instructions on database integration using the `DATABASE_URL` environment variable, including configuring database connections and migrations. * **External Ollama Server Connectivity**: Step-by-step guide on connecting to external Ollama servers, including authentication and error handling. * **External Speech-to-Text Support**: Documentation on integrating with external speech-to-text services, including setup, configuration, and error handling. ### External Vector Database Support * **Remote ChromaDB Integration**: Explanation and setup instructions for connecting to remote `ChromaDB` databases, including necessary configurations. * **PGVector Database Integration**: Instructions on connecting to PGVector databases using the `DATABASE_URL` environment variable, including setup, configuration, and best practices. * **Milvus Vector Database Integration**: Guide on integrating with Milvus vector databases, covering installation, authentication, and optimizing query performance. * **Qdrant Vector Database Integration**: Documentation for Qdrant database integration, including setup instructions, configuration options, and troubleshooting tips. ### UI Customization and Control * **Chat Controls & Chat Overview**: Documentation on per-chat basis chat controls & chat overview sidebar (Related - https://github.com/open-webui/docs/issues/223) * ~~**Configurable Notification Banners**: Customizable notification banners (database overrides what is set in your env var/database takes precedence over env var `WEBUI_BANNERS`)~~ **PR: https://github.com/open-webui/docs/pull/321** * ~~**MermaidJS Chart Rendering**: Provide an overview on how to use MermaidJS chart rendering in Open WebUI.~~ **PR: https://github.com/open-webui/docs/pull/332** ### Advanced Features and Troubleshooting * **Call User Interface**: In-depth explanation of the Call User Interface, including its features and functionality. * **Extended FAQ section**: Additional questions and answers for troubleshooting, covering common issues, configuration questions, and usage queries. (Related - https://github.com/open-webui/docs/issues/3) * **Memory (Experimental)**: Information about experimental memory management options and how the feature works * **RAG (Reset Vector Storage and Re-import Documents)**: Step-by-step guide on resetting Vector Storage and re-importing documents for RAG. * **RAG**: Extensive guide on how RAG works within Open WebUI, including setup, configuration, and troubleshooting. ### Model Management and Updates * **Model Builder**: Comprehensive documentation on creating and managing custom models for the chat interface. * **Pull/Update/Delete Models**: Instructions on updating, pulling, and deleting models in Open WebUI. * **Multi-Modal Conversations**: Explain the use cases of switching between models or using more than a single model. (Related - https://github.com/open-webui/docs/issues/26)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: open-webui/docs#3