Added description

[friendica.git] / doc / Config.md

diff --git a/doc/Config.md b/doc/Config.md
index a187331dd645cb3f34ddec3349e312fbafd5c8fd..8855099391d5dabd99fe4b4f9dd94fd0b0a0a8ef 100644 (file)
--- a/doc/Config.md
+++ b/doc/Config.md
@@ -33,15 +33,27 @@ 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.
+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.
 
 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.
@@ -142,7 +154,7 @@ $a->config['register_policy'] = REGISTER_CLOSED;
 </pre></td>
                     <td><pre>
 'config' => [
-    'register_policty' => REGISTER_CLOSED,
+    'register_policy' => \Friendica\Module\Register::CLOSED,
 ],
 </pre></td>
         </tr>
@@ -242,7 +254,7 @@ register_policty = REGISTER_CLOSED
 </pre></td>
                                <td><pre>
 'config' => [
-    'register_policty' => REGISTER_CLOSED,
+    'register_policy' => \Friendica\Module\Register::CLOSED,
 ],
 </pre></td>
         </tr>
@@ -292,7 +304,7 @@ Or it is for testing purposes only.
 **Attention:** Please be warned that you shouldn't use one of these values without the knowledge what it could trigger.
 Especially don't do that with undocumented values.
 
-These configurations keys and their default value are listed in `config/defaults.config.php` and should be overwritten in `config/local.config.php`.
+These configurations keys and their default value are listed in `static/defaults.config.php` and should be overwritten in `config/local.config.php`.
 
 ## Administrator Options