Introduction
BugPin is a self-hosted, open-source visual bug reporting tool. It allows your team and users to capture screenshots, annotate issues, and submit bug reports directly from your web applications.
Why BugPin?
- Self-Hosted: Your data stays on your servers. No third-party dependencies or data sharing.
- Visual Reporting: Capture screenshots with one click and annotate them with drawing tools.
- Lightweight Widget: Under 50KB gzipped, loads asynchronously, and uses Shadow DOM for style isolation.
- Offline Support: Reports are cached locally and automatically submitted when connectivity is restored.
- Easy Integration: Add to your site with a single script tag.
Key Features
Visual Bug Reporting
Capture full-page or visible area screenshots directly from your web application. The built-in annotation tools help provide clear context for every bug report.
Annotation Tools
- Pen tool for freehand drawing
- Rectangle and circle shapes
- Arrow for pointing to issues
- Text annotations
- Privacy blur for sensitive information
Self-Hosted & Private
BugPin is designed for self-hosting with a simple SQLite database and Docker deployment. All data is stored locally with no external dependencies.
Integrations
- Forward reports to GitHub Issues automatically
- Webhook support for custom integrations
- Email notifications (optional SMTP configuration)
Architecture
BugPin consists of three main components:
| Component | Technology | Purpose |
|---|---|---|
| Server | Bun + Hono + SQLite | REST API, database, file storage |
| Admin UI | React 18 + Tailwind CSS | Dashboard for managing reports |
| Widget | Preact + Fabric.js | Embeddable bug reporter |
Getting Started
Ready to get started? Follow the Docker installation guide to have BugPin running in under 5 minutes.