Merge remote-tracking branch 'upstream/develop' into 1706-worker-even-faster

[friendica.git] / doc / htconfig.md

diff --git a/doc/htconfig.md b/doc/htconfig.md
index 66bb9248a578fe35d13afc8c88a9c72ec1ec5377..ec961c200f680ae63c8d1f4887a70e7000e0c181 100644 (file)
--- a/doc/htconfig.md
+++ b/doc/htconfig.md
@@ -14,7 +14,7 @@ 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 directory value please add this line to your .htconfig.php:
 
-    $a->config['system']['directory'] = 'http://dir.friendi.ca';
+    $a->config['system']['directory'] = 'http://dir.friendica.social';
 
 ## jabber ##
 * **debug** (Boolean) - Enable debug level for the jabber account synchronisation.
@@ -39,7 +39,7 @@ Example: To set the directory value please add this line to your .htconfig.php:
 * **default_service_class** -
 * **delivery_batch_count** - Number of deliveries per process. Default value is 1. (Disabled when using the worker)
 * **diaspora_test** (Boolean) - For development only. Disables the message transfer.
-* **directory** - The path to global directory. If not set then "http://dir.friendi.ca" is used.
+* **directory** - The path to global directory. If not set then "http://dir.friendica.social" is used.
 * **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.
 * **dlogfile - location of the developer log file
@@ -55,6 +55,7 @@ Example: To set the directory value please add this line to your .htconfig.php:
 * **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.
 * **memcache** (Boolean) - Use memcache. To use memcache the PECL extension "memcache" has to be installed and activated.
 * **memcache_host** - Hostname of the memcache daemon. Default is '127.0.0.1'.
 * **memcache_port** - Portnumber of the memcache daemon. Default is 11211.
@@ -67,6 +68,7 @@ Example: To set the directory value please add this line to your .htconfig.php:
 * **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.
+* **worker_debug** (Boolean) - If activated, it prints out the number of running processes split by priority.
 * **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)
@@ -116,3 +118,10 @@ If more then one account should be able to access the admin panel, seperate the
 If you want to have a more personalized closing line for the notification emails you can set a variable for the admin_name.
 
     $a->config['admin_name'] = "Marvin";
+
+## Database Settings
+
+The configuration variables db_host, db_user, db_pass and db_data 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 db_host variable.
+
+    $db_host = 'your.mysqlhost.com:123456';