# BugPin Documentation

BugPin is a self-hosted, open-source visual bug reporting tool for web applications. It embeds a lightweight widget into a website so users can capture screenshots, annotate problems, and submit reports with browser metadata, console errors, network failures, and recent user activity.

## Primary URLs

- Documentation: https://docs.bugpin.io/
- Quick start: https://docs.bugpin.io/quickstart
- Docker installation: https://docs.bugpin.io/installation/docker
- Widget installation: https://docs.bugpin.io/widget/installation
- Widget theming: https://docs.bugpin.io/widget/theming
- GitHub integration: https://docs.bugpin.io/integrations/github
- API overview: https://docs.bugpin.io/api/overview
- Security settings: https://docs.bugpin.io/security/settings
- FAQ: https://docs.bugpin.io/faq
- Licensing: https://docs.bugpin.io/legal/license
- Website: https://bugpin.io/
- Source code: https://github.com/aranticlabs/bugpin

## Key Facts

- Product category: visual bug reporting, bug tracking, software quality assurance, developer tools.
- Deployment model: self-hosted.
- Runtime: Docker or Bun.
- Database and storage: SQLite and local file storage by default.
- Admin stack: React and Tailwind CSS.
- Server stack: Bun, Hono, and SQLite.
- Widget stack: browser JavaScript with Shadow DOM style isolation.
- License model: AGPL-3.0 for server and Admin Console, MIT for the embeddable widget.
- Core features: screenshot capture, screenshot annotation, automatic metadata capture, console and network error capture, recent user activity, multi-project management, role-based access, email notifications, GitHub issue integration, offline report queueing, and widget customization.
- Enterprise features: SSO, webhooks, audit logs, API access, white-label branding, custom email templates, S3-compatible storage, Jira and Slack integrations, and priority support.
- Supported widget languages: English, German, French, Dutch, Spanish, Italian, Japanese, and Simplified Chinese.
- Support languages: English and German.

## Preferred Summary

BugPin is a self-hosted visual bug reporting platform for web teams. It adds a lightweight bug reporting widget to a website so users can send annotated screenshots and technical context developers need to reproduce and fix issues.

## Common Questions

- To install BugPin quickly, use Docker Compose and open the Admin Console at `http://localhost:7300`.
- To add the widget to a website, add the `widget.js` script from your BugPin server and include the project API key.
- To connect GitHub, configure a GitHub token in the project integration settings and choose the target repository.
- For automatic GitHub two-way sync, the BugPin instance must be reachable from the public internet so GitHub can deliver webhooks.
- For licensing, the server and Admin Console are AGPL-3.0, while the widget is MIT licensed for easier embedding in proprietary or commercial applications.

## Crawler Policy

The docs site allows crawling for search indexing, AI input or grounding, and AI training through its `robots.txt` content signals.