From dfa461b3bc99b03f807d8a326c3a978c5e459d3c Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Tue, 17 Jul 2018 02:03:39 -0400 Subject: [PATCH] Improve help/Config page - Remove obsolete file-only config list - Fix heading level - Add transition instruction for $lang - Add reference to config.ini.php, settings.ini.php and addon.ini.php - Add link to help page in admin warning about legacy config file --- doc/Config.md | 127 ++++++++------------------------------------------ mod/admin.php | 2 +- 2 files changed, 21 insertions(+), 108 deletions(-) diff --git a/doc/Config.md b/doc/Config.md index 7ac3f7a02..ba6e674fc 100644 --- a/doc/Config.md +++ b/doc/Config.md @@ -6,7 +6,7 @@ Config values that can only be set in config/local.ini.php Friendica's configuration is done in two places: in INI configuration files and in the `config` database table. Database config values overwrite the same file config values. -# File configuration +## File configuration The configuration format for file configuration is an INI string returned from a PHP file. This prevents your webserver from displaying your private configuration it interprets the configuration files and displays nothing. @@ -31,16 +31,24 @@ INI; // Keep this line ``` -## Configuration location +### Configuration location -All the configuration keys Friendica uses are listed with their default value if any in `config/defaults.ini.php`. -Addons can define their own default configuration values in `addon/[addon]/config/[addon].ini.php` which are loaded when the addon is activated. +The `config` directory holds key configuration files: -### Migrating from .htconfig.php to config/local.ini.php +- `config.ini.php` holds the default values for all the configuration keys that can only be set in `local.ini.php`. +- `settings.ini.php` holds the default values for some configuration keys that are set through the admin settings page. +- `local.ini.php` holds the current node custom configuration. +- `addon.ini.php` is optional and holds the custom configuration for specific addons. + +Addons can define their own default configuration values in `addon/[addon]/config/[addon].ini.php` which is loaded when the addon is activated. + +#### Migrating from .htconfig.php to config/local.ini.php The legacy `.htconfig.php` configuration file is still supported, but is deprecated and will be removed in a subsequent Friendica release. -The migration is pretty straightforward, just copy `config/local-sample.ini.php` to `config/local.ini.php`, add your configuration values to it according to the following conversion chart, then rename your `.htconfig.php` to check your node is working as expected before deleting it. +The migration is pretty straightforward: +If you had any addon-specific configuration in your `.htconfig.php`, just copy `config/addon-sample.ini.php` to `config/addon.ini.php` and move your configuration values. +Afterwards, copy `config/local-sample.ini.php` to `config/local.ini.php`, move the remaining configuration values to it according to the following conversion chart, then rename your `.htconfig.php` to check your node is working as expected before deleting it.