X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2FConfig.md;h=3e0459f9c8aa480f9fa6429fde8164a34b365f45;hb=13b184e2b491a3bf916f55e8f148023d82e05d51;hp=7eae371c285a9dca8c90d639e315c60569d71081;hpb=302ef596d4aaf6357380ace77f1c3d4aecd96eda;p=friendica.git diff --git a/doc/Config.md b/doc/Config.md index 7eae371c28..3e0459f9c8 100644 --- a/doc/Config.md +++ b/doc/Config.md @@ -33,21 +33,33 @@ return [ ### Configuration location -The `config` directory holds key configuration files: +The `config` directory holds key configuration files and can have different config files. +All of them have to end with `.config.php` and must not include `-sample` in their name. -- `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. +Some examples of common known configuration files: +- `local.config.php` holds the base node custom configuration. +- Any other file in this folder is meant for additional configuration (e.g. for addons). Addons can define their own default configuration values in `addon/[addon]/config/[addon].config.php` which is loaded when the addon is activated. +If needed, an alternative `config` path can be used by using the `FRIENDICA_CONFIG_DIR` environment variable (full path required!). +This is useful in case of hardening the system by separating configuration from program binaries. + +### Static Configuration location + +The `static` directory holds the codebase default configurations files. +They must not be changed by users, because they can get changed from release to release. + +Currently, the following configurations are included: +- `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. + #### 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.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.