Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: describe all the features in detail #2

Open
tjbck opened this issue Feb 22, 2024 · 1 comment
Open

doc: describe all the features in detail #2

tjbck opened this issue Feb 22, 2024 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@tjbck
Copy link
Contributor

tjbck commented Feb 22, 2024

No description provided.

@tjbck tjbck added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Feb 23, 2024
tjbck pushed a commit that referenced this issue Jun 3, 2024
Add tutorial: Local LLM Setup with IPEX-LLM on Intel GPU
@silentoplayz
Copy link
Collaborator

silentoplayz commented 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 - doc: pwa #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: New Apache Tika & Artifacts Docs Pages #336
  • Redis Websockets Integration: Best practices for enabling effective stateless instances suitable for scalable load balancing. PR: New "Redis Websockets" Docs Page #335 (Related - doc: stateless open-webui load balancing setup #224)
  • Webhook Integration: Instructions on setting up webhooks for new sign up notifications. PR: New Webhooks docs page #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.
  • Remote ChromaDB Support: Explanation and setup instructions for connecting to remote ChromaDB databases, including necessary configurations.

UI Customization and Control

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 - doc: faq #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 - doc: explain model switching use cases #26)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants