On-premise legacy

Install, maintain, and manage your older on-premise version of Bugsnag.

This page refers to Bugsnag On-premise version 2.1711.2 and earlier. For the latest information please see Bugsnag On-premise.

About On-premise

Bugsnag On-premise offers a self-hosted version of Bugsnag for organizations that need or want to manage their own data. It can be run in your existing PCI or HIPAA compliant environments.

Bugsnag On-premise has most of the features of SaaS Bugsnag and regular releases ensure you are kept up to date. All notifier libraries can easily be configured to send error reports to your Bugsnag On-premise instance.

Download the installation script

Install Bugsnag

Downloading and installing Bugsnag can take between 15-30 minutes.

$ sudo bugsnag install

During installation you’ll be prompted to select a data directory. This should be on a large volume (at least 200GB) with an Ext4 or XFS filesystem. This is the directory that will contain your Bugsnag data, and will need to be backed up.

Installing offline

Installing Bugsnag offline can be done by prefetching packages required for install on an internet connected machine.

$ sudo bugsnag prefetch

This outputs an archive in the current directory. This archive needs to be copied to a machine for offline install as well as the bugsnag installation script. The bugsnag installation script has to be installed before offline install can be run. See Download the installation script for how to do this.

--accept-eula If you are required to accept a EULA as part of your installation, supplying this option will bypass the prompt. Using this option implies that you have read and agree to the terms of the EULA.

--license-file parameter needs the location to the license key file

--data-dir parameter needs the location to store bugsnag data. A data volume, typically mounted as /data, with at least 200GB of space. Ext4 or XFS filesystems are preferred.

Set the following environment variables whilst running the install command to configure bugsnag non interactively:

Configure your hostname

Bugsnag On-premise exposes various services, which you may wish to map to user-friendly hostnames and ports. See Services, hostnames & ports for more information.

Once you have chosen where you’ll expose the Bugsnag dashboard, you’ll need to let your Bugsnag On-premise instance know the hostname you’ve chosen by editing the BUGSNAG_WEBSITE_HOST setting in /etc/bugsnag/env.sh:

BUGSNAG_WEBSITE_HOST=http://bugsnag.internal.example.com

If you are using two-way issue tracker integrations, you’ll need to let your Bugsnag On-premise instance know the webhook hostname you’ve chosen by editing the WEBHOOK_HOST setting in /etc/bugsnag/env.sh:

WEBHOOK_HOST=http://bugsnag-hooks.internal.example.com

Configure HTTP to HTTPS redirection

The Bugsnag dashboard on your Bugsnag On-premise instance by default is available via HTTP. You can make the dashboard automatically redirect to HTTPS by adding the following setting to /etc/bugsnag/env.sh:

BUGSNAG_HTTPS_REDIRECT=true

If you are running an external load balancer to proxy your Bugsnag On-premise instance with SSL make sure the X-Forwarded-Proto header is set to https by the load balancer.

You can also setup your own proxy using Nginx.

Other configuration

By default, the admin email address is available from the login page so that new users can request an account. If you don’t want this to be displayed, add the following setting to /etc/bugsnag/env.sh:

HIDE_LOGIN_PAGE_CONTACT_EMAIL=true

If you want to use a different email address for new users to request an account from, add the following setting to /etc/bugsnag/env.sh:

BUGSNAG_ADMIN_EMAIL=admin@example.com

By default we limit event processing to just over 100 events per minute per project. Anything above that rate in a minute is throttled and not saved. You can adjust that rate by adding the following setting to /etc/bugsnag/env.sh:

BUGSNAG_SAMPLE_ALLOWANCE=500

First boot

Now you’ve installed and configured Bugsnag, you’ll need to start the Bugsnag apps. This may take around 5 minutes the first time:

$ sudo bugsnag start

To check Bugsnag’s status as it boots, you can run the following command:

$ sudo bugsnag status

When all services are marked as up, your Bugsnag installation is complete.

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 (available by default at x.x.x.x:49080) to set up your account and create projects for each of the applications you wish to monitor.

Endpoint configuration

Error reporting libraries

By default, Bugsnag reporting libraries will send errors to notify.bugsnag.com, so you’ll need to configure your applications to send errors to your On-premise installation, at the hostname/port you configured for the Bugsnag Event Server endpoint above.

Uploading ProGuard mapping files

If you’re developing Android applications which are obfuscated using ProGuard, you’ll need to configure the Bugsnag Gradle Plugin to upload ProGuard mapping files to your On-premise installation, at the hostname/port you configured above for the Bugsnag Upload Server endpoint above.