Install and Publish Assets

Command

php artisan uplinkr:install

Description

Publishes Uplinkr configuration and language files to your Laravel app. Optionally enables scheduler integration and can initialize global I’m alive settings during installation.

Requirement: ext-openssl must be enabled in PHP when you want TLS certificate metadata in probe and alert output.

Options

Option	Type	Required	Description
--scheduler	flag	No	Enable scheduler integration by setting enabled to true in the config
--iam-alive	flag	No	Enable I’m alive notifications in global settings
--iam-alive-interval-hours	integer	No	Set I’m alive interval in hours (1-24)
--iam-alive-channels	string	No	Comma-separated I’m alive channels (mail,log,webhook)

Usage Examples

Basic install (publish assets only)

php artisan uplinkr:install

Install and enable scheduler integration

php artisan uplinkr:install --scheduler

Install and configure I’m alive

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

Behavior

• Publishes uplinkr-config and uplinkr-lang assets via vendor:publish
• Prints a config hint after publishing
• If --scheduler is provided, updates config/uplinkr.php to enable the scheduler
• If the config file is missing, the scheduler step is skipped with a warning
• If the scheduler is already enabled, no changes are made
• If --iam-alive* options are provided, writes global heartbeat settings to storage/app/private/uplinkr/settings.json
• If interval/channels are provided without --iam-alive, Uplinkr enables I’m alive automatically
• If I’m alive is configured without --scheduler, the command prints a hint that scheduled heartbeat delivery will not run yet
• Invalid I’m alive interval/channel combinations end with an invalid command status

Return Codes

• 0 (SUCCESS): Installation completed successfully
• 2 (INVALID): Invalid I’m alive settings were provided