ba0d63930e
- Change Environment Information to Operating System field - Keep only OS details (Windows/macOS/Linux versions) - Simplify checklist requirement from full environment to OS info - Maintains essential debugging information without overhead
220 lines
6.0 KiB
YAML
220 lines
6.0 KiB
YAML
name: 🐛 Bug Report
|
|
description: Report a bug or issue with OpenWebUI plugins
|
|
title: "[BUG] "
|
|
labels: ["bug"]
|
|
assignees: []
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to fill out this bug report! Please provide clear information to help us understand and resolve the issue.
|
|
|
|
- type: dropdown
|
|
id: plugin-type
|
|
attributes:
|
|
label: Plugin Type
|
|
description: Which type of plugin is affected?
|
|
options:
|
|
- Action
|
|
- Filter
|
|
- Pipe
|
|
- Pipeline
|
|
- Tool (Copilot SDK)
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: plugin-name
|
|
attributes:
|
|
label: Plugin Name
|
|
description: Which plugin has the issue?
|
|
placeholder: "e.g., Smart Mind Map, Export to Word"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: Clearly describe the bug or issue you encountered
|
|
placeholder: |
|
|
What happened? What did you expect to happen?
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: steps
|
|
attributes:
|
|
label: Steps to Reproduce
|
|
description: How can we reproduce the issue?
|
|
placeholder: |
|
|
1. Go to...
|
|
2. Click on...
|
|
3. See error...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected Behavior
|
|
description: What should happen instead?
|
|
placeholder: "The plugin should..."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual
|
|
attributes:
|
|
label: Actual Behavior
|
|
description: What is actually happening?
|
|
placeholder: "Instead, the plugin..."
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: openwebui-version
|
|
attributes:
|
|
label: OpenWebUI Version
|
|
description: What version of OpenWebUI are you using?
|
|
placeholder: "e.g., 0.3.0 or main"
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: browser
|
|
attributes:
|
|
label: Browser
|
|
description: What browser are you using?
|
|
options:
|
|
- Chrome
|
|
- Firefox
|
|
- Safari
|
|
- Edge
|
|
- Other
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: environment
|
|
attributes:
|
|
label: Operating System
|
|
description: Operating system and relevant environment details
|
|
placeholder: |
|
|
macOS 14.3
|
|
or
|
|
Windows 11 (22H2)
|
|
or
|
|
Ubuntu 22.04 LTS
|
|
validations:
|
|
required: true
|
|
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
## Debug Logs & Troubleshooting
|
|
Please provide relevant logs to help diagnose the issue. You can collect logs from:
|
|
|
|
### 🌐 Frontend Console Logs (Recommended for Plugin Issues)
|
|
1. **Enable Debug Mode**: Click your avatar → Settings → General → Enable Plugin Debug Output
|
|
2. **Open Browser DevTools**: Press `F12` (or `Cmd+Option+I` on Mac)
|
|
3. **Go to Console Tab** and look for:
|
|
- Errors (red text)
|
|
- Warnings (yellow text)
|
|
- `🛠️ Debug` messages from the plugin
|
|
4. **Take a screenshot or copy the full console output**
|
|
|
|
### 🖥️ Server-Side Logs
|
|
If frontend logs don't show the issue, check backend logs:
|
|
- **Docker**: Run `docker logs <container-id>`
|
|
- **Local**: Check terminal output or log files
|
|
- Look for ERROR, WARNING, or CRITICAL messages
|
|
|
|
- type: textarea
|
|
id: frontend-logs
|
|
attributes:
|
|
label: Frontend Console Logs
|
|
description: Paste the browser console output. Enable Plugin Debug Output in Settings first.
|
|
placeholder: |
|
|
🛠️ Start of Debug Output
|
|
[Plugin name starting...]
|
|
...
|
|
[Error details or warnings]
|
|
render: bash
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: server-logs
|
|
attributes:
|
|
label: Server-Side Logs
|
|
description: "Paste relevant backend logs (from docker logs or server terminal)"
|
|
placeholder: |
|
|
[ERROR] Plugin execution failed: ...
|
|
[WARNING] ...
|
|
render: bash
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: plugin-config
|
|
attributes:
|
|
label: Plugin Configuration
|
|
description: "If applicable, share your plugin valve settings (remove sensitive data)"
|
|
placeholder: |
|
|
SHOW_STATUS: true
|
|
SHOW_DEBUG_LOG: false
|
|
...
|
|
render: python
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: screenshots
|
|
attributes:
|
|
label: Screenshots (Optional)
|
|
description: |
|
|
If applicable, add screenshots to help explain the issue:
|
|
- Error messages or UI problems
|
|
- Browser console errors
|
|
- Plugin configuration that's causing the issue
|
|
- Any visual anomalies
|
|
|
|
**Tip**: You can paste images directly or use: 
|
|
placeholder: "Upload or describe any relevant screenshots..."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: additional
|
|
attributes:
|
|
label: Additional Context
|
|
description: Any other information that might help?
|
|
placeholder: |
|
|
- Related issues or discussions
|
|
- Steps you've already tried
|
|
- Any recent changes to your setup
|
|
- Links to related plugins or documentation
|
|
validations:
|
|
required: false
|
|
|
|
- type: checkboxes
|
|
id: checklist
|
|
attributes:
|
|
label: Checklist
|
|
options:
|
|
- label: I have searched existing issues for duplicates
|
|
required: true
|
|
- label: I have provided clear steps to reproduce the issue
|
|
required: true
|
|
- label: I have mentioned the plugin name and OpenWebUI version
|
|
required: true
|
|
- label: I have provided my operating system information
|
|
required: true
|
|
- label: I have provided logs or console output (frontend/server-side)
|
|
required: false
|
|
- label: I have attached screenshots if applicable
|
|
required: false
|