Known Overrides
This module helps you track configuration overrides made in your settings files. It then provides a report highlighting the differences between your overridden settings and the default configuration, preventing confusion and potential issues.
Known Overrides is a simple module that can help you set up config overrides in your settings.php or settings.local.php and flag them in the Known Overrides Report, where only the differences between the Config and Override Config are shown.
Why do we need this? Modules like Mail Safety are amazing at stopping email leaking from your local ddev version of the site. But when reviewing the Mail Safety settings form, you won't see your overrides there, and then start to panic if your emails are leaking via SMTP.
Post-Installation
Edit your settings.local.php file
After the `<?php` line add the following array check, and setter.
if (!isset($settings['knownOverrides'])) {
$settings['knownOverrides'] = [];
}
Add your config override
// Config override
$config['mail_safety.settings']['enabled'] = TRUE;
// Add the config name `mail_safety.settings` to settings knownOverrides array
$settings['knownOverrides'][] = 'mail_safety.settings';
The items stored in $settings['knownOverrides'] will then be compared to the editable config and any differences reported on.
Similar projects
- Configuration Override Warn module will report within a config form if there are any overrides detected. Highly recommended. However, it does not offer a separate report outside of the overridden module's configuration.
Community Documentation
See the readme.md file for more information.