config.php

The config.php file is the central configuration file for the WebOrbiton Status system. It defines global settings that control how the monitoring service behaves, how the status page is presented, and which optional modules are enabled.

This file is loaded on every request and should be properly configured before deploying the Status Monitor to a production environment.

Responsibilities of config.php

The config.php file is responsible for the following core functions:

  • Defining site identity and branding, including the project name, page title, and logo text

  • Configuring SEO metadata templates used for status pages and social sharing

  • Setting monitoring intervals and short-term history retention periods

  • Enabling or disabling long-term history storage

  • Managing optional monitoring, security, and utility modules

General Site Information

This section defines the basic identity of the status page.

  • Site Name
    Specifies the name of the website or project being monitored. This value is reused across the interface and SEO templates.

  • Site Status Title
    Defines the main title displayed on status pages, headers, and browser tabs.

  • Logo Text
    A short text or single character used as a visual identifier in the header or favicon.

SEO Templates

SEO templates control how the status page appears in search engines and when shared on social platforms.

  • SEO Title Template
    Dynamically generates the page title using the current overall system status (e.g. Operational, Degraded, Outage).

  • SEO Description Template
    Generates a dynamic meta description including:

    • current overall status

    • number of monitored services

    • average uptime percentage

These templates improve search engine visibility and provide clear system status information to users.

Monitoring Settings

This section controls how often services are checked and how much recent history is stored.

  • Monitoring Period
    Defines how long monitoring data is kept in short-term memory.
    Accepted formats include minutes, hours, or days.

  • Check Rate
    Specifies the interval between individual service checks.
    Shorter intervals provide faster detection but increase server load.

Long History Settings

Controls extended historical data storage.

  • Enable Long History
    Toggles long-term history tracking on or off.
    This feature requires the long-history module to be enabled.

  • Long History Period
    Defines how long historical data is retained when long history is enabled.

Modules Configuration

Optional modules extend the functionality of the Status Monitor system.
Each module can be enabled or disabled individually.

Available modules include:

  • Security protection

  • Incident alerts and notifications

  • SSL certificate monitoring

  • Performance and speed monitoring

  • Long-term uptime history

  • Automatic system updater (recommended)

Some modules may require a valid license key to function correctly.

Important Notes

  • Changes to config.php affect the entire system.

  • Invalid values may cause monitoring errors.

  • Enable only the modules you actually need to reduce overhead.

  • Always back up this file before making major changes.

  • If you are using automatic updates, NEVER remove config.php from the exclude list in zx-updater.xml.