Files
Fu-Jie_openwebui-extensions/docs/PLUGIN_README_TEMPLATE.md

4.3 KiB

[Plugin Name]

[One-sentence summary of what the plugin does and why it is useful.]

By Fu-Jie · v1.0.0 Star this repo
followers points top contributions downloads saves views

Preview

Install with Batch Install Plugins

If you already use Batch Install Plugins from GitHub, you can install or update this plugin with:

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

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

Support

If this plugin has been useful, a star on OpenWebUI Extensions is a big motivation for me. Thank you for the support.

Changelog

See the full history on GitHub: OpenWebUI Extensions