Installation guide

Install clustered On-premise version of BugSnag.

This documentation is for the legacy clustered version of BugSnag On-premise. Documentation for the current version can be found here.

If you have the Single Machine version of BugSnag On-premise, please follow the single machine installation guide instead.

Before installation

To get started with your BugSnag On-premise installation, you’ll need the following things prepared in advance:

If this is your first time installing BugSnag On-premise, you’ll need to contact us to schedule a guided installation. We’ll get you set up with a license, and walk you through the installation process.
A Kubernetes cluster running at least version 1.19 and at most version 1.24
Docker registry
Locally running Docker 17.05 or later. This will require internet access during installation.
SMTP credentials are required for installation. These are used to invite collaborators and receive error notification emails.

Installation

If you are installing BugSnag On-premise on AWS please follow the CloudFormation installation guide.

BugSnag On-premise uses Replicated Ship to perform and manage installations.

Run Replicated Ship

Run the following to initialize BugSnag On-premise using Replicated Ship configuration tool. Make sure to run this command from a sensible directory as the tool will store configuration under .ship folder in the current directory. This will contain the state of your installation including the configuration and therefore should be backed up.

docker pull replicated/ship && \
docker run -it -p 8800:8800 --rm -v `pwd`:/out \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e HTTP_PROXY -e HTTPS_PROXY -e NO_PROXY \
  replicated/ship init \
  "replicated.app/bugsnag-clustered"

You will be asked to enter your BugSnag On-premise license. Enter the license you received from Bugsnag to continue to the next step.

The configuration tool will be available at http://localhost:8800.

BugSnag configuration

Follow the steps in the configuration tool and configure your installation as directed on the settings page. Once configured the next step will push all of the required images to your Docker registry and generate a bugsnag-kubernetes.yaml file in your current directory with instructions on how to apply that to start BugSnag.

It can take several minutes for BugSnag On-premise to fully start up.

Account & project creation

Now BugSnag is running, you should be able to access the BugSnag dashboard, where you’ll need to create your account and first project.

Visit your BugSnag dashboard in a web browser to set up your account and create projects for each of the applications you wish to monitor.

Notifier configuration

Once you have created your account and first project you will need to configure your applications to send errors and sessions information to your BugSnag instance instead of notify.bugsnag.com and sessions.bugsnag.com respectively. Follow the instructions on configuring platform notifiers for how to do this.