Standard installation guide

Install BugSnag On-premise on a high availability cluster.

Before installation

To get started with your BugSnag On-premise installation, you’ll need the following 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.23 and at most version 1.32
• kubectl command line tool
• Docker registry (if you wish to rewrite and store images locally)
• SMTP credentials are required for installation. These are used to invite collaborators and receive error notification emails.

Install Replicated KOTS

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

1. Install Replicated KOTS CLI

   The Replicated KOTS CLI is a kubectl plugin that runs locally on the machine you will use to manage the cluster.

   Run the install script to download and install the plugin:

   curl -sSL https://kots.io/install/1.124.7 | REPL_USE_SUDO=y bash
   

2. Install Replicated KOTS admin console

   The Replicated KOTS admin console provides a user interface for installing and managing BugSnag On-premise in your kubernetes cluster. Install the admin console by running the following command:

   kubectl kots install bugsnag-clustered-kots \
     --name Bugsnag \
     --namespace bugsnag
   

   See the kots install command reference for all the options available.

   You can change the namespace you wish to install Replicated KOTS to, however it must match the namespace you later provide in the BugSnag configuration.

   You will be asked to create a password for accessing the admin console.

3. View KOTS admin console

   After installation, the Replicated KOTS admin console is available at http://localhost:8800.

   If you are disconnected you can re-establish the port forward:

   kubectl kots admin-console --namespace bugsnag
   

Install BugSnag

1. Upload license

   In the Replicated KOTS admin console upload the BugSnag On-premise license file you received from BugSnag.

2. BugSnag configuration

   You will be presented with the config page from which you can configure your BugSnag installation.

3. Preflight checks

   Finally, you will be shown the preflight checks page, where the system will be analyzed to determine whether the environment meets the minimum requirements. These checks are done to ensure that your installation is successful.

4. Installation complete

   It can take several minutes for BugSnag On-premise to deploy and fully start up. Once complete the admin console will indicate that it is ‘Ready’.

Account & project creation

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.

Load balancing

See the load balancing guide for information on how to configure your load balancers.

Configure platform SDKs

Once you have created your account and first project, follow the instructions to configure platform SDKs so your applications send error, session and performance information to your BugSnag instance.