PHP Config File

Nearly every setting can also be managed via a PHP config file. See Settings for how the control panel and PHP config file interact.

To get started, create a config/notifier.php file. It might look something like this...

/**
 * config/notifier.php
 */
return [

    // Logging (all optional)
    'loggingEnabled'      => true,
    'logRetentionDays'    => 30,
    'logRetentionRecords' => 1000,

    // Twilio (only needed if using Twilio to send SMS messages)
    'twilioAccountSid'  => getenv('TWILIO_ACCOUNT_SID'),
    'twilioAuthToken'   => getenv('TWILIO_AUTH_TOKEN'),
    'twilioPhoneNumber' => getenv('TWILIO_PHONE_NUMBER'),

    // Phone number to use for SMS testing purposes
    'testToPhoneNumber' => getenv('TEST_TO_PHONE_NUMBER'),

    // Pushover (only needed if using Pushover)
    'pushoverApplicationToken' => getenv('PUSHOVER_APPLICATION_TOKEN'),

    // ntfy (only needed if using ntfy)
    'ntfyServerUrl'   => getenv('NTFY_SERVER_URL'),
    'ntfyAccessToken' => getenv('NTFY_ACCESS_TOKEN'),

    // Bluesky (only needed if posting to Bluesky)
    'blueskyPdsUrl' => getenv('BLUESKY_PDS_URL'),

];

Much like the db.php and general.php files, notifier.php is environmentally aware. You can also pass in environment values using the getenv PHP method.

Config File Supersedes Control Panel

Values set in config/notifier.php take effect at runtime. So if a key is set both here and in the control panel, the config file value wins.

Settings available via Control Panel

The following settings can also be managed on the Control Panel page.

Logging

Settings for the notification log:

• loggingEnabled - Toggle log system on/off.
• logRetentionDays - Limit log retention by age.
• logRetentionRecords - Limit log retention by event count.

Twilio API Credentials

Settings for the Twilio API:

• twilioAccountSid - Twilio account SID.
• twilioAuthToken - Twilio auth token.
• twilioPhoneNumber - Twilio phone number.

Use env Values

Twilio credentials are sensitive. Set them via env values rather than hard-coding them into the config file.

Pushover

Settings for Pushover:

• pushoverApplicationToken - Pushover application API token.

ntfy

Settings for ntfy:

• ntfyServerUrl - ntfy server URL. Leave unset to use https://ntfy.sh.
• ntfyAccessToken - ntfy access token, for protected topics or authenticated instances.

Bluesky

Settings for Bluesky:

• blueskyPdsUrl - Bluesky PDS URL. Defaults to https://bsky.social.

Settings available only via PHP file

testToPhoneNumber

string|null - Defaults to null.

Recipient phone number to intercept all outbound SMS messages. Similar to testToEmailAddress.

Set the testing phone number in your local .env file, then load it via the PHP config file:

# Testing phone number in local environment
TEST_TO_PHONE_NUMBER="888-555-4444"