Install Monitoring in Laravel

Requirements

Before installing Uplinkr, make sure your environment meets these requirements:

• PHP: 8.2 or higher
• Laravel: 11.x or 12.x
• ext-openssl

Note

Uplinkr is tested with Laravel 11 and 12 and may also work with future Laravel versions.

Install via Composer

Install the package with Composer:

composer require scherhak/uplinkr

Publish Configuration and Language Files

After installation, run the install command to publish configuration and language files:

php artisan uplinkr:install

This copies the configuration file to config/uplinkr.php and the language files to resources/lang/vendor/uplinkr.

Configuration

Review config/uplinkr.php to customize Uplinkr for your project.

If you prefer to publish files manually, run:

php artisan vendor:publish --tag=uplinkr-config
php artisan vendor:publish --tag=uplinkr-lang

Optional: Enable Scheduler Integration

To automatically enable scheduler integration during installation, use the --scheduler flag:

php artisan uplinkr:install --scheduler

This sets 'enabled' => true in the scheduler section of your configuration.

You can also enable the scheduler later by editing config/uplinkr.php and setting:

'scheduler' => [
    'enabled' => true,
]

When scheduler integration is enabled, Uplinkr adds two commands to Laravel’s scheduler:

• uplinkr:project:run-probes --force - Runs all probes for all enabled projects
• uplinkr:project:alert:decision - Checks probe results and triggers alerts based on configured thresholds. See the Alert decisions command.

These commands run based on scheduler.cron (default: every minute). See the Scheduler section for details.

Optional: Configure I’m alive During Installation

You can configure I’m alive directly while running uplinkr:install:

php artisan uplinkr:install \
  --iam-alive \
  --iam-alive-interval-hours=6 \
  --iam-alive-channels=mail,log,webhook

Available I’m alive options:

• --iam-alive: Enables I’m alive in uplinkr/settings.json
• --iam-alive-interval-hours=...: Sets interval in hours (1-24)
• --iam-alive-channels=...: Comma-separated channels (mail, log, webhook)

If these options are omitted, I’m alive remains unchanged/disabled by default.

You can update I’m alive settings later with:

php artisan uplinkr:settings --iam-alive --interval-hours=6 --channels=mail,log

Running Laravel’s Scheduler

For scheduled probes to run, Laravel’s scheduler must be running.

In development:

php artisan schedule:work

In production, add this to your crontab:

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1