Prevent some E_NOTICE in identity.php

[friendica.git] / doc / htconfig.md

diff --git a/doc/htconfig.md b/doc/htconfig.md
index 4c2318129e68ba0500b10cbd972fc3307e90a323..f9c92bfa084efafd475958af90c4a169aa86dd80 100644 (file)
--- a/doc/htconfig.md
+++ b/doc/htconfig.md
@@ -5,9 +5,16 @@ There are some config values that haven't found their way into the administratio
 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.
 
-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 
+**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:
+
+    $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.
@@ -27,6 +34,7 @@ undocumented values.
 * 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 the search for not logged in users to prevent crawlers from blocking your system.
+* max_connections - The poller process isn't started when 3/4 of the possible database connections are used. When the system can't detect the maximum numbers of connection then this value can be used.
 * max_contact_queue - Default value is 500.
 * max_batch_queue - Default value is 1000.
 * no_oembed (Boolean) - Don't use OEmbed to fetch more information about a link.
@@ -37,6 +45,8 @@ undocumented values.
 * 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.
+* 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.
@@ -70,3 +80,22 @@ undocumented values.
 ## theme ##
 
 * hide_eventlist (Boolean) - Don't show the birthdays and events on the profile and network page
+
+# 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
+
+    $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.
+
+    $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.
+
+    $a->config['admin_name'] = "Marvin";
+