191 lines
16 KiB
Markdown
191 lines
16 KiB
Markdown
# OpenWebUI Extensions
|
||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||
[](#contributors-)
|
||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||
|
||
English | [中文](./README_CN.md)
|
||
|
||
A collection of enhancements, plugins, and prompts for [OpenWebUI](https://github.com/open-webui/open-webui), developed and curated for personal use to extend functionality and improve experience.
|
||
|
||
<!-- STATS_START -->
|
||
## 📊 Community Stats
|
||
>
|
||
> 
|
||
|
||
| 👤 Author | 👥 Followers | ⭐ Points | 🏆 Contributions |
|
||
| :---: | :---: | :---: | :---: |
|
||
| [Fu-Jie](https://openwebui.com/u/Fu-Jie) |  |  |  |
|
||
|
||
| 📝 Posts | ⬇️ Downloads | 👁️ Views | 👍 Upvotes | 💾 Saves |
|
||
| :---: | :---: | :---: | :---: | :---: |
|
||
|  |  |  |  |  |
|
||
|
||
### 🔥 Top 6 Popular Plugins
|
||
|
||
| Rank | Plugin | Version | Downloads | Views | 📅 Updated |
|
||
| :---: | :--- | :---: | :---: | :---: | :---: |
|
||
| 🥇 | [Smart Mind Map](https://openwebui.com/posts/turn_any_text_into_beautiful_mind_maps_3094c59a) |  |  |  |  |
|
||
| 🥈 | [Smart Infographic](https://openwebui.com/posts/smart_infographic_ad6f0c7f) |  |  |  |  |
|
||
| 🥉 | [Export to Word Enhanced](https://openwebui.com/posts/export_to_word_enhanced_formatting_fca6a315) |  |  |  |  |
|
||
| 4️⃣ | [Markdown Normalizer](https://openwebui.com/posts/markdown_normalizer_baaa8732) |  |  |  |  |
|
||
| 5️⃣ | [Async Context Compression](https://openwebui.com/posts/async_context_compression_b1655bc8) |  |  |  |  |
|
||
| 6️⃣ | [Export to Excel](https://openwebui.com/posts/export_mulit_table_to_excel_244b8f9d) |  |  |  |  |
|
||
|
||
### 📈 Total Downloads Trend
|
||
|
||
|
||
|
||
*See full stats and charts in [Community Stats Report](./docs/community-stats.md)*
|
||
<!-- STATS_END -->
|
||
|
||
## 🌟 Star Features
|
||
|
||
### 1. [GitHub Copilot SDK Pipe](https://openwebui.com/posts/github_copilot_official_sdk_pipe_ce96f7b4) [](https://openwebui.com/posts/github_copilot_official_sdk_pipe_ce96f7b4)
|
||
|
||
**The ultimate Agent for OpenWebUI.** Supports native code execution (Python/Pandas), raw file analysis, and interactive artifacts.
|
||
> [!TIP]
|
||
> **No GitHub Copilot subscription required!** Supports **BYOK (Bring Your Own Key)** mode using your own OpenAI/Anthropic API keys.
|
||
|
||
#### 🌟 Featured Real-World Cases
|
||
|
||
- **[GitHub Star Forecasting](./docs/plugins/pipes/star-prediction-example.md)**: Automatically parsing CSV data, writing analysis scripts, and generating interactive growth dashboards.
|
||
- **[Video Optimization](./docs/plugins/pipes/video-processing-example.md)**: Direct control of system-level tools (FFmpeg) to accelerate and compress media with professional color optimization.
|
||
|
||
### 2. [Smart Mind Map](https://openwebui.com/posts/turn_any_text_into_beautiful_mind_maps_3094c59a) [](https://openwebui.com/posts/turn_any_text_into_beautiful_mind_maps_3094c59a)
|
||
|
||
**Experience interactive thinking.** Seamlessly transforms complex chat sessions into structured, clickable mind maps for better visual modeling and rapid idea extraction.
|
||
|
||
### 3. [Smart Infographic](https://openwebui.com/posts/smart_infographic_ad6f0c7f) [](https://openwebui.com/posts/smart_infographic_ad6f0c7f)
|
||
|
||
**Professional data storytelling.** Converts raw information into sleek, boardroom-ready infographics powered by AntV, perfect for summarizing long-form content instantly.
|
||
|
||
### 4. [Export to Word Enhanced](https://openwebui.com/posts/export_to_word_enhanced_formatting_fca6a315) [](https://openwebui.com/posts/export_to_word_enhanced_formatting_fca6a315)
|
||
|
||
**High-fidelity reporting.** Export conversation history into professionally formatted Word documents with preserved headers, code blocks, and math formulas.
|
||
|
||
### 5. [Async Context Compression](https://openwebui.com/posts/async_context_compression_b1655bc8) [](https://openwebui.com/posts/async_context_compression_b1655bc8)
|
||
|
||
**Maximize your context window.** Intelligently compresses chat history using LLM logic to save tokens and costs while maintaining a high-quality reasoning chain.
|
||
|
||
## 📦 Project Contents
|
||
|
||
<!-- markdownlint-disable MD033 -->
|
||
<details>
|
||
<summary><b>🧩 Plugins (Actions, Filters, Pipes, Pipelines)</b></summary>
|
||
|
||
Located in the `plugins/` directory, containing Python-based enhancements:
|
||
|
||
### Actions
|
||
|
||
- **Smart Mind Map** (`smart-mind-map`): Generates interactive mind maps from text.
|
||
- **Smart Infographic** (`infographic`): Transforms text into professional infographics using AntV.
|
||
- **Flash Card** (`flash-card`): Quickly generates beautiful flashcards for learning.
|
||
- **Deep Dive** (`deep-dive`): A comprehensive thinking lens that dives deep into any content.
|
||
- **Export to Excel** (`export_to_excel`): Exports chat history to Excel files.
|
||
- **Export to Word** (`export_to_docx`): Exports chat history to Word documents.
|
||
|
||
### Filters
|
||
|
||
- **GitHub Copilot SDK Files Filter** (`github_copilot_sdk_files_filter`): Essential companion for Copilot SDK. Bypasses RAG to ensure full file accessibility for Agents.
|
||
- **Web Gemini Multimodal Filter** (`web_gemini_multimodel_filter`): Adds multimodal capabilities (PDF, Video, Office) to any model with intelligent routing.
|
||
- **Async Context Compression** (`async-context-compression`): Optimizes token usage via context compression.
|
||
- **Context Enhancement** (`context_enhancement_filter`): Enhances chat context.
|
||
- **Folder Memory** (`folder-memory`): Automatically extracts project rules from conversations and injects them into the folder's system prompt.
|
||
- **Markdown Normalizer** (`markdown_normalizer`): Fixes common Markdown formatting issues in LLM outputs.
|
||
|
||
### Pipes
|
||
|
||
- **GitHub Copilot SDK** (`github-copilot-sdk`): Official GitHub Copilot SDK integration. Supports dynamic models (GPT-4o, Claude 3.5, o1), multi-turn conversation, streaming, and infinite sessions.
|
||
|
||
### Pipelines
|
||
|
||
- **MoE Prompt Refiner** (`moe_prompt_refiner`): Refines prompts for Mixture of Experts (MoE) summary requests to generate high-quality comprehensive reports.
|
||
|
||
</details>
|
||
<!-- markdownlint-enable MD033 -->
|
||
|
||
<!-- markdownlint-disable MD033 -->
|
||
<details>
|
||
<summary><b>🎯 Prompts (System Prompts for various roles)</b></summary>
|
||
|
||
System Prompts are managed in the `docs/prompts/` directory:
|
||
|
||
- **[Prompt Library](./docs/prompts/library.md)**: A curated collection of fine-tuned prompts for Coding, Marketing, and Analysis.
|
||
|
||
</details>
|
||
<!-- markdownlint-enable MD033 -->
|
||
|
||
## 🛠️ Extensions
|
||
|
||
Standalone frontend extensions to supercharge your Open WebUI:
|
||
|
||
- **[Open WebUI Prompt Plus](https://github.com/Fu-Jie/open-webui-prompt-plus)**: An all-in-one prompt management suite featuring AI-powered prompt generation, spotlight-style quick search, and advanced category organization.
|
||
|
||
## 📖 Documentation
|
||
|
||
Located in the `docs/en/` directory:
|
||
|
||
- **[Plugin Development Guide](./docs/en/plugin_development_guide.md)** - The authoritative guide covering everything from getting started to advanced patterns and best practices. ⭐
|
||
|
||
For code examples, please check the `docs/examples/` directory.
|
||
|
||
## 🚀 Quick Start
|
||
|
||
This project is a collection of resources and does not require a Python environment. Simply download the files you need and import them into your OpenWebUI instance.
|
||
|
||
### Using Prompts
|
||
|
||
1. Browse the `/prompts` directory and select a prompt file (`.md`).
|
||
2. Copy the file content.
|
||
3. In the OpenWebUI chat interface, click the "Prompt" button above the input box.
|
||
4. Paste the content and save.
|
||
|
||
### Using Plugins
|
||
|
||
1. **Install from OpenWebUI Community (Recommended)**:
|
||
- Visit my profile: [Fu-Jie's Profile](https://openwebui.com/u/Fu-Jie)
|
||
- Browse the plugins and select the one you like.
|
||
- Click "Get" to import it directly into your OpenWebUI instance.
|
||
|
||
2. **Manual Installation**:
|
||
- Browse the `/plugins` directory and download the plugin file (`.py`) you need.
|
||
- Go to OpenWebUI **Admin Panel** -> **Settings** -> **Plugins**.
|
||
- Click the upload button and select the `.py` file you just downloaded.
|
||
- Once uploaded, refresh the page to enable the plugin in your chat settings or toolbar.
|
||
|
||
### Contributing
|
||
|
||
If you have great prompts or plugins to share:
|
||
|
||
1. Fork this repository.
|
||
2. Add your files to the appropriate `prompts/` or `plugins/` directory.
|
||
3. Submit a Pull Request.
|
||
|
||
[Contributing](./CONTRIBUTING.md)
|
||
|
||
## Contributors ✨
|
||
|
||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||
<!-- prettier-ignore-start -->
|
||
<!-- markdownlint-disable -->
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rbb-dev"><img src="https://avatars.githubusercontent.com/u/37469229?v=4?s=100" width="100px;" alt="rbb-dev"/><br /><sub><b>rbb-dev</b></sub></a><br /><a href="#ideas-rbb-dev" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/Fu-Jie/openwebui-extensions/commits?author=rbb-dev" title="Code">💻</a></td>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://trade.xyz/?ref=BZ1RJRXWO"><img src="https://avatars.githubusercontent.com/u/7317522?v=4?s=100" width="100px;" alt="Raxxoor"/><br /><sub><b>Raxxoor</b></sub></a><br /><a href="https://github.com/Fu-Jie/openwebui-extensions/issues?q=author%3Adhaern" title="Bug reports">🐛</a> <a href="#ideas-dhaern" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/i-iooi-i"><img src="https://avatars.githubusercontent.com/u/1827701?v=4?s=100" width="100px;" alt="ZOLO"/><br /><sub><b>ZOLO</b></sub></a><br /><a href="https://github.com/Fu-Jie/openwebui-extensions/issues?q=author%3Ai-iooi-i" title="Bug reports">🐛</a> <a href="#ideas-i-iooi-i" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://perso.crans.org/grande/"><img src="https://avatars.githubusercontent.com/u/469017?v=4?s=100" width="100px;" alt="Johan Grande"/><br /><sub><b>Johan Grande</b></sub></a><br /><a href="#ideas-nahoj" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/abaroni"><img src="https://avatars.githubusercontent.com/u/21365486?v=4?s=100" width="100px;" alt="Alessandro Baroni"/><br /><sub><b>Alessandro Baroni</b></sub></a><br /><a href="#ideas-abaroni" title="Ideas, Planning, & Feedback">🤔</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<!-- markdownlint-restore -->
|
||
<!-- prettier-ignore-end -->
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||
|
||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|