Bugsink Installation

The quickest way to evaluate Bugsink is to spin up a throw-away instance using Docker: 

docker pull bugsink/bugsink:latest

docker run \
  -e SECRET_KEY=MfcMrT5yBny31yASa7cRgrDwHrZQtByTVS8CRDsutC7rhK4JlX \
  -e CREATE_SUPERUSER=admin:admin \
  -e PORT=8000 \
  -p 8000:8000 \
  bugsink/bugsink

Visit http://localhost:8000/, where you’ll see a login screen. The default username and password are admin.

Now, you can set up your first project and start tracking errors.

Full Installation Guides

These guides cover the most popular ways you can deploy the Bugsink Server, depending on your environment and requirements:

  • Docker Installation: Ideal for those who prefer containerized deployments. You can run Bugsink using Docker, with the option to choose between MySQL/PostgreSQL for persistent storage or SQLite for simplicity. This approach is flexible and can be easily integrated into different orchestration tools like Docker Compose or Kubernetes.

  • Docker Compose: Similar to the Docker installation, but with the added benefit of having a MySQL container spun up simultaneously.

  • Local Install using Virtualenv: A simple and straightforward method for running Bugsink on your local machine, using Python’s virtualenv. This approach is a good fit for Python developers who already have a Python environment set up and want to quickly evaluate Bugsink before deploying it.

  • Single Server Production Setup: A production-ready setup on a single server. A single guide for a containerless setup. You’ll use Nginx as a reverse proxy and Gunicorn to handle application processes, ensuring stability and performance.

Choose the method that aligns with your workflow and get Bugsink up and running in no time. Each approach is designed to streamline the installation process and get you started with minimal hassle.

Experiences & Example Guides

Bugsink is very flexible and can be deployed in many different ways. This naturally means it’s made its way into many different environments. Here are some more examples of how Bugsink has been deployed in the wild, that may be useful to you if you’re already using these tools:

  • Kubernetes Installation Examples: we maintain a list of user-contributed K8S Manifests for Bugsink. These are not official guides, but they can be a great starting point for your own deployment. You’ll probably want to reference the Docker / Docker Compose installation guides mentioned above while using these.

  • Coolify is a is an open-source, self-hosted Heroku alternative; Bugsink is available as a one-click app. This is a great way to get started with Bugsink if you want to use Coolify to manage your self-hosted applications.

  • Dokku markets itself as “the smallest PaaS implementation you’ve ever seen”. Installation of Bugsink is quite straightforward, as describe in this short blog-post.

  • [Caprover] is another open-source PaaS solution. Bugsink is available as a one-click app; if you’re running Caprover, the “one-click apps browser” should display a tile for Bugsink. The underlying template is in their GitHub repo.