Documentation of .htconfig.php values

diff --git a/doc/Home.md b/doc/Home.md
index ff991e3d2a052c3bb283d4b907eb1332af91a7b4..11b1f9e159197fa8884f66d7c81ee2b373b4c044 100644 (file)
--- a/doc/Home.md
+++ b/doc/Home.md
@@ -33,6 +33,7 @@ Friendica Documentation and Resources
 * [Message Flow](help/Message-Flow)
 * [Using SSL with Friendica](help/SSL)
 * [Twitter/GNU Social API Functions](help/api)
+* [Config values that can only be set in .htconfig.php](help/htconfig)
 
 **Developer Manual**
 

diff --git a/doc/de/Home.md b/doc/de/Home.md
index 561809d6ce4ba23d697649e63d627eee79186e78..a101b5f734d9fb0f704acd284f3f1504965e6800 100644 (file)
--- a/doc/de/Home.md
+++ b/doc/de/Home.md
@@ -37,6 +37,7 @@ Friendica - Dokumentation und Ressourcen
 * [Entwickler](help/Developers)
 * [Twitter/GNU Social API Functions](help/api) (EN)
 * [Translation of Friendica](help/translations) (EN)
+* [Konfigurationswerte, die nur in der .htconfig.php gesetzt werden können](help/htconfig) (EN)
 
 **Entwickler Dokumentation**
 

diff --git a/doc/htconfig.md b/doc/htconfig.md
new file mode 100644 (file)
index 0000000..4c23181
--- /dev/null
+++ b/doc/htconfig.md
@@ -0,0 +1,72 @@
+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.
+
+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.
+
+## Jabber ##
+* debug (Boolean) - Enable debug level for the jabber account synchronisation.
+* logfile - Logfile for the jabber account synchronisation.
+
+## System ##
+
+* birthday_input_format - Default value is "ymd".
+* block_local_dir (Boolean) - Blocks the access to the directory of the local users.
+* 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".
+* 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".
+* local_search (Boolean) - Blocks the search for not logged in users to prevent crawlers from blocking your system.
+* 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.
+* no_oembed_rich_content (Boolean) - Don't show the rich content (e.g. embedded PDF).
+* 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.
+* 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.
+* 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_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.
+* show_unsupported_addons (Boolean) - Show all addons including the unsupported ones.
+* show_unsupported_themes (Boolean) - Show all themes including the unsupported ones.
+* 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 (Boolean) - (Experimental) Use the worker system instead of calling several background processes. Reduces the overall load and speeds up item delivery.
+* worker_dont_fork (Boolean) - if enabled, the workers are only called from the poller process. Useful on systems that permit the use of "proc_open".
+* worker_queues - Number of parallel workers. Default value is 10 queues.
+* xrd_timeout - Timeout for fetching the XRD links. Default value is 20 seconds.
+
+## service_class ##
+
+* upgrade_link - 
+
+## experimentals ##
+
+* 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