doc/htconfig.md

   1 Config values that can only be set in .htconfig.php
   2 ===================================================
   3
   4 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
   5 current development that isn't considered stable and will be added later in the administration page when it is considered safe. Or it triggers
   6 something that isn't expected to be of public interest. Or it is for testing purposes only.
   7
   8 **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
   9 undocumented values.
  10
  11 The header of the section describes the category, the value is the parameter. Example: To set the directory value please add this
  12 line to your .htconfig.php:
  13
  14     $a->config['system']['directory'] = 'http://dir.friendi.ca';
  15
  16
  17
  18 ## Jabber ##
  19 * debug (Boolean) - Enable debug level for the jabber account synchronisation.
  20 * logfile - Logfile for the jabber account synchronisation.
  21
  22 ## System ##
  23
  24 * birthday_input_format - Default value is "ymd".
  25 * block_local_dir (Boolean) - Blocks the access to the directory of the local users.
  26 * default_service_class -
  27 * delivery_batch_count - Number of deliveries per process. Default value is 1. (Disabled when using the worker)
  28 * diaspora_test (Boolean) - For development only. Disables the message transfer.
  29 * directory - The path to global directory. If not set then "http://dir.friendi.ca" is used.
  30 * disable_email_validation (Boolean) - Disables the check if a mail address is in a valid format and can be resolved via DNS.
  31 * disable_url_validation (Boolean) - Disables the DNS lookup of an URL.
  32 * event_input_format - Default value is "ymd".
  33 * ignore_cache (Boolean) - For development only. Disables the item cache.
  34 * like_no_comment (Boolean) - Don't update the "commented" value of an item when it is liked.
  35 * local_block (Boolean) - Used in conjunction with "block_public".
  36 * local_search (Boolean) - Blocks the search for not logged in users to prevent crawlers from blocking your system.
  37 * max_connections - The poller process isn't started when the maximum level of the possible database connections are used. When the system can't detect the maximum numbers of connection then this value can be used.
  38 * max_connections_level - The maximum level of connections that are allowed to let the poller start. It is a percentage value. Default value is 75.
  39 * max_contact_queue - Default value is 500.
  40 * max_batch_queue - Default value is 1000.
  41 * no_oembed (Boolean) - Don't use OEmbed to fetch more information about a link.
  42 * no_oembed_rich_content (Boolean) - Don't show the rich content (e.g. embedded PDF).
  43 * no_smilies (Boolean) - Don't show smilies.
  44 * no_view_full_size (Boolean) - Don't add the link "View full size" under a resized image.
  45 * optimize_items (Boolean) - Triggers an SQL command to optimize the item table before expiring items.
  46 * ostatus_poll_timeframe - Defines how old an item can be to try to complete the conversation with it.
  47 * paranoia (Boolean) - Log out users if their IP address changed.
  48 * permit_crawling (Boolean) - Restricts the search for not logged in users to one search per minute.
  49 * free_crawls - Number of "free" searches when "permit_crawling" is activated (Default value is 10)
  50 * 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)
  51 * png_quality - Default value is 8.
  52 * proc_windows (Boolean) - Should be enabled if Friendica is running under Windows.
  53 * proxy_cache_time - Time after which the cache is cleared. Default value is one day.
  54 * pushpoll_frequency -
  55 * qsearch_limit - Default value is 100.
  56 * relay_server - Experimental Diaspora feature. Address of the relay server where public posts should be send to. For example https://podrelay.net
  57 * 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.
  58 * 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.
  59 * relay_server_tags - Comma separated list of tags for the "tags" subscription (see "relay_scrope")
  60 * 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".
  61 * remove_multiplicated_lines (Boolean) - If enabled, multiple linefeeds in items are stripped to a single one.
  62 * show_unsupported_addons (Boolean) - Show all addons including the unsupported ones.
  63 * show_unsupported_themes (Boolean) - Show all themes including the unsupported ones.
  64 * throttle_limit_day - Maximum number of posts that a user can send per day with the API.
  65 * throttle_limit_week - Maximum number of posts that a user can send per week with the API.
  66 * throttle_limit_month - Maximum number of posts that a user can send per month with the API.
  67 * wall-to-wall_share (Boolean) - Displays forwarded posts like "wall-to-wall" posts.
  68 * xrd_timeout - Timeout for fetching the XRD links. Default value is 20 seconds.
  69
  70 ## service_class ##
  71
  72 * upgrade_link -
  73
  74 ## experimentals ##
  75
  76 * exp_themes (Boolean) - Show experimental themes as well.
  77
  78 ## theme ##
  79
  80 * hide_eventlist (Boolean) - Don't show the birthdays and events on the profile and network page
  81
  82 # Administrator Options #
  83
  84 Enabling the admin panel for an account, and thus making the account holder
  85 admin of the node, is done by setting the variable
  86
  87     $a->config['admin_email'] = "someone@example.com";
  88
  89 where you have to match the email address used for the account with the one you
  90 enter to the .htconfig file. If more then one account should be able to access
  91 the admin panel, seperate the email addresses with a comma.
  92
  93     $a->config['admin_email'] = "someone@example.com,someonelese@example.com";
  94
  95 If you want to have a more personalized closing line for the notification
  96 emails you can set a variable for the admin_name.
  97
  98     $a->config['admin_name'] = "Marvin";
  99