]> git.mxchange.org Git - friendica.git/blobdiff - doc/htconfig.md
Merge pull request #2981 from rabuzarus/20161129_-_small_dfrn_request_polish
[friendica.git] / doc / htconfig.md
index 2435da2baacfa3556e786161b99c0b5db6497967..dbdbf1503349677dcdd48a9f7d7b6b08daf2f2eb 100644 (file)
@@ -1,20 +1,19 @@
 Config values that can only be set in .htconfig.php
 ===================================================
 
-There are some config values that haven't found their way into the administration page. This has several reasons. 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. Or it triggers 
-something that isn't expected to be of public interest. Or it is for testing purposes only.
+There are some config values that haven't found their way into the administration page.
+This has several reasons.
+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.
+Or it triggers something that isn't expected to be of public interest. 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.
+**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 directory value please add this 
-line to your .htconfig.php:
+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';
 
-
-
 ## Jabber ##
 * debug (Boolean) - Enable debug level for the jabber account synchronisation.
 * logfile - Logfile for the jabber account synchronisation.
@@ -23,13 +22,15 @@ line to your .htconfig.php:
 
 * birthday_input_format - Default value is "ymd".
 * block_local_dir (Boolean) - Blocks the access to the directory of the local users.
-* default_service_class - 
+* 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.
 * 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.
 * event_input_format - Default value is "ymd".
+* frontend_worker (Boolean) - Activates the frontend worker which acts as a replacement for running the poller via the command line.
+* frontend_worker_timeout - Value in minutes after we think that a frontend task was killed by the webserver. Default value is 10.
 * ignore_cache (Boolean) - For development only. Disables the item cache.
 * 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".
@@ -40,6 +41,9 @@ 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.
+* 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- Portnumberof the memcache daemon. Default is 11211.
 * no_oembed (Boolean) - Don't use OEmbed to fetch more information about a link.
 * no_oembed_rich_content (Boolean) - Don't show the rich content (e.g. embedded PDF).
 * no_smilies (Boolean) - Don't show smilies.
@@ -48,16 +52,17 @@ 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.
+* 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 - 
+* pushpoll_frequency -
 * qsearch_limit - Default value is 100.
 * relay_server - Experimental Diaspora feature. Address of the relay server where public posts should be send to. For example https://podrelay.net
 * relay_subscribe (Boolean) - Enables the receiving of public posts from the relay. They will be included in the search and on the community page when it is set up to show all public items.
-* relay_scope - Can be "all" or "tags". "all" means that every public post should be received. "tags" means that only posts witt selected tags should be received.
+* relay_scope - Can be "all" or "tags". "all" means that every public post should be received. "tags" means that only posts with selected tags should be received.
 * relay_server_tags - Comma separated list of tags for the "tags" subscription (see "relay_scrope")
 * relay_user_tags (Boolean) - If enabled, the tags from the saved searches will used for the "tags" subscription in addition to the "relay_server_tags".
 * remove_multiplicated_lines (Boolean) - If enabled, multiple linefeeds in items are stripped to a single one.
@@ -67,11 +72,12 @@ line to your .htconfig.php:
 * 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.
 * xrd_timeout - Timeout for fetching the XRD links. Default value is 20 seconds.
 
 ## service_class ##
 
-* upgrade_link - 
+* upgrade_link -
 
 ## experimentals ##
 
@@ -83,19 +89,15 @@ line to your .htconfig.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
+Enabling the admin panel for an account, and thus making the account holder admin of the node, is done by setting the variable
 
     $a->config['admin_email'] = "someone@example.com";
 
-where you have to match the email address used for the account with the one you
-enter to the .htconfig file. If more then one account should be able to access
-the admin panel, seperate the email addresses with a comma.
+Where you have to match the email address used for the account with the one you enter to the .htconfig file.
+If more then one account should be able to access the admin panel, seperate the email addresses with a comma.
 
     $a->config['admin_email'] = "someone@example.com,someonelese@example.com";
 
-If you want to have a more personalized closing line for the notification
-emails you can set a variable for the admin_name.
+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";
-