3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 * This file declares the default values for the base config of Friendica.
22 * These configuration values aren't accessible from the admin settings page and custom values must be set in config/local.config.php
24 * Please don't edit this file directly as its content may change in the upcoming versions.
31 // Hostname or IP address of the database server.
32 // Can contain the port number with the syntax "hostname:port".
36 // Port of the database server.
37 // Can be used instead of adding a port number to the hostname
41 // Socket of the database server.
42 // Can be used instead of adding a socket location to the hostname
46 // Database user name. Please don't use "root".
50 // Database user password. Please don't use empty passwords.
58 // Database connection charset. Changing this value will likely corrupt special characters.
59 'charset' => 'utf8mb4',
61 // pdo_emulate_prepares (Boolean)
62 // If enabled, the builtin emulation for prepared statements is used.
63 // This can be used as a workaround for the database error "Prepared statement needs to be re-prepared".
64 'pdo_emulate_prepares' => true,
66 // disable_pdo (Boolean)
67 // PDO is used by default (if available). Otherwise MySQLi will be used.
68 'disable_pdo' => false,
70 // persistent (Boolean)
71 // This controls if the system should use persistent connections or not.
72 // Persistent connections increase the performance.
73 // On the other hand the number of open connections are higher,
74 // this will most likely increase the system load.
75 'persistent' => false,
78 // admin_email (Comma-separated list)
79 // In order to perform system administration via the admin panel,
80 // this must precisely match the email address of the person logged in.
83 // admin_nickname (String)
84 // Nickname of the main admin user, used if there are more than one admin user defined in config => admin_email.
85 'admin_nickname' => '',
87 // max_import_size (Integer)
88 // Maximum body size of DFRN and Mail messages in characters. 0 is unlimited.
89 'max_import_size' => 200000,
92 // Location of PHP command line processor.
96 // adjust_poll_frequency (Boolean)
97 // Automatically detect and set the best feed poll frequency.
98 'adjust_poll_frequency' => false,
100 // allowed_link_protocols (Array)
101 // Allowed protocols in links URLs, add at your own risk. http(s) is always allowed.
102 'allowed_link_protocols' => ['ftp://', 'ftps://', 'mailto:', 'cid:', 'gopher://'],
104 // always_show_preview (Boolean)
105 // Only show small preview pictures.
106 'always_show_preview' => false,
108 // ap_always_bcc (Boolean)
109 // Adresses non-mentioned ActivityPub receivers by BCC instead of CC. Increases privacy, decreases performance.
110 'ap_always_bcc' => false,
112 // archival_days (Integer)
113 // Number of days that we try to deliver content before we archive a contact.
114 'archival_days' => 32,
116 // auth_cookie_lifetime (Integer)
117 // Number of days that should pass without any activity before a user who
118 // chose "Remember me" when logging in is considered logged out.
119 'auth_cookie_lifetime' => 7,
121 // avatar_cache (Boolean)
122 // Cache avatar pictures as files (experimental)
123 'avatar_cache' => false,
125 // avatar_cache_path (String)
126 // File path to the avatar cache. Default is /(your basepath)/avatar/
127 // The value has to be an absolute path and has to end with a "/"
128 'avatar_cache_path' => '',
130 // avatar_cache_url (String)
131 // Base URL of the avatar cache. Default is http(s)://(your hostname)/avatar/
132 // The value has to start with the scheme and end with a "/"
133 'avatar_cache_url' => '',
135 // big_emojis (Boolean)
136 // Display "Emoji Only" posts in big.
137 'big_emojis' => false,
139 // bulk_delivery (Boolean)
140 // Delivers AP messages in a bulk (experimental)
141 'bulk_delivery' => false,
143 // block_local_dir (Boolean)
144 // Deny public access to the local user directory.
145 'block_local_dir' => false,
147 // blocked_tags (String)
148 // Comma separated list of hash tags that shouldn't be displayed in the trending tags
149 'blocked_tags' => '',
151 // community_no_sharer (Boolean)
152 // Don't display sharing accounts on the global community
153 'community_no_sharer' => false,
155 // contact_update_limit (Integer)
156 // How much contacts should be checked at a time?
157 'contact_update_limit' => 100,
159 // cron_interval (Integer)
160 // Minimal period in minutes between two calls of the "Cron" worker job.
161 'cron_interval' => 5,
163 // cache_driver (database|memcache|memcached|redis|apcu)
164 // Whether to use Memcache, Memcached, Redis or APCu to store temporary cache.
165 'cache_driver' => 'database',
167 // decoupled_receiver (Boolean)
168 // Decouple incoming AP posts by doing the processing in the background.
169 'decoupled_receiver' => false,
171 // distributed_cache_driver (database|memcache|memcached|redis)
172 // Whether to use database, Memcache, Memcached or Redis as a distributed cache.
173 'distributed_cache_driver' => 'database',
175 // config_adapter (jit|preload)
176 // Allow to switch the configuration adapter to improve performances at the cost of memory consumption.
177 'config_adapter' => 'jit',
179 // curl_range_bytes (Integer)
180 // Maximum number of bytes that should be fetched. Default is 0, which mean "no limit".
181 'curl_range_bytes' => 0,
183 // crawl_permit_period (Integer)
184 // Period in seconds between allowed searches when the number of free searches is reached and "permit_crawling" is activated.
185 'crawl_permit_period' => 60,
188 // Name of a logfile to log slow database queries.
191 // db_log_index (Path)
192 // Name of a logfile to log queries with bad indexes.
193 'db_log_index' => '',
195 // db_log_index_watch (Comma-separated list)
196 // Watchlist of indexes to watch.
197 'db_log_index_watch' => '',
199 // db_log_index_denylist (Comma-separated list)
200 // Deny list of indexes that shouldn't be watched.
201 'db_log_index_denylist' => '',
203 // db_loglimit (Integer)
204 // If a database call lasts longer than this value in seconds it is logged.
205 // Inactive if system => db_log is empty.
208 // db_loglimit_index (Integer)
209 // Number of index rows needed to be logged for indexes on the watchlist. 0 to disable.
210 'db_loglimit_index' => 0,
212 // db_loglimit_index_high (Integer)
213 // Number of index rows to be logged anyway (for any index). 0 to disable.
214 'db_loglimit_index_high' => 0,
216 // dbclean_expire_conversation (Integer)
217 // When DBClean is enabled, any entry in the conversation table will be deleted after this many days.
218 // This data is used for ActivityPub, so it shouldn't be lower than the average duration of a discussion.
219 'dbclean_expire_conversation' => 90,
221 // dbclean-expire-limit (Integer)
222 // This defines the number of items that are to be deleted in a single call.
223 // Reduce this value when you are getting lock issues.
224 // A value of 0 disables the deletion process.
225 'dbclean-expire-limit' => 1000,
227 // daemon_watchdog (Boolean)
228 // Enable regular checking if the daemon is running.
229 // If it is not running and hadn't been terminated normally, it will be started automatically.
230 'daemon_watchdog' => false,
232 // delete_sleeping_processes (Boolean)
233 // Periodically delete waiting database processes.
234 'delete_sleeping_processes' => false,
236 // dice_profiler_threshold (Float)
237 // For profiling Dice class creation (0 = disabled, >0 = seconds threshold for profiling)
238 'dice_profiler_threshold' => 0.5,
240 // diaspora_test (Boolean)
241 // For development only. Disables the message transfer.
242 'diaspora_test' => false,
244 // disable_email_validation (Boolean)
245 // Disables the check if a mail address is in a valid format and can be resolved via DNS.
246 'disable_email_validation' => false,
248 // disable_implicit_mentions (Boolean) since 2019.03
249 // Implicit mentions are mentions in the body of replies that are redundant in a thread-enabled system like Friendica.
250 // This config key disables the gathering of implicit mentions in incoming and outgoing posts.
251 // Also disables the default automatic removal of implicit mentions from the body of incoming posts.
252 // Also disables the default automatic addition of implicit mentions in the body of outgoing posts.
253 // Disabling implicit mentions also affects the "explicit_mentions" additional feature by limiting it
254 // to the replied-to post author mention in the comment boxes.
255 'disable_implicit_mentions' => false,
257 // disable_url_validation (Boolean)
258 // Disables the DNS lookup of an URL.
259 'disable_url_validation' => false,
261 // disable_password_exposed (Boolean)
262 // Disable the exposition check against the remote haveibeenpwned API on password change.
263 'disable_password_exposed' => false,
265 // disable_polling (Boolean)
266 // Disable the polling of DFRN and OStatus contacts through onepoll.php.
267 'disable_polling' => false,
269 // display_resharer (Boolean)
270 // Display the first resharer as icon and text on a reshared item.
271 'display_resharer' => false,
274 // location of the developer log file.
278 // restricts develop log writes to requests originating from this IP address.
281 // expire-notify-priority (integer)
282 // Priority for the expirary notification
283 'expire-notify-priority' => PRIORITY_LOW,
285 // free_crawls (Integer)
286 // Number of "free" searches when system => permit_crawling is enabled.
289 // groupedit_image_limit (Integer)
290 // Number of contacts at which the group editor should switch from display the profile pictures of the contacts to only display the names.
291 // This can alternatively be set on a per account basis in the pconfig table.
292 'groupedit_image_limit' => 400,
294 // gserver_update_limit (Integer)
295 // How much servers should be checked at a time?
296 'gserver_update_limit' => 100,
299 // Enables the sending of HTTP Strict Transport Security headers.
302 // ignore_cache (Boolean)
303 // For development only. Disables the item cache.
304 'ignore_cache' => false,
306 // insecure_imap (Boolean)
307 // If enabled, users are allowed to connect to their IMAP servers unencrypted.
308 // For security reasons this is disabled by default.
309 'insecure_imap' => false,
311 // instances_social_key (String)
312 // Key to the API of https://instances.social which retrieves data about mastodon servers.
313 // See https://instances.social/api/token to get an API key.
314 'instances_social_key' => '',
316 // ipv4_resolve (Boolean)
317 // Resolve IPV4 addresses only. Don't resolve to IPV6.
318 'ipv4_resolve' => false,
320 // invitation_only (Boolean)
321 // If set true registration is only possible after a current member of the node has send an invitation.
322 'invitation_only' => false,
324 // itemspage_network (Integer)
325 // default number of items per page in stream pages (network, community, profile/contact statuses, search)
326 'itemspage_network' => 40,
328 // itemspage_network_mobile (Integer)
329 // default number of items per page in stream pages (network, community, profile/contact statuses, search)
330 // on detected mobile devices
331 'itemspage_network_mobile' => 20,
333 // jpeg_quality (Integer)
335 // Lower numbers save space at cost of image detail
336 // where n is between 1 and 100, and with very poor results below about 50
337 'jpeg_quality' => 100,
339 // like_no_comment (Boolean)
340 // Don't update the "commented" value of an item when it is liked.
341 'like_no_comment' => false,
343 // local_block (Boolean)
344 // Used in conjunction with "block_public".
345 'local_block' => false,
347 // local_search (Boolean)
348 // Blocks search for users who are not logged in to prevent crawlers from blocking your system.
349 'local_search' => false,
351 // local_tags (Boolean)
352 // If activated, all hashtags will point to the local server.
353 'local_tags' => false,
355 // logger_config (String)
356 // Sets the logging adapter of Friendica globally (monolog, syslog, stream)
357 'logger_config' => 'stream',
359 // syslog flags (Integer)
360 // Sets the syslog flags in case 'logger_config' is set to 'syslog'
361 'syslog_flags' => LOG_CONS | LOG_PID | LOG_ODELAY,
363 // syslog flags (Integer)
364 // Sets the syslog facility in case 'logger_config' is set to 'syslog'
365 'syslog_facility' => LOG_USER,
367 // maintenance_start (String)
368 // Start of the window for the daily maintenance cron call.
369 // The system timezone is used when no timezone is defined here.
370 'maintenance_start' => '01:00 +00:00',
372 // maintenance_end (String)
373 // End of the window for the daily maintenance cron call
374 // The system timezone is used when no timezone is defined here.
375 'maintenance_end' => '03:00 +00:00',
377 // max_batch_queue (Integer)
378 // Maximum number of batched queue items for a single contact before subsequent messages are discarded.
379 'max_batch_queue' => 1000,
381 // max_connections (Integer)
382 // The maximum number of database connections which can be in use before the worker process is deferred to its next interval.
383 // When the system can't detect the maximum numbers of connection then this value can be used. Use 0 for auto-detection.
384 'max_connections' => 0,
386 // max_connections_level (Integer 0-100)
387 // The maximum percentage of connections that are allowed to let the worker start.
388 'max_connections_level' => 75,
390 // max_contact_queue (Integer)
391 // Maximum number of queue items for a single contact before subsequent messages are discarded.
392 'max_contact_queue' => 500,
394 // max_csv_file_size (Integer)
395 // When uploading a CSV with account addresses to follow
396 // in the user settings, this controls the maximum file
397 // size of the upload file.
398 'max_csv_file_size' => 30720,
400 // max_feed_items (Integer)
401 // Maximum number of feed items that are fetched and processed. For unlimited items set to 0.
402 'max_feed_items' => 20,
404 // max_image_length (Integer)
405 // An alternate way of limiting picture upload sizes.
406 // Specify the maximum pixel length that pictures are allowed to be (for non-square pictures, it will apply to the longest side).
407 // Pictures longer than this length will be resized to be this length (on the longest side, the other side will be scaled appropriately).
408 // If you don't want to set a maximum length, set to -1.
409 'max_image_length' => -1,
411 // max_likers (Integer)
412 // Maximum number of "people who like (or don't like) this" that we will list by name
415 // max_processes_backend (Integer)
416 // Maximum number of concurrent database processes for background tasks.
417 'max_processes_backend' => 5,
419 // max_processes_frontend (Integer)
420 // Maximum number of concurrent database processes for foreground tasks.
421 'max_processes_frontend' => 20,
423 // max_recursion_depth (Integer)
424 // Maximum recursion depth when fetching posts until the job is delegated to a worker task.
425 'max_recursion_depth' => 10,
427 // maximagesize (Integer)
428 // Maximum size in bytes of an uploaded photo.
429 'maximagesize' => 800000,
431 // memcache_host (String)
432 // Host name of the memcache daemon.
433 'memcache_host' => '127.0.0.1',
435 // memcache_port (Integer)
436 // Port number of the memcache daemon.
437 'memcache_port' => 11211,
439 // memcached_hosts (Array)
440 // Array of Memcached servers info [host, port(, weight)], see Memcached::addServers.
441 'memcached_hosts' => [
442 ['127.0.0.1', '11211'],
445 // min_poll_interval (Integer)
446 // minimal distance in minutes between two polls for a contact. Reasonable values are between 1 and 59.
447 'min_poll_interval' => 15,
449 // minimum_posting_interval (Integer)
450 // Minimum interval between two feed posts per user
451 'minimum_posting_interval' => 0,
453 // no_count (Boolean)
454 // Don't do count calculations (currently only when showing photo albums).
457 // no_oembed (Boolean)
458 // Don't use OEmbed to fetch more information about a link.
459 'no_oembed' => false,
461 // no_redirect_list (Array)
462 // List of domains where HTTP redirects should be ignored.
463 'no_redirect_list' => [],
465 // no_smilies (Boolean)
466 // Don't show smilies.
467 'no_smilies' => false,
469 // paranoia (Boolean)
470 // Log out users if their IP address changed.
473 // permit_crawling (Boolean)
474 // Restricts the search for not logged in users to one search per minute.
475 'permit_crawling' => false,
478 // Daemon pid file path. For example: pidfile = /path/to/daemon.pid
481 // png_quality (Integer)
482 // Sets the ImageMagick compression level for PNG images. Values ranges from 0 (uncompressed) to 9 (most compressed).
485 // profiler (Boolean)
486 // Enable internal timings to help optimize code. Needed for "rendertime" addon.
489 // pushpoll_frequency (Integer)
490 // Frequency of contact poll for subhub contact using the DFRM or OStatus network.
497 // - 0 = every minute
498 'pushpoll_frequency' => 3,
500 // redis_host (String)
501 // Host name of the redis daemon.
502 'redis_host' => '127.0.0.1',
504 // redis_port (String)
505 // Port number of the redis daemon.
506 'redis_port' => 6379,
508 // redis_db (Integer)
509 // The sub-database of redis (0 - 15 possible sub-databases)
512 // redis_password (String)
513 // The authentication password for the redis database
514 'redis_password' => null,
516 // session_handler (database|cache|native)
517 // Whether to use Cache to store session data or to use PHP native session storage.
518 'session_handler' => 'database',
520 // remote_avatar_lookup (Boolean)
521 // Perform an avatar lookup via the activated services for remote contacts
522 'remote_avatar_lookup' => false,
524 // remove_multiplicated_lines (Boolean)
525 // If enabled, multiple linefeeds in items are stripped to a single one.
526 'remove_multiplicated_lines' => false,
528 // runtime_ignore (Array)
529 // List of ignored commands for the runtime logging.
530 'runtime_ignore' => [],
532 // runtime_loglimit (Integer)
533 // The runtime is logged, When the program execution time is higher than this value.
534 'runtime_loglimit' => 0,
536 // sendmail_params (Boolean)
537 // Normal sendmail command parameters will be added when the PHP mail() function is called for sending e-mails.
538 // This ensures the Sender Email address setting is applied to the message envelope rather than the host's default address.
539 // Set to false if your non-sendmail agent is incompatible, or to restore old behavior of using the host address.
540 'sendmail_params' => true,
542 // set_creation_date (Boolean)
543 // When enabled, the user can enter a creation date when composing a post.
544 'set_creation_date' => false,
546 // show_global_community_hint (Boolean)
547 // When the global community page is enabled, use this option to display a hint above the stream, that this is a collection of all public top-level postings that arrive on your node.
548 'show_global_community_hint' => false,
550 // show_received (Boolean)
551 // Show the receive data along with the post creation date
552 'show_received' => true,
554 // show_received_seconds (Integer)
555 // Display the received date when the difference between received and created is higher than this.
556 'show_received_seconds' => 500,
558 // show_unsupported_addons (Boolean)
559 // Show all addons including the unsupported ones.
560 'show_unsupported_addons' => false,
562 // show_unsupported_themes (Boolean)
563 // Show all themes including the unsupported ones.
564 'show_unsupported_themes' => false,
566 // throttle_limit_day (Integer)
567 // Maximum number of posts that a user can send per day with the API. 0 to disable daily throttling.
568 'throttle_limit_day' => 0,
570 // throttle_limit_week (Integer)
571 // Maximum number of posts that a user can send per week with the API. 0 to disable weekly throttling.
572 'throttle_limit_week' => 0,
574 // throttle_limit_month (Integer)
575 // Maximum number of posts that a user can send per month with the API. 0 to disable monthly throttling.
576 'throttle_limit_month' => 0,
578 // transmit_pending_events (Boolean)
579 // Transmit pending events upon accepted contact request for forums
580 'transmit_pending_events' => false,
582 // update_active_contacts (Boolean)
583 // When activated, only public contacts will be activated regularly that are used for example in items or tags.
584 'update_active_contacts' => false,
586 // username_min_length (Integer)
587 // The minimum character length a username can be.
588 // This length is check once the username has been trimmed and multiple spaces have been collapsed into one.
589 // Minimum for this config value is 1. Maximum is 64 as the resulting profile URL mustn't be longer than 255 chars.
590 'username_min_length' => 3,
592 // username_max_length (Integer)
593 // The maximum character length a username can be.
594 // This length is check once the username has been trimmed and multiple spaces have been collapsed into one.
595 // Minimum for this config value is 1. Maximum is 64 as the resulting profile URL mustn't be longer than 255 chars.
596 'username_max_length' => 48,
598 // worker_cooldown (Integer)
599 // Cooldown period in seconds after each worker function call.
600 'worker_cooldown' => 0,
602 // worker_debug (Boolean)
603 // If enabled, it prints out the number of running processes split by priority.
604 'worker_debug' => false,
606 // worker_fetch_limit (Integer)
607 // Number of worker tasks that are fetched in a single query.
608 'worker_fetch_limit' => 1,
610 // worker_fork (Boolean)
611 // Experimental setting. Use pcntl_fork to spawn a new worker process.
612 // Does not work when "worker_multiple_fetch" is enabled (Needs more testing)
613 'worker_fork' => false,
615 // worker_jpm (Boolean)
616 // If enabled, it prints out the jobs per minute.
617 'worker_jpm' => false,
619 // worker_jpm_range (String)
620 // List of minutes for the jobs per minute (JPM) calculation
621 'worker_jpm_range' => '1, 10, 60',
623 // worker_load_exponent (Integer)
624 // Default 3, which allows only 25% of the maximum worker queues when server load reaches around 37% of maximum load.
625 // For a linear response where 25% of worker queues are allowed at 75% of maximum load, set this to 1.
626 // Setting 0 would allow maximum worker queues at all times, which is not recommended.
627 'worker_load_exponent' => 3,
629 // worker_multiple_fetch (Boolean)
630 // When activated, the worker fetches jobs for multiple workers (not only for itself).
631 // This is an experimental setting without knowing the performance impact.
632 // Does not work when "worker_fork" is enabled (Needs more testing)
633 'worker_multiple_fetch' => false,
635 // worker_defer_limit (Integer)
636 // Per default the systems tries delivering for 15 times before dropping it.
637 'worker_defer_limit' => 15,
639 // xrd_timeout (Integer)
640 // Timeout in seconds for fetching the XRD links and other requests with an expected shorter timeout
644 // forwarded_for_headers (String)
645 // A comma separated list of all allowed header values to retrieve the real client IP
646 // The headers are evaluated in order.
647 'forwarded_for_headers' => 'HTTP_X_FORWARDED_FOR',
649 // trusted_proxies (String)
650 // A comma separated list of all trusted proxies, which will get skipped during client IP retrieval
651 // IP ranges and CIDR notations are allowed
652 'trusted_proxies' => '',
655 // exp_themes (Boolean)
656 // Show experimental themes in user settings.
657 'exp_themes' => false,
660 // hide_eventlist (Boolean)
661 // Don't show the birthdays and events on the profile and network page.
662 'hide_eventlist' => false,
666 // Enable debug level for the jabber account synchronisation.
669 // Must be writable by the ejabberd process. if set then it will prevent the running of multiple processes.
673 // ap_inbox_log (Boolean)
674 // Logs every call to /inbox as a JSON file in Friendica's temporary directory
675 'ap_inbox_log' => false,
677 // ap_inbox_store_untrusted (Boolean)
678 // Store untrusted content in the inbox entries
679 'ap_inbox_store_untrusted' => false,
681 // total_ap_delivery (Boolean)
682 // Deliver via AP to every possible receiver and we suppress the delivery to these contacts with other protocols
683 'total_ap_delivery' => false,
685 // ap_log_unknown (Boolean)
686 // Logs every unknown ActivityPub activity
687 'ap_log_unknown' => false,
689 // ap_log_failure (Boolean)
690 // Logs every ActivityPub activity that couldn't be compacted
691 'ap_log_failure' => false,