docs(readme): refresh plugin badge layout and mirrors

- update plugin README badge rows and mirrored docs
- sync README template and scaffolder guidance

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
fujie
2026-03-16 01:21:11 +08:00
parent 4feb1bdd80
commit 64af4276a7
72 changed files with 2820 additions and 845 deletions

View File

@@ -1,42 +1,111 @@
# Plugin Center
Welcome to the OpenWebUI Extensions Plugin Center! Here you'll find a comprehensive collection of plugins to enhance your OpenWebUI experience.
Choose the right OpenWebUI plugin by the outcome you want, then scan the current catalog once you know your lane.
## Plugin Types
> **Recommended route:** start by goal → open the recommended plugin docs → install from OpenWebUI Community or the repo source file.
OpenWebUI supports four types of plugins, each serving a different purpose:
## Start by Goal
<div class="grid cards" markdown>
- :material-gesture-tap:{ .lg .middle } **Actions**
- :material-brush-variant:{ .lg .middle } **Visualize and Present**
---
Add custom buttons below messages to trigger specific actions like generating mind maps, exporting data, or creating visualizations.
Turn raw chat content into mind maps, infographics, flash cards, and polished explainers.
**Start with:** [Smart Mind Map](actions/smart-mind-map.md), [Smart Infographic](actions/smart-infographic.md), [Flash Card](actions/flash-card.md), [Deep Dive](actions/deep-dive.md)
- :material-file-export:{ .lg .middle } **Export and Deliver**
---
Convert valuable conversations into Word and Excel files for reports, handoff, or archiving.
**Start with:** [Export to Word](actions/export-to-word.md), [Export to Excel](actions/export-to-excel.md)
- :material-tune-variant:{ .lg .middle } **Improve Context and Output Quality**
---
Compress long chats, clean up Markdown, inject project rules, and enhance model context.
**Start with:** [Async Context Compression](filters/async-context-compression.md), [Markdown Normalizer](filters/markdown_normalizer.md), [Folder Memory](filters/folder-memory.md), [Context Enhancement](filters/context-enhancement.md)
- :material-robot-excited-outline:{ .lg .middle } **Build Agent and Tool Workflows**
---
Add autonomous agent behavior, reusable tools, and workflow-oriented integrations to OpenWebUI.
**Start with:** [GitHub Copilot SDK](pipes/github-copilot-sdk.md), [OpenWebUI Skills Manager Tool](tools/openwebui-skills-manager-tool.md), [Batch Install Plugins from GitHub](tools/batch-install-plugins-tool.md), [Smart Mind Map Tool](tools/smart-mind-map-tool.md)
- :material-image-multiple:{ .lg .middle } **Extend Model Capabilities**
---
Add multimodal access, raw-file awareness, and stronger context handling to your model stack.
**Start with:** [Web Gemini Multimodal Filter](filters/web-gemini-multimodel.md), [Copilot SDK Files Filter](filters/github-copilot-sdk-files-filter.md), [Context Enhancement](filters/context-enhancement.md)
</div>
---
## Curated First Installs
| If you want... | Start with | Why |
| --- | --- | --- |
| One “wow” feature that changes how you use OpenWebUI | [GitHub Copilot SDK](pipes/github-copilot-sdk.md) | Turns OpenWebUI into a richer agent workspace with tools, skills, and structured delivery |
| Fast visual clarity from messy chat content | [Smart Mind Map](actions/smart-mind-map.md) | The quickest way to make a complex answer instantly more understandable |
| Presentation-ready storytelling | [Smart Infographic](actions/smart-infographic.md) | Converts raw text into something polished enough for demos and reports |
| Practical upgrade for long chats | [Async Context Compression](filters/async-context-compression.md) | Saves tokens and keeps conversations easier to manage |
| Shareable output files | [Export to Word](actions/export-to-word.md) | Great for handoff notes, reports, and reusable documents |
| Fast setup across multiple plugin repos | [Batch Install Plugins from GitHub](tools/batch-install-plugins-tool.md) | Cuts down repetitive install work when experimenting |
---
## Browse by Type
<div class="grid cards" markdown>
- :material-gesture-tap:{ .lg .middle } **Actions**
---
One-click interactions, exports, visualizations, and message-side experiences.
[:octicons-arrow-right-24: Browse Actions](actions/index.md)
- :material-filter:{ .lg .middle } **Filters**
- :material-filter:{ .lg .middle } **Filters**
---
Process and modify messages before they reach the LLM or after responses are generated. Perfect for context enhancement and compression.
Message-pipeline upgrades for context, cleanup, formatting, and quality control.
[:octicons-arrow-right-24: Browse Filters](filters/index.md)
- :material-pipe:{ .lg .middle } **Pipes**
- :material-pipe:{ .lg .middle } **Pipes**
---
Create custom model integrations or transform LLM responses. Connect to external APIs or implement custom model logic.
Model integrations and advanced agent-style runtime workflows.
[:octicons-arrow-right-24: Browse Pipes](pipes/index.md)
- :material-pipe-wrench:{ .lg .middle } **Pipelines**
- :material-tools:{ .lg .middle } **Tools**
---
Complex workflows that combine multiple processing steps. Ideal for advanced use cases requiring multi-step transformations.
Native reusable tool plugins that can be called across models and workflows.
[:octicons-arrow-right-24: Browse Tools](tools/index.md)
- :material-pipe-wrench:{ .lg .middle } **Pipelines / References**
---
Historical or experimental orchestration-oriented references for multi-step workflows.
[:octicons-arrow-right-24: Browse Pipelines](pipelines/index.md)
@@ -44,50 +113,42 @@ OpenWebUI supports four types of plugins, each serving a different purpose:
---
## All Plugins at a Glance
## Current Source-backed Catalog
| Plugin | Type | Description | Version |
|--------|------|-------------|---------|
| [Smart Mind Map](actions/smart-mind-map.md) | Action | Generate interactive mind maps from text | 0.9.2 |
| [Smart Infographic](actions/smart-infographic.md) | Action | Transform text into professional infographics | 1.4.9 |
| [Flash Card](actions/flash-card.md) | Action | Create beautiful learning flashcards | 0.2.4 |
| [Export to Excel](actions/export-to-excel.md) | Action | Export chat history to Excel files | 0.3.7 |
| [Export to Word](actions/export-to-word.md) | Action | Export chat content to Word (.docx) with formatting | 0.4.3 |
| [Async Context Compression](filters/async-context-compression.md) | Filter | Intelligent context compression | 1.1.3 |
| [Context Enhancement](filters/context-enhancement.md) | Filter | Enhance chat context | 0.3.0 |
| [Multi-Model Context Merger](filters/multi-model-context-merger.md) | Filter | Merge context from multiple models | 0.1.0 |
| [Web Gemini Multimodal Filter](filters/web-gemini-multimodel.md) | Filter | Multimodal capabilities for any model | 0.3.2 |
| [MoE Prompt Refiner](pipelines/moe-prompt-refiner.md) | Pipeline | Multi-model prompt refinement | 1.0.0 |
| Plugin | Type | Best for |
| --- | --- | --- |
| [Smart Mind Map](actions/smart-mind-map.md) | Action | Interactive mind maps from conversations |
| [Smart Infographic](actions/smart-infographic.md) | Action | Polished infographic-style storytelling from raw text |
| [Flash Card](actions/flash-card.md) | Action | Study cards and memory-friendly summaries |
| [Export to Excel](actions/export-to-excel.md) | Action | Spreadsheet exports of chat data |
| [Export to Word](actions/export-to-word.md) | Action | High-fidelity Word deliverables |
| [Deep Dive](actions/deep-dive.md) | Action | Structured context → logic → insight analysis |
| [Async Context Compression](filters/async-context-compression.md) | Filter | Long-chat compression and token savings |
| [Context Enhancement](filters/context-enhancement.md) | Filter | Injecting helpful context before generation |
| [Folder Memory](filters/folder-memory.md) | Filter | Extracting and reusing project rules inside folders |
| [Markdown Normalizer](filters/markdown_normalizer.md) | Filter | Fixing Mermaid, LaTeX, code blocks, and Markdown cleanup |
| [Web Gemini Multimodal Filter](filters/web-gemini-multimodel.md) | Filter | Adding multimodal input handling to compatible workflows |
| [Copilot SDK Files Filter](filters/github-copilot-sdk-files-filter.md) | Filter | Sending raw repo files to Copilot SDK agents |
| [GitHub Copilot SDK](pipes/github-copilot-sdk.md) | Pipe | Autonomous agent workflows and tool reuse |
| [Smart Mind Map Tool](tools/smart-mind-map-tool.md) | Tool | Reusable mind-map generation across models |
| [OpenWebUI Skills Manager Tool](tools/openwebui-skills-manager-tool.md) | Tool | Installing and managing workspace skills |
| [Batch Install Plugins from GitHub](tools/batch-install-plugins-tool.md) | Tool | Faster onboarding across multiple plugin repositories |
---
## Installation Guide
## Repo-only Entries
### Step 1: Download the Plugin
| Plugin | Type | Notes |
| --- | --- | --- |
| [iFlow Official SDK Pipe](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/pipes/iflow-sdk-pipe) | Pipe | Source file and local README exist in the repo, but there is no mirrored docs page yet |
| [Chat Session Mapping Filter](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/filters/chat-session-mapping-filter) | Filter | Lightweight session-tracking helper currently discoverable from the repository only |
Click on any plugin above to view its documentation and download the `.py` file.
### Step 2: Upload to OpenWebUI
1. Open OpenWebUI and navigate to **Admin Panel****Settings****Functions**
2. Click the **+** button to add a new function
3. Upload the downloaded `.py` file
4. Configure any required settings (API keys, options, etc.)
### Step 3: Enable and Use
1. Refresh the page after uploading
2. For **Actions**: Look for the plugin button in the message action bar
3. For **Filters**: Enable in your chat settings or globally
4. For **Pipes**: Select the custom model from the model dropdown
5. For **Pipelines**: Configure and activate in the pipeline settings
> **Note:** Historical or docs-only references such as **Multi-Model Context Merger** and **MoE Prompt Refiner** still exist in the sub-indexes. This page prioritizes the current source-backed catalog and repo-discoverable entries.
---
## Plugin Compatibility
## Installation Paths
!!! info "OpenWebUI Version"
Most plugins in this collection are designed for OpenWebUI **v0.3.0** and later. Please check individual plugin documentation for specific version requirements.
!!! warning "Dependencies"
Some plugins may require additional Python packages. Check each plugin's documentation for required dependencies.
1. **OpenWebUI Community (recommended)** — install directly from [Fu-Jie's profile](https://openwebui.com/u/Fu-Jie)
2. **Docs + repo source file** — read the docs page, then upload the matching `.py` file manually
3. **Bulk install / faster onboarding** — use [Batch Install Plugins from GitHub](tools/batch-install-plugins-tool.md) or `python scripts/install_all_plugins.py` locally