diff --git a/.gitignore b/.gitignore index c094f6a24..3db593f1d 100644 --- a/.gitignore +++ b/.gitignore @@ -10,10 +10,9 @@ home.html robots.txt #ignore local config -/config/local.config.php -/config/addon.config.php -/config/local.ini.php -/config/addon.ini.php +!/config/local-sample.config.php +/config/*.config.php +/config/*.ini.php #ignore documentation, it should be newly built /doc/api diff --git a/config/addon-sample.config.php b/config/addon-sample.config.php deleted file mode 100644 index 5159370c3..000000000 --- a/config/addon-sample.config.php +++ /dev/null @@ -1,12 +0,0 @@ - [ - 'consumerkey' => '1234567890', - 'consumersecret' => 'ABCDEFGHIJKLMONPQRSTUVWXYZ', - ], -]; diff --git a/doc/Config.md b/doc/Config.md index 885509939..a66895ca1 100644 --- a/doc/Config.md +++ b/doc/Config.md @@ -37,8 +37,8 @@ The `config` directory holds key configuration files and can have different conf All of them have to end with `.config.php` and must not include `-sample` in their name. Some examples of common known configuration files: -- `local.config.php` holds the current node custom configuration. -- `addon.config.php` is optional and holds the custom configuration for specific addons. +- `local.config.php` holds the base node custom configuration. +- Any other file in this folder is meant for addon configuration. Addons can define their own default configuration values in `addon/[addon]/config/[addon].config.php` which is loaded when the addon is activated. @@ -59,7 +59,7 @@ Currently, the following configurations are included: 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.config.php` to `config/addon.config.php` and move your configuration values. +If you had any addon-specific configuration in your `.htconfig.php`, copy `config/local-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.