From 1b30c684f31e370fe2bf7a1f59f980e0399747ab Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 25 Nov 2018 01:56:02 -0500 Subject: [PATCH] Update documentation with new config style/name - Fix typos --- doc/Config.md | 206 +++++++++++++++++++++----------- doc/FAQ.md | 10 +- doc/Home.md | 4 +- doc/Install.md | 30 ++--- doc/Installing-Connectors.md | 4 +- doc/Settings.md | 84 +++++++------ doc/Update.md | 2 +- doc/Vagrant.md | 4 +- doc/de/FAQ.md | 6 +- doc/de/Home.md | 2 +- doc/de/Install.md | 22 ++-- doc/de/Installing-Connectors.md | 4 +- doc/de/Settings.md | 34 +++--- 13 files changed, 245 insertions(+), 167 deletions(-) diff --git a/doc/Config.md b/doc/Config.md index 788c1cd0b6..f85ceb4985 100644 --- a/doc/Config.md +++ b/doc/Config.md @@ -1,55 +1,54 @@ -Config values that can only be set in config/local.ini.php +Config values that can only be set in config/local.config.php ========================================================== * [Home](help) -Friendica's configuration is done in two places: in INI configuration files and in the `config` database table. +Friendica's configuration is done in two places: in PHP array configuration files and in the `config` database table. Database config values overwrite the same file config values. ## File configuration -WARNING: some characters `?{}|&~![()^"` should not be used in the keys or values. If one of those character is required put the value between double quotes (eg. password = "let&me&in") -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. +The configuration format for file configuration is an array returned from a PHP file. +This prevents your webserver from displaying your private configuration. It interprets the configuration files and displays nothing. A typical configuration file looks like this: ```php - [ + // Comment line + 'key' => 'value', + ], + 'section2' => [ + 'array' => ['value0', 'value1', 'value2'], + ], +]; ``` ### Configuration location The `config` directory holds key configuration files: -- `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. +- `defaults.config.php` holds the default values for all the configuration keys that can only be set in `local.config.php`. +- `settings.config.php` holds the default values for some configuration keys that are set through the admin settings page. +- `local.config.php` holds the current node custom configuration. +- `addon.config.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. +Addons can define their own default configuration values in `addon/[addon]/config/[addon].config.php` which is loaded when the addon is activated. -#### Migrating from .htconfig.php to config/local.ini.php +#### Migrating from .htconfig.php to config/local.config.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: -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. +If you had any addon-specific configuration in your `.htconfig.php`, just copy `config/addon-sample.config.php` to `config/addon.config.php` and move your configuration values. +Afterwards, copy `config/local-sample.config.php` to `config/local.config.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.