77 lines
4.3 KiB
Markdown
77 lines
4.3 KiB
Markdown
<!--
|
|
NOTE: This template is for the English version (README.md).
|
|
The Chinese version (README_CN.md) MUST be translated from this file so both versions keep the same structure and installation guidance.
|
|
-->
|
|
# [Plugin Name]
|
|
|
|
[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) |
|
|
| :--- | ---: |
|
|
|
|
|  |  |  |  |  |  |  |
|
|
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
|
|
|
## Preview
|
|
|
|
<!-- Add a screenshot or description here -->
|
|
<!-- If you have a screenshot, add it as:  -->
|
|
<!-- If you do not have a screenshot yet, replace 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 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
|
|
|
|
- **[Feature 1]**: [Description of feature 1].
|
|
- **[Feature 2]**: [Description of feature 2].
|
|
- **[Feature 3]**: [Description of feature 3].
|
|
|
|
## How to Use
|
|
|
|
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)
|
|
|
|
| Valve | Default | Description |
|
|
| --- | --- | --- |
|
|
| `VALVE_NAME` | `Default Value` | Description of what this setting does. |
|
|
| `ANOTHER_VALVE` | `True` | Another setting description. |
|
|
|
|
## 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.
|
|
|
|
## Changelog
|
|
|
|
See the full history on GitHub: [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions)
|