byrcsc/laravel-whitelabel · 1.x

Configuration.

Reference every published configuration key and its default value.

Use config/whitelabel.php to select storage, resolution, assets, mail, and cache behavior. Publish it with php artisan whitelabel:install.

Top-level keys

Key	Default	Purpose
`whitelabel.driver`	`config`	Repository driver name
`whitelabel.default`	`default`	Default brand identifier and fallback source
`whitelabel.brands`	`['default' => []]`	Definitions used by the config driver
`whitelabel.resolvers`	four included resolver classes	Ordered active-brand resolver chain

An empty or non-string driver falls back to config. A null or empty default identifier disables the default fallback and makes DefaultResolver return null.

Database

Key	Default	Purpose
`whitelabel.database.connection`	`null`	Laravel database connection
`whitelabel.database.table`	`brands`	Table used by the model and migration

Null or empty values select the application connection and brands table. Change these keys before running the published migration.

Assets and CSS

Key	Default	Purpose
`whitelabel.assets.disk`	`public`	Disk for relative asset strings and maps without a disk
`whitelabel.css.prefix`	`brand`	Prefix for CSS custom properties

An empty asset disk passes null to Storage::disk(), which selects Laravel's default filesystem disk. An invalid non-string CSS prefix falls back to brand; unsafe characters in a string prefix are removed before rendering.

Mail

Key	Default	Purpose
`whitelabel.mail.markdown`	`true`	Enable logo and primary-colour Markdown components
`whitelabel.mail.override_from`	`false`	Replace the sender from the active brand

Only the exact boolean false disables Markdown branding. Only the exact boolean true enables sender replacement.

Cache

Key	Default	Purpose
`whitelabel.cache.enabled`	`true`	Wrap non-config drivers in the cache decorator
`whitelabel.cache.store`	`null`	Laravel cache store name
`whitelabel.cache.prefix`	`whitelabel`	Prefix for package cache keys

Only the exact boolean false disables the decorator. Null or empty store selects Laravel's default. Null, empty, or non-string prefix falls back to whitelabel.

Default resolver chain

'resolvers' => [
    Byrcsc\Whitelabel\Resolvers\OverrideResolver::class,
    Byrcsc\Whitelabel\Resolvers\TenantResolver::class,
    Byrcsc\Whitelabel\Resolvers\DomainResolver::class,
    Byrcsc\Whitelabel\Resolvers\DefaultResolver::class,
],

Entries may be container-resolvable class names or resolver objects. Entries that do not implement BrandResolver are ignored. An empty or non-array value leaves the application with no active-brand resolution.

Brand definition keys

Each entry under whitelabel.brands accepts name, domain, logo, favicon, colors, mail, and settings. See Brand definitions for accepted shapes and validation.

What to read next

Brand definitions for the nested brands schema.
Brand resolution for resolver order and lazy behavior.
Cache management for cache invalidation and tenant isolation.

Top-level keys

Key	Default	Purpose
`whitelabel.driver`	`config`	Repository driver name
`whitelabel.default`	`default`	Default brand identifier and fallback source
`whitelabel.brands`	`['default' => []]`	Definitions used by the config driver
`whitelabel.resolvers`	four included resolver classes	Ordered active-brand resolver chain

An empty or non-string driver falls back to config. A null or empty default identifier disables the default fallback and makes DefaultResolver return null.

Key

Default

Purpose

whitelabel.database.connection

null

Laravel database connection

whitelabel.database.table

brands

Table used by the model and migration

Assets and CSS

Key	Default	Purpose
`whitelabel.assets.disk`	`public`	Disk for relative asset strings and maps without a disk
`whitelabel.css.prefix`	`brand`	Prefix for CSS custom properties

Key

Default

Purpose

whitelabel.mail.markdown

true

Enable logo and primary-colour Markdown components

whitelabel.mail.override_from

false

Replace the sender from the active brand

Cache

Key	Default	Purpose
`whitelabel.cache.enabled`	`true`	Wrap non-config drivers in the cache decorator
`whitelabel.cache.store`	`null`	Laravel cache store name
`whitelabel.cache.prefix`	`whitelabel`	Prefix for package cache keys

Only the exact boolean false disables the decorator. Null or empty store selects Laravel's default. Null, empty, or non-string prefix falls back to whitelabel.

Default resolver chain

'resolvers' => [
    Byrcsc\Whitelabel\Resolvers\OverrideResolver::class,
    Byrcsc\Whitelabel\Resolvers\TenantResolver::class,
    Byrcsc\Whitelabel\Resolvers\DomainResolver::class,
    Byrcsc\Whitelabel\Resolvers\DefaultResolver::class,
],