Configuration

Updated

Most of what you configure in Muster, you configure in the web UI: monitors, their cadence and grace, and their alert channels (see Monitors and Alerts and the weekly digest). Members, sessions and access tokens are managed on the account screen at /bfc/ui.

Muster adds no environment variables of its own. It reads Laravel's standard ones.

Values filled for you

Variable	Why Muster cares	Who sets it
`DB_CONNECTION` and the other `DB_*` values	Where monitors and check-in history live.	Laravel Cloud, from the attached database.
`QUEUE_CONNECTION`	Alerts and digests are queued. It must be a durable queue, or the weekly digest never sends.	Laravel Cloud, from the attached managed queue.
`APP_URL`	The link back to Muster in the weekly digest. Alert emails carry no links.	Not declared by Muster's manifest. If the digest links to the wrong address, this is wrong.

Never set a variable yourself for a resource Laravel Cloud provisioned. Your value shadows the injected one and the resource breaks.

Scalpels also writes its own Built for Cloud keys, which connect the deployment to Scalpels. Leave them alone.

Email delivery

Muster sends transition alert emails and weekly failure digests through the configured mailer. On a Scalpels-managed installation, the default Scalpels mailer delivers both kinds of message without additional configuration.

Standalone installations use their configured Laravel mailer. Delivery mailers are accepted when they are defined in the application's mail configuration. Non-delivery mailers such as log and array, and undefined mailers, are rejected so Muster does not mark an email as delivered when no message can leave the application.

Signing in

In production, passwords must be at least 12 characters and include upper and lower case letters, numbers and symbols, and must not appear in known data breaches.

Built-in schedule

These run on the scheduler Scalpels enables. There is nothing to configure.

Command	When	What it does
`monitors:evaluate`	Every minute	Marks overdue enabled monitors `late`, then `missed`, and queues their alerts.
`digests:generate-weekly`	Mondays at 00:05 UTC	Builds the previous week's digest for each recipient.
`digests:publish-weekly`	Every minute	Queues any digest that is ready and not yet sent.

In a connected application

The client package reads these in the application it is installed in, not in Muster:

Variable	Meaning	Default
`MUSTER_URL`	The schedule-event endpoint, ending in `/api/schedule-events`. Written by `muster:install`.	none
`MUSTER_TOKEN`	The `muster.check-in` token. Written by `muster:install`. Treat it as a secret.	none
`MUSTER_CONNECT_TIMEOUT`	Seconds to wait to connect to Muster.	`0.5`
`MUSTER_TIMEOUT`	Seconds to wait for Muster to answer.	`1.0`

The client does nothing unless both MUSTER_URL and MUSTER_TOKEN are set. Run php artisan config:clear after changing any of them. To keep the settings in a tracked config file, publish it with php artisan vendor:publish --tag=muster-config.