Quickstart
This quick guide walks you through the steps to get started with Bugsink: from just after installation to triggering and resolving your first issue. Before you start, make sure you have either of the following:
- Hosted Bugsink: you have signed up for a free account or a free trial.
- Self-hosted: you have installed Bugsink on your own server or locally.
Steps
-
In your browser go to the URL where you installed Bugsink, e.g. https://yourcompany.bugsink.com/ or http://localhost:8000/.
-
You will see the login page. Log in with the email and password you provided during installation (in the
createsuperuserstep). (If you didn’t provide anything, it’sadmin/admin) -
Create a New Team if Bugsink asks you to.
-
On the empty “Projects” page, click on the “New Project” button in the top-right corner.
-
On the form, enter the name of your project and click “Save” (the team you just created will be pre-selected; the other defaults are fine).
-
The instructions to Connect your Application will appear. Summarized: install an SDK, copy the DSN, and trigger an error on purpose.
-
On the project-page in Bugsink, you should now see your issue. Feel free to explore the issue details and the stacktrace.
-
Since you triggered the issue on purpose, you can click “Resolve” once you’ve seen enough.
Congratulations! You have successfully set up Bugsink and reported your first issue.
Next Steps
You have now seen the basics of Bugsink. Let it run to start collecting real errors, then:
- Review the SDK recommendations for production use.
- Set up alerts so you hear about new errors.
If you self-host Bugsink, you may also want to:
- Review the available settings.
- Configure a reverse proxy to serve Bugsink over HTTPS.
- Keep your installation current using the upgrading guide.
