Bug Report
Found a bug or have an idea for a new feature? We track all issues on GitHub.
Report a Bug
Open a new issue on GitHub with details about the problem you've encountered.
Browse Existing Issues
Check if your issue has already been reported, or find workarounds for known problems.
What to Include
A good bug report helps us fix the problem faster. Please include:
- Device Model
- e.g., Boox Note Air 3, Kobo Elipsa 2E, Kindle Scribe, or standard Android phone/tablet
- Android Version
- e.g., Android 12. Check in your device's Settings → About.
- WebView Version
- Found in EinkBro Settings → About, or your device's system settings under WebView.
- EinkBro Version
- e.g., 15.10.0. Shown in EinkBro Settings → About.
- Steps to Reproduce
- Numbered list of exact steps to trigger the bug. The more specific, the better.
- Expected Behavior
- What you expected to happen.
- Actual Behavior
- What actually happened. Include any error messages.
- Screenshots / Screen Recording
- If the bug is visual, a screenshot is extremely helpful. Use the full-page screenshot feature if relevant.
Common Troubleshooting
Before reporting, try these common fixes:
Pages not loading or displaying incorrectly
- Clear cache — Settings → Data Control → Clear Cache
- Check JavaScript — Ensure JavaScript is enabled (Settings → Start Control → JavaScript), or that the site is in your whitelist
- Check Cookies — Some sites require cookies. Enable in Settings → Start Control → Cookies
- Disable AdBlock — Some sites break with ad blocking. Add the site to the AdBlock Whitelist
- Update WebView — An outdated Android System WebView can cause rendering issues. Update it via Google Play Store or your device's app store
Performance issues
- Enable web cache — Settings → Behavior → Enable Web Cache
- Disable images — Settings → Start Control → Images (toggle off for faster loading on slow connections)
- Use reader mode — Strips heavy page elements for faster rendering
- Request Save Data — Settings → Start Control → Request 'Save Data' (tells websites to serve lighter content)
Translation not working
- Ensure you have an internet connection
- For image translation, check that the API key is set in Settings → Misc → Translate Image API Key
- For AI-based translation, verify your API key in Settings → GPT
AI features not working
- Verify your OpenAI or Gemini API key in Settings → GPT
- Check that the model name is correct (default:
gpt-4.1for OpenAI,gemini-2.5-flashfor Gemini) - For self-hosted servers, ensure the Custom Host URL is accessible from your device
Feature Requests
Have an idea for a new feature? Open a GitHub issue with the [Feature Request] prefix in the title. Describe:
- What you'd like to see
- Why it would be useful (especially for E-Ink device users)
- How you envision it working
Contributing a Fix
If you can fix the bug yourself, we welcome pull requests:
- Fork the repository
- Create a branch from
main - Make your fix and test it (ideally on an E-Ink device)
- Submit a Pull Request referencing the issue number
See the Developer Guide for build instructions and architecture details.