BugPin: Self-hosted, open-source visual bug reporting tool
0 net
Tags
The self-hosted, open-source visual bug reporting tool.
Capture screenshots, annotate issues, and track bugs from your web applications.
Dashboard — manage projects and triage reports in one place. _Light Mode_
_Dark Mode_
# Features
- **Visual Bug Reporting** - Capture screenshots with one click
- **Annotation Tools** - Draw, highlight, and annotate screenshots
- **Offline Support** - Reports are buffered and sent when back online
- **Self-Hosted** - Your data stays on your servers
- **Multi-Project** - Manage multiple projects with separate API keys
- **Enhanced Security Features** - Domain whitelists, configurable rate limiting, HSTS, and secure headers
- **GitHub Integration** - Forward reports to GitHub Issues
- **Dark Mode** - Admin Console supports light and dark themes
# Quick Start
Get BugPin up and running in under 1 minute. This guide will walk you through the basic setup to start capturing and managing bug reports.
## Install
### Docker Compose
Create a `docker-compose.yml` file:
```yaml
services:
bugpin:
image: registry.arantic.cloud/bugpin/bugpin:latest
container_name: bugpin
restart: unless-stopped
ports:
- '7300:7300'
volumes:
- ./data:/data
```
Then run:
```bash
# Start BugPin
docker compose up -d
```
### Docker Run
```bash
# Run BugPin container
docker run -d \
--name bugpin \
--restart unless-stopped \
-p 7300:7300 \
-v bugpin-data:/data \
registry.arantic.cloud/bugpin/bugpin:latest
```
BugPin will be available at `http://localhost:7300`
## Login
Log in with the default credentials:
- **Email**: `[email protected]`
- **Password**: `changeme123`
> [!IMPORTANT]
> Change the default password immediately after first login:
>
> 1. Click your profile icon
> 2. Select "Profile"
> 3. Update your password
## Widget Integration
Add the BugPin widget to your website by including this script tag before the closing `