Docker Compose

Bugsink can be installed using Docker Compose. You don’t need Docker COmpose to set up Bugsink, but it’s a handy choice if it fits your workflow.

Docker compose is a tool for defining and running multi-container Docker applications. With compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

Reasons to use Docker Compose over one of the other methods:

  • You’re already comfortable with Docker Compose or use it for other services.
  • You want a simple way to run Bugsink with a MySQL database (persisting data on a volume)

This guide assumes you are familiar with docker-compose and have it installed on your system.

Instructions

  • Copy the compose-sample.yaml to your server as compose.yaml.
  • Edit the relevant environment variables in compose.yaml.
  • Start the server:
docker compose up -d
  • After a few seconds you should be able to visit your server at http://localhost:8000/. The username/password are as you configured them in the CREATE_SUPERUSER variable in your modified sample.

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

Reverse Proxy

If you are running in production, strongly consider setting up a reverse proxy, such as Nginx, to handle incoming requests and manage SSL certificates. Make sure to:

  • Set the environment variable BEHIND_HTTPS_PROXY to True to make Dockerized Bugsink aware of the proxy.
  • Set Proxy Headers accordingly.

Next Steps

Here are some additional steps you can take to further customize your Bugsink setup: