1 Config values that can only be set in config/local.ini.php
2 ==========================================================
6 Friendica's configuration is done in two places: in INI configuration files and in the `config` database table.
7 Database config values overwrite the same file config values.
11 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")
12 The configuration format for file configuration is an INI string returned from a PHP file.
13 This prevents your webserver from displaying your private configuration it interprets the configuration files and displays nothing.
15 A typical configuration file looks like this:
35 ### Configuration location
37 The `config` directory holds key configuration files:
39 - `config.ini.php` holds the default values for all the configuration keys that can only be set in `local.ini.php`.
40 - `settings.ini.php` holds the default values for some configuration keys that are set through the admin settings page.
41 - `local.ini.php` holds the current node custom configuration.
42 - `addon.ini.php` is optional and holds the custom configuration for specific addons.
44 Addons can define their own default configuration values in `addon/[addon]/config/[addon].ini.php` which is loaded when the addon is activated.
46 #### Migrating from .htconfig.php to config/local.ini.php
48 The legacy `.htconfig.php` configuration file is still supported, but is deprecated and will be removed in a subsequent Friendica release.
50 The migration is pretty straightforward:
51 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.
52 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.
57 background-color: #f9f9f9;
58 border: 1px solid #aaa;
59 border-collapse: collapse;
64 table.config > tr > th,
65 table.config > tr > td,
66 table.config > * > tr > th,
67 table.config > * > tr > td {
68 border: 1px solid #aaa;
72 table.config > tr > th,
73 table.config > * > tr > th {
74 background-color: #f2f2f2;
80 <table class="config">
83 <th>.htconfig.php</th>
84 <th>config/local.ini.php</th>
90 $db_host = 'localhost';
91 $db_user = 'mysqlusername';
92 $db_pass = 'mysqlpassword';
93 $db_data = 'mysqldatabasename';
94 $a->config["system"]["db_charset"] = 'utf8mb4';
99 username = mysqlusername
100 password = mysqlpassword
101 database = mysqldatabasename
108 $a->config["section"]["key"] = "value";
118 $a->config["section"]["key"] = array(
134 $a->config["key"] = "value";
154 $default_timezone = "value";
158 default_timezone = value
186 ### Database Settings
188 The configuration variables database.hostname, database.username, database.password, database.database and database.charset are holding your credentials for the database connection.
189 If you need to specify a port to access the database, you can do so by appending ":portnumber" to the database.hostname variable.
192 hostname = your.mysqlhost.com:123456
194 If all of the following environment variables are set, Friendica will use them instead of the previously configured variables for the db:
202 ## Config values that can only be set in config/local.ini.php
204 There are some config values that haven't found their way into the administration page.
205 This has several reasons.
206 Maybe they are part of a current development that isn't considered stable and will be added later in the administration page when it is considered safe.
207 Or it triggers something that isn't expected to be of public interest.
208 Or it is for testing purposes only.
210 **Attention:** Please be warned that you shouldn't use one of these values without the knowledge what it could trigger.
211 Especially don't do that with undocumented values.
213 These configurations keys and their default value are listed in `config/config.ini.php` and should be ovewritten in `config/local.ini.php`.
215 ## Administrator Options
217 Enabling the admin panel for an account, and thus making the account holder admin of the node, is done by setting the variable
220 admin_email = someone@example.com
222 Where you have to match the email address used for the account with the one you enter to the config/local.ini.php file.
223 If more then one account should be able to access the admin panel, separate the email addresses with a comma.
226 admin_email = someone@example.com,someoneelse@example.com
228 If you want to have a more personalized closing line for the notification emails you can set a variable for the admin_name.