From: Hypolite Petovan <mrpetovan@gmail.com>
Date: Tue, 17 Jul 2018 06:03:39 +0000 (-0400)
Subject: Improve help/Config page
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=dfa461b3bc99b03f807d8a326c3a978c5e459d3c;p=friendica.git

Improve help/Config page

- Remove obsolete file-only config list
- Fix heading level
- Add transition instruction for $lang
- Add reference to config.ini.php, settings.ini.php and addon.ini.php
- Add link to help page in admin warning about legacy config file
---

diff --git a/doc/Config.md b/doc/Config.md
index 7ac3f7a02e..ba6e674fc6 100644
--- a/doc/Config.md
+++ b/doc/Config.md
@@ -6,7 +6,7 @@ Config values that can only be set in config/local.ini.php
 Friendica's configuration is done in two places: in INI configuration files and in the `config` database table.
 Database config values overwrite the same file config values.
 
-# File configuration
+## File configuration
 
 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.
@@ -31,16 +31,24 @@ INI;
 // Keep this line
 ```
 
-## Configuration location
+### Configuration location
 
-All the configuration keys Friendica uses are listed with their default value if any in `config/defaults.ini.php`.
-Addons can define their own default configuration values in `addon/[addon]/config/[addon].ini.php` which are loaded when the addon is activated.
+The `config` directory holds key configuration files:
 
-### Migrating from .htconfig.php to config/local.ini.php
+- `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.
+
+Addons can define their own default configuration values in `addon/[addon]/config/[addon].ini.php` which is loaded when the addon is activated.
+
+#### Migrating from .htconfig.php to config/local.ini.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, just copy `config/local-sample.ini.php` to `config/local.ini.php`, add your 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.
+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.
 
 <style>
 table.config {
@@ -165,7 +173,8 @@ pidfile = value
 $lang = "value";
 </pre></td>
 			<td><pre>
-No equivalent (yet)
+[system]
+language = value
 </pre></td>
 		</tr>
 
@@ -173,7 +182,7 @@ No equivalent (yet)
 </table>
 
 
-## Database Settings
+### Database Settings
 
 The configuration variables database.hostname, database.username, database.password, database.database and database.charset are holding your credentials for the database connection.
 If you need to specify a port to access the database, you can do so by appending ":portnumber" to the database.hostname variable.
@@ -189,9 +198,7 @@ If all of the following environment variables are set, Friendica will use them i
     MYSQL_PASSWORD
     MYSQL_DATABASE
 
-
-
-# Config values that can only be set in config/local.ini.php
+## Config values that can only be set in config/local.ini.php
 
 There are some config values that haven't found their way into the administration page.
 This has several reasons.
@@ -202,103 +209,9 @@ 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.
 
-The header of the section describes the category, the value is the parameter.
-Example: To set the automatic database cleanup process add this line to your config/local.ini.php:
-
-    [system]
-    always_show_preview = true
-
-## jabber ##
-* **debug** (Boolean) - Enable debug level for the jabber account synchronisation.
-* **lockpath** - Must be writable by the ejabberd process. if set then it will prevent the running of multiple processes.
-
-## system ##
-
-* **allowed_link_protocols** (Array) - Allowed protocols in links URLs, add at your own risk. http is always allowed.
-* **always_show_preview** (Boolean) - Only show small preview picures. Default value is false.
-* **archival_days** (Integer) - Number of days that we try to deliver content before we archive a contact. Defaults to 32.
-* **auth_cookie_lifetime** (Integer) - Number of days that should pass without any activity before a user who chose "Remember me" when logging in is considered logged out. Defaults to 7.
-* **block_local_dir** (Boolean) - Blocks the access to the directory of the local users.
-* **config_adapter** (jit|preload) - Allow to switch the configuration adapter to improve performances at the cost of memory consumption. Default value is "jit"
-* **curl_range_bytes** - Maximum number of bytes that should be fetched. Default is 0, which mean "no limit".
-* **db_log** - Name of a logfile to log slow database queries
-* **db_loglimit** - If a database call lasts longer than this value it is logged
-* **db_log_index** - Name of a logfile to log queries with bad indexes
-* **db_log_index_watch** - Watchlist of indexes to watch
-* **db_loglimit_index** - Number of index rows needed to be logged for indexes on the watchlist
-* **db_loglimit_index_high** - Number of index rows to be logged anyway (for any index)
-* **db_log_index_blacklist** - Blacklist of indexes that shouldn't be watched
-* **dbclean_expire_conversation** (Integer) - When DBClean is enabled, any entry in the conversation table will be deleted after this many days.  These data are normally needed only for debugging purposes and they are safe to delete.  Default 90.
-* **diaspora_test** (Boolean) - For development only. Disables the message transfer.
-* **disable_email_validation** (Boolean) - Disables the check if a mail address is in a valid format and can be resolved via DNS.
-* **disable_url_validation** (Boolean) - Disables the DNS lookup of an URL.
-* **disable_password_exposed** (Boolean) - Disable the exposition check against the remote haveibeenpwned API on password change. Default value is false.
-* **dlogfile** - location of the developer log file
-* **dlogip** - restricts develop log writes to requests originating from this IP address
-* **frontend_worker_timeout** - Value in minutes after we think that a frontend task was killed by the webserver. Default value is 10.
-* **groupedit_image_limit** (Integer) - Number of contacts at which the group editor should switch from display the profile pictures of the contacts to only display the names. Default is 400. This can alternatively be set on a per account basis in the pconfig table.
-* **hsts** (Boolean) - Enables the sending of HTTP Strict Transport Security headers
-* **ignore_cache** (Boolean) - For development only. Disables the item cache.
-* **instances_social_key** - Key to the API of https://instances.social which retrieves data about mastodon servers. See https://instances.social/api/token to get an API key.
-* **ipv4_resolve** (Boolean) - Resolve IPV4 addresses only. Don't resolve to IPV6. Default value is false.
-* **invitation_only** (Boolean) -  If set true registration is only possible after a current member of the node has send an invitation. Default is false.
-* **like_no_comment** (Boolean) - Don't update the "commented" value of an item when it is liked.
-* **local_block** (Boolean) - Used in conjunction with "block_public".
-* **local_search** (Boolean) - Blocks search for users who are not logged in to prevent crawlers from blocking your system.
-* **local_tags** (Boolean) - If activated, all hashtags will point to the local server.
-* **max_connections** - The maximum number of database connections which can be in use before the worker process is deferred to it's next interval.  When the system can't detect the maximum numbers of connection then this value can be used.
-* **max_connections_level** - The maximum level of connections that are allowed to let the worker start. It is a percentage value. Default value is 75.
-* **max_contact_queue** - Default value is 500.
-* **max_batch_queue** - Default value is 1000.
-* **max_processes_backend** - Maximum number of concurrent database processes for background tasks. Default value is 5.
-* **max_processes_frontend** - Maximum number of concurrent database processes for foreground tasks. Default value is 20.
-* **min_poll_interval** - minimal distance in minutes between two polls for a contact. Default is 1. Reasonable values are between 1 and 59.
-* **session_handler** (database|cache|native) - Whether to use Cache to store session data or to use PHP native session storage. Default value is `database`.
-* **cache_driver** (database|memcache|memcached) - Whether to use Memcache or Memcached to store temporary cache. Default value is `database`.
-* **memcache_host** - Host name of the memcache daemon. Default is '127.0.0.1'.
-* **memcache_port** - Port number of the memcache daemon. Default is 11211.
-* **memcached_hosts** - Array of Memcached servers info `[host, port(, weight)]`. Default value is `[['127.0.0.1', 11211]]`.
-* **no_count** (Boolean) - Don't do count calculations (currently only when showing albums)
-* **no_oembed** (Boolean) - Don't use OEmbed to fetch more information about a link.
-* **no_smilies** (Boolean) - Don't show smilies.
-* **no_view_full_size** (Boolean) - Don't add the link "View full size" under a resized image.
-* **optimize_items** (Boolean) - Triggers an SQL command to optimize the item table before expiring items.
-* **ostatus_poll_timeframe** - Defines how old an item can be to try to complete the conversation with it.
-* **paranoia** (Boolean) - Log out users if their IP address changed.
-* **permit_crawling** (Boolean) - Restricts the search for not logged in users to one search per minute.
-* **queue_no_dead_check** (Boolean) - Ignore if the target contact or server seems to be dead during queue delivery.
-* **worker_debug** (Boolean) - If enabled, it prints out the number of running processes split by priority.
-* **worker_fetch_limit** - Number of worker tasks that are fetched in a single query. Default is 1.
-* **profiler** (Boolean) - Enable internal timings to help optimize code. Needed for "rendertime" addon. Default is false.
-* **free_crawls** - Number of "free" searches when "permit_crawling" is activated (Default value is 10)
-* **crawl_permit_period** - Period in seconds between allowed searches when the number of free searches is reached and "permit_crawling" is activated (Default value is 60)
-* **png_quality** - Default value is 8.
-* **proc_windows** (Boolean) - Should be enabled if Friendica is running under Windows.
-* **proxy_cache_time** - Time after which the cache is cleared. Default value is one day.
-* **pushpoll_frequency** -
-* **qsearch_limit** - Default value is 100.
-* **remove_multiplicated_lines** (Boolean) - If enabled, multiple linefeeds in items are stripped to a single one.
-* **sendmail_params** (Boolean) - Normal sendmail command parameters will be added when the PHP mail() function is called for sending e-mails.  This ensures the Sender Email address setting is applied to the message envelope rather than the host's default address.  Default is true.  Set to false if your non-sendmail agent is incompatible, or to restore old behavior of using the host address.
-* **show_unsupported_addons** (Boolean) - Show all addons including the unsupported ones.
-* **show_unsupported_themes** (Boolean) - Show all themes including the unsupported ones.
-* **show_global_community_hint** (Boolean) - When the global community page is enabled, use this option to display a hint above the stream, that this is a collection of all public top-level postings that arrive on your node.
-* **throttle_limit_day** - Maximum number of posts that a user can send per day with the API.
-* **throttle_limit_week** - Maximum number of posts that a user can send per week with the API.
-* **throttle_limit_month** - Maximum number of posts that a user can send per month with the API.
-* **wall-to-wall_share** (Boolean) - Displays forwarded posts like "wall-to-wall" posts.
-* **worker_cooldown** - Cooldown time after each worker function call. Default value is 0 seconds.
-* **worker_load_exponent** (Integer) - Default 3, which allows only 25% of the maximum worker queues when server load reaches around 37% of maximum load.  For a linear response where 25% of worker queues are allowed at 75% of maximum load, set this to 1.  Setting 0 would allow maximum worker queues at all times, which is not recommended.
-* **xrd_timeout** - Timeout for fetching the XRD links. Default value is 20 seconds.
-
-## experimental ##
-
-* **exp_themes** (Boolean) - Show experimental themes as well.
-
-## theme ##
-
-* **hide_eventlist** (Boolean) - Don't show the birthdays and events on the profile and network page
-
-# Administrator Options #
+These configurations keys and their default value are listed in `config/config.ini.php` and should be ovewritten in `config/local.ini.php`.
+
+## Administrator Options
 
 Enabling the admin panel for an account, and thus making the account holder admin of the node, is done by setting the variable
 
diff --git a/mod/admin.php b/mod/admin.php
index 77a5aada7f..349e5b29ac 100644
--- a/mod/admin.php
+++ b/mod/admin.php
@@ -848,7 +848,7 @@ function admin_page_summary(App $a)
 	// Legacy config file warning
 	if (file_exists('.htconfig.php')) {
 		$showwarning = true;
-		$warningtext[] = L10n::t('Friendica\'s configuration now is stored in config/local.ini.php, please copy config/local-sample.ini.php and move your config from <code>.htconfig.php</code>.');
+		$warningtext[] = L10n::t('Friendica\'s configuration now is stored in config/local.ini.php, please copy config/local-sample.ini.php and move your config from <code>.htconfig.php</code>. See <a href="%s">the Config help page</a> for help with the transition.', $a->get_baseurl() . '/help/Config');
 	}
 
 	$r = q("SELECT `page-flags`, COUNT(`uid`) AS `count` FROM `user` GROUP BY `page-flags`");