Configuration¶
MRBS loads defaults from the application, then applies installation-specific overrides.
Configuration files¶
| File | Purpose | Edit directly? |
|---|---|---|
config.inc.php |
Site-specific settings and secrets | Yes |
config.inc.php-sample |
Starting point for a new configuration | Copy it |
systemdefaults.inc.php |
Documented application defaults | No |
areadefaults.inc.php |
Defaults for newly created areas | No |
To change a setting, copy the relevant assignment from a defaults file into
config.inc.php, then change the copied value.
Do not expose configuration
config.inc.php contains database and possibly mail or identity-provider
credentials. Restrict file access and never commit a production
configuration.
Minimal configuration¶
A new installation normally requires:
$timezone = "Europe/Berlin";
$dbsys = "mysql";
$db_host = "localhost";
$db_database = "mrbs";
$db_login = "mrbs";
$db_password = "replace-this-password";
$db_tbl_prefix = "mrbs_";
System and area defaults¶
System defaults apply globally unless overridden. Area defaults initialize new area records.
For existing areas, use the administration interface. This is a common source of confusion: changing an area default does not rewrite existing database records.
Organize local overrides¶
Keep related overrides together:
/******************
* Authentication
******************/
$auth["type"] = "db";
$auth["session"] = "php";
/********
* Email
********/
$mail_settings['admin_backend'] = 'smtp';
$smtp_settings['host'] = 'mail.example.org';
Add a short reason for non-obvious settings. Avoid copying the whole defaults file because that makes future upgrades harder to review.
Apply changes safely¶
- Back up
config.inc.php. - Change one related group of settings.
- Check PHP syntax:
- Test as an administrator, normal user, and signed-out visitor.
- Keep credentials out of logs, screenshots, and issue reports.
Use the configuration reference to find the
right group of settings. For a complete setup and maintenance workflow, see
config.inc.php in depth.