Bugsink documentation

Bugsink is a tool to track errors in your applications that you can self-host. It’s easy to install and use, is compatible with the Sentry SDK, and is scalable and reliable.

Why Bugsink?

An overview of what Bugsink is and why you might want to use it:

• What is Error Tracking?
• Built to self-host
• Sentry-SDK Compatible
• Scalable and Reliable

Installation

Bugsink is self-hosted, which means you’ll need to install it. Luckily, it’s easy:

• Installation overview

Specific guides:

• Docker installation
• Docker Compose
• Local installation using Virtualenv
• Single Server Production Setup

Advanced installation topics:

• Proxy headers (for when you’re behind a reverse proxy)
• Upgrading (keeping your Bugsink instance up-to-date)

Configuration

Bugsink is easy to configure. Here are some guides to get you started:

• After-install quickstart (track your first error)
• Settings overview

Usage

Once you have a running Bugsink instance, you’ll want to set up your projects, teams, and more:

• Projects (the apps you’re tracking)
• Teams (projects are organized into teams)
• Releases (track your apps releases)
• Alerts (get notified when errors happen)
• Grouping (group similar errors together)
• Permissions (who can do what)
• SDK configuration recommendations
• Ingestion rate-limits and retention policies

Troubleshooting

Here’s a short list of ways to troubleshoot common issues:

• Dogfooding (using Bugsink to track Bugsink errors)
• CSRF configuration issues
• Event-ingestion/digestion troubleshooting