📄️ Prerequisites
ToBeAlert runs on containers so you will need to install Docker before starting with ToBeAlert.
📄️ Docker
Docker installation
📄️ Linux
To download ToBeAlert you first need to log in to the ToBeAlert registry (registry.tobealert.com). Your registry user and access token are available in your customer account on the license portal; the token is used as the password.
📄️ Windows
To download ToBeAlert you first need to log in to the ToBeAlert registry (registry.tobealert.com). Your registry user and access token are available in your customer account on the license portal; the token is used as the password.
📄️ Kubernetes
This guide explains how to deploy ToBeAlert on a Kubernetes cluster. Before starting, make sure your images are available in your cluster's container runtime.
📄️ License setup
After you install ToBeAlert, the UI opens License setup until a valid license is in place. The screen has two modes:
📄️ Sending your first event
Now that ToBeAlert is installed, you can start sending alerts. For detailed information about the Alert API, including all available fields, attribute types, and advanced features like links and tagged values, see the API Documentation.
📄️ Settings & environment variables
Complete reference for configuring ToBeAlert in Docker, Kubernetes, and bare-metal deployments — and how those settings interact with Backend Config in the UI.
📄️ HTTPS and TLS
This page publishes ToBeAlert at https ToBeAlert brings its own small TLS proxy.
📄️ Behind a reverse proxy
Publish ToBeAlert behind Nginx Proxy Manager, Traefik, Caddy, HAProxy, Apache, a load balancer, an Ingress or Cloudflare.
📄️ Hotfixes
A hotfix bundle is a small .zip file, signed by tobeit, that fixes a release you already have installed — for example an unhandled error — without deploying a new image. Support sends you the file and an administrator uploads it in Management → Hotfixes. The whole flow works offline: the instance does not contact any external server.
📄️ Command line (tobealertd)
tobealertd is the administration tool shipped inside the backend container. Use it when you cannot reach the UI: create the first administrator, issue an API key, take a backup, or manage a hotfix from a shell.
📄️ Checkmk notification script
Checkmk sends its host and service notifications to ToBeAlert through a custom notification script installed in the Checkmk site. Each notification becomes an alert with the host as resource, the service as event, the Checkmk state mapped to a severity and the attributes checkmkhost, checkmkservice, checkmksite and checkmktype. With a Checkmk integration, those attributes let ToBeAlert show the Checkmk graphs of the service in the alert details.