Add Batch Install Plugins installation instructions to various plugins and filters
- Updated README files for the following plugins to include installation instructions using Batch Install Plugins: - deep-dive - export_to_docx - export_to_excel - flash-card - infographic - smart-mind-map - async-context-compression - chat-session-mapping-filter - folder-memory - github_copilot_sdk_files_filter - markdown_normalizer - github-copilot-sdk - iflow-sdk-pipe - openwebui-skills-manager - smart-mind-map-tool - Added important notes regarding the removal of the official OpenWebUI Community version before installation.
This commit is contained in:
fujie
@@ -1,10 +1,10 @@
|
||||
<!--
|
||||
NOTE: This template is for the English version (README.md).
|
||||
The Chinese version (README_CN.md) MUST be translated based on this English version to ensure consistency in structure and content.
|
||||
The Chinese version (README_CN.md) MUST be translated from this file so both versions keep the same structure and installation guidance.
|
||||
-->
|
||||
# [Plugin Name] [Optional Emoji]
|
||||
# [Plugin Name]
|
||||
|
||||
[Brief description of what the plugin does. Keep it concise and engaging.]
|
||||
[One-sentence summary of what the plugin does and why it is useful.]
|
||||
|
||||
| By [Fu-Jie](https://github.com/Fu-Jie) · v1.0.0 | [⭐ Star this repo](https://github.com/Fu-Jie/openwebui-extensions) |
|
||||
| :--- | ---: |
|
||||
@@ -12,46 +12,65 @@ The Chinese version (README_CN.md) MUST be translated based on this English vers
|
||||
|  |  |  |  |  |  |  |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
|
||||
## Preview
|
||||
|
||||
|
||||
|
||||
<!-- If you do not have a screenshot yet, replace the image with one short sentence explaining what users will see. -->
|
||||
|
||||
## Install with Batch Install Plugins
|
||||
|
||||
If you already use [Batch Install Plugins from GitHub](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/tools/batch-install-plugins), you can install or update this plugin with:
|
||||
|
||||
```text
|
||||
Install plugin from Fu-Jie/openwebui-extensions
|
||||
```
|
||||
|
||||
When the selection dialog opens, search for this plugin, check it, and continue.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> If the official OpenWebUI Community version is already installed, remove it first. After that, Batch Install Plugins can keep this plugin updated in future runs.
|
||||
|
||||
## What's New
|
||||
|
||||
<!-- Keep only the latest update here. Remove this section for the initial release. -->
|
||||
<!-- Keep only the latest 1-3 versions here. Remove this section for the initial release. -->
|
||||
|
||||
### v1.0.0
|
||||
|
||||
- **Initial Release**: Released the first version of the plugin.
|
||||
- **[Feature Name]**: [Brief description of the feature].
|
||||
|
||||
## Key Features 🔑
|
||||
## Key Features
|
||||
|
||||
- **[Feature 1]**: [Description of feature 1].
|
||||
- **[Feature 2]**: [Description of feature 2].
|
||||
- **[Feature 3]**: [Description of feature 3].
|
||||
|
||||
## How to Use 🛠️
|
||||
## How to Use
|
||||
|
||||
1. **Install**: Add the plugin to your OpenWebUI instance.
|
||||
2. **Configure**: Adjust settings in the Valves menu (optional).
|
||||
3. **[Action Step]**: Describe how to trigger or use the plugin.
|
||||
4. **[Result Step]**: Describe the expected outcome.
|
||||
1. **Install**: Add the plugin to your OpenWebUI instance from the marketplace, or use the Batch Install prompt above.
|
||||
2. **Configure**: Adjust settings in the Valves menu if needed.
|
||||
3. **Use**: Describe how to trigger or run the plugin.
|
||||
4. **Result**: Describe what users should expect to see.
|
||||
|
||||
## Configuration (Valves) ⚙️
|
||||
## Configuration (Valves)
|
||||
|
||||
| Valve | Default | Description |
|
||||
|-------|---------|-------------|
|
||||
| --- | --- | --- |
|
||||
| `VALVE_NAME` | `Default Value` | Description of what this setting does. |
|
||||
| `ANOTHER_VALVE` | `True` | Another setting description. |
|
||||
|
||||
## ⭐ Support
|
||||
## Troubleshooting
|
||||
|
||||
- **Plugin not working?**: Check if the filter, action, pipe, or tool is enabled in the relevant OpenWebUI settings.
|
||||
- **Debug Logs**: Enable the debug valve if available and check the browser console (F12) or backend logs.
|
||||
- **Official version conflict**: If installation fails because the same plugin already exists from the official marketplace, remove the old version first and try again.
|
||||
- **Submit an Issue**: If the problem continues, report it here: [OpenWebUI Extensions Issues](https://github.com/Fu-Jie/openwebui-extensions/issues)
|
||||
|
||||
## Support
|
||||
|
||||
If this plugin has been useful, a star on [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) is a big motivation for me. Thank you for the support.
|
||||
|
||||
## Troubleshooting ❓
|
||||
|
||||
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
|
||||
- **Debug Logs**: Enable `SHOW_DEBUG_LOG` in Valves and check the browser console (F12) for detailed logs.
|
||||
- **Error Messages**: If you see an error, please copy the full error message and report it.
|
||||
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [OpenWebUI Extensions Issues](https://github.com/Fu-Jie/openwebui-extensions/issues)
|
||||
|
||||
## Changelog
|
||||
|
||||
See the full history on GitHub: [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions)
|
||||
|
||||
Reference in New Issue
Block a user