typo
[friendica.git/.git] / config / defaults.config.php
1 <?php
2
3 // CONFIG.PHP
4
5 /* This file declares the default values for the base config of Friendica.
6  *
7  * These configuration values aren't accessible from the admin settings page and custom values must be set in config/local.config.php
8  *
9  * Please don't edit this file directly as its content may change in the upcoming versions.
10  */
11
12 return [
13         'database' => [
14                 // host (String)
15                 // Hostname or IP address of the database server.
16                 // Can contain the port number with the syntax "hostname:port".
17                 'hostname' => '',
18
19                 // user (String)
20                 // Database user name. Please don't use "root".
21                 'username' => '',
22
23                 // pass (String)
24                 // Database user password. Please don't use empty passwords.
25                 'password' => '',
26
27                 // base (String)
28                 // Database name.
29                 'database' => '',
30
31                 // charset (String)
32                 // Database connexion charset. Changing this value will likely corrupt special characters.
33                 'charset' => 'utf8mb4',
34         ],
35         'config' => [
36                 // admin_email (Comma-separated list)
37                 // In order to perform system administration via the admin panel,
38                 // this must precisely match the email address of the person logged in.
39                 'admin_email' => '',
40
41                 // admin_nickname (String)
42                 // Nickname of the main admin user, used if there are more than one admin user defined in config => admin_email.
43                 'admin_nickname' => '',
44
45                 // max_import_size (Integer)
46                 // Maximum body size of DFRN and Mail messages in characters. 0 is unlimited.
47                 'max_import_size' => 200000,
48
49                 // php_path (String)
50                 // Location of PHP command line processor.
51                 'php_path' => 'php',
52         ],
53         'system' => [
54                 // allowed_link_protocols (Array)
55                 // Allowed protocols in links URLs, add at your own risk. http is always allowed.
56                 'allowed_link_protocols' => ['ftp', 'ftps', 'mailto', 'cid', 'gopher'],
57
58                 // always_show_preview (Boolean)
59                 // Only show small preview pictures.
60                 'always_show_preview' => false,
61
62                 // archival_days (Integer)
63                 // Number of days that we try to deliver content before we archive a contact.
64                 'archival_days' => 32,
65
66                 // auth_cookie_lifetime (Integer)
67                 // Number of days that should pass without any activity before a user who
68                 // chose "Remember me" when logging in is considered logged out.
69                 'auth_cookie_lifetime' => 7,
70
71                 // block_local_dir (Boolean)
72                 // Deny public access to the local user directory.
73                 'block_local_dir' => false,
74
75                 // cache_driver (database|memcache|memcached|redis)
76                 // Whether to use Memcache or Memcached or Redis to store temporary cache.
77                 'cache_driver' => 'database',
78
79                 // config_adapter (jit|preload)
80                 // Allow to switch the configuration adapter to improve performances at the cost of memory consumption.
81                 'config_adapter' => 'jit',
82
83                 // curl_range_bytes (Integer)
84                 // Maximum number of bytes that should be fetched. Default is 0, which mean "no limit".
85                 'curl_range_bytes' => 0,
86
87                 // crawl_permit_period (Integer)
88                 // Period in seconds between allowed searches when the number of free searches is reached and "permit_crawling" is activated.
89                 'crawl_permit_period' => 60,
90
91                 // db_log (Path)
92                 // Name of a logfile to log slow database queries.
93                 'db_log' => '',
94
95                 // db_log_index (Path)
96                 // Name of a logfile to log queries with bad indexes.
97                 'db_log_index' => '',
98
99                 // db_log_index_watch (Comma-separated list)
100                 // Watchlist of indexes to watch.
101                 'db_log_index_watch' => '',
102
103                 // db_log_index_blacklist (Comma-separated list)
104                 // Blacklist of indexes that shouldn't be watched.
105                 'db_log_index_blacklist' => '',
106
107                 // db_loglimit (Integer)
108                 // If a database call lasts longer than this value in seconds it is logged.
109                 // Inactive if system => db_log is empty.
110                 'db_loglimit' => 10,
111
112                 // db_loglimit_index (Integer)
113                 // Number of index rows needed to be logged for indexes on the watchlist. 0 to disable.
114                 'db_loglimit_index' => 0,
115
116                 // db_loglimit_index_high (Integer)
117                 // Number of index rows to be logged anyway (for any index). 0 to disable.
118                 'db_loglimit_index_high' => 0,
119
120                 // dbclean_expire_conversation (Integer)
121                 // When DBClean is enabled, any entry in the conversation table will be deleted after this many days.
122                 // This data is used for ActivityPub, so it shouldn't be lower than the average duration of a discussion.
123                 'dbclean_expire_conversation' => 90,
124
125                 // dbclean-expire-limit (Integer)
126                 // This defines the number of items that are to be deleted in a single call.
127                 // Reduce this value when you are getting memory issues.
128                 'dbclean-expire-limit' => 1000,
129
130                 // diaspora_test (Boolean)
131                 // For development only. Disables the message transfer.
132                 'diaspora_test' => false,
133
134                 // disable_email_validation (Boolean)
135                 // Disables the check if a mail address is in a valid format and can be resolved via DNS.
136                 'disable_email_validation' => false,
137
138                 // disable_mentions_removal (Boolean)
139                 // Disables the automatic removal of implicit mentions in ActivityPub postings.
140                 'disable_mentions_removal' => false,
141
142                 // disable_url_validation (Boolean)
143                 // Disables the DNS lookup of an URL.
144                 'disable_url_validation' => false,
145
146                 // disable_password_exposed (Boolean)
147                 // Disable the exposition check against the remote haveibeenpwned API on password change.
148                 'disable_password_exposed' => false,
149
150                 // disable_polling (Boolean)
151                 // Disable the polling of DFRN and OStatus contacts through onepoll.php.
152                 'disable_polling' => false,
153
154                 // dlogfile (Path)
155                 // location of the developer log file.
156                 'dlogfile' => '',
157
158                 // dlogip (String)
159                 // restricts develop log writes to requests originating from this IP address.
160                 'dlogip' => '',
161
162                 // free_crawls (Integer)
163                 // Number of "free" searches when system => permit_crawling is enabled.
164                 'free_crawls' => 10,
165
166                 // frontend_worker_timeout (Integer)
167                 // Value in minutes after we think that a frontend task was killed by the webserver.
168                 'frontend_worker_timeout' => 10,
169
170                 // groupedit_image_limit (Integer)
171                 // Number of contacts at which the group editor should switch from display the profile pictures of the contacts to only display the names.
172                 // This can alternatively be set on a per account basis in the pconfig table.
173                 'groupedit_image_limit' => 400,
174
175                 // hsts (Boolean)
176                 // Enables the sending of HTTP Strict Transport Security headers.
177                 'hsts' => false,
178
179                 // ignore_cache (Boolean)
180                 // For development only. Disables the item cache.
181                 'ignore_cache' => false,
182
183                 // instances_social_key (String)
184                 // Key to the API of https://instances.social which retrieves data about mastodon servers.
185                 // See https://instances.social/api/token to get an API key.
186                 'instances_social_key' => '',
187
188                 // ipv4_resolve (Boolean)
189                 // Resolve IPV4 addresses only. Don't resolve to IPV6.
190                 'ipv4_resolve' => false,
191
192                 // invitation_only (Boolean)
193                 // If set true registration is only possible after a current member of the node has send an invitation.
194                 'invitation_only' => false,
195
196                 // like_no_comment (Boolean)
197                 // Don't update the "commented" value of an item when it is liked.
198                 'like_no_comment' => false,
199
200                 // local_block (Boolean)
201                 // Used in conjunction with "block_public".
202                 'local_block' => false,
203
204                 // local_search (Boolean)
205                 // Blocks search for users who are not logged in to prevent crawlers from blocking your system.
206                 'local_search' => false,
207
208                 // local_tags (Boolean)
209                 // If activated, all hashtags will point to the local server.
210                 'local_tags' => false,
211
212                 // logger_adapter (String)
213                 // Sets the logging adapter of Friendica globally (monolog, syslog)
214                 'logger_adapter' => 'monolog',
215
216                 // max_batch_queue (Integer)
217                 // Maximum number of batched queue items for a single contact before subsequent messages are discarded.
218                 'max_batch_queue' => 1000,
219
220                 // max_connections (Integer)
221                 // The maximum number of database connections which can be in use before the worker process is deferred to its next interval.
222                 // When the system can't detect the maximum numbers of connection then this value can be used. Use 0 for auto-detection.
223                 'max_connections' => 0,
224
225                 // max_connections_level (Integer 0-100)
226                 // The maximum percentage of connections that are allowed to let the worker start.
227                 'max_connections_level' => 75,
228
229                 // max_contact_queue (Integer)
230                 // Maximum number of queue items for a single contact before subsequent messages are discarded.
231                 'max_contact_queue' => 500,
232
233                 // max_image_length (Integer)
234                 // An alternate way of limiting picture upload sizes.
235                 // Specify the maximum pixel  length that pictures are allowed to be (for non-square pictures, it will apply to the longest side).
236                 // Pictures longer than this length will be resized to be this length (on the longest side, the other side will be scaled appropriately).
237                 // If you don't want to set a maximum length, set to -1.
238                 'max_image_length' => -1,
239
240                 // max_processes_backend (Integer)
241                 // Maximum number of concurrent database processes for background tasks.
242                 'max_processes_backend' => 5,
243
244                 // max_processes_frontend (Integer)
245                 // Maximum number of concurrent database processes for foreground tasks.
246                 'max_processes_frontend' => 20,
247
248                 // maximagesize (Integer)
249                 // Maximum size in bytes of an uploaded photo.
250                 'maximagesize' => 800000,
251
252                 // memcache_host (String)
253                 // Host name of the memcache daemon.
254                 'memcache_host' => '127.0.0.1',
255
256                 // memcache_port (Integer)
257                 // Port number of the memcache daemon.
258                 'memcache_port' => 11211,
259
260                 // memcached_hosts (Array)
261                 // Array of Memcached servers info [host, port(, weight)], see Memcached::addServers.
262                 'memcached_hosts' => [
263                         ['127.0.0.1', '11211'],
264                 ],
265
266                 // min_poll_interval (Integer)
267                 // minimal distance in minutes between two polls for a contact. Reasonable values are between 1 and 59.
268                 'min_poll_interval' => 1,
269
270                 // no_count (Boolean)
271                 // Don't do count calculations (currently only when showing photo albums).
272                 'no_count' => false,
273
274                 // no_oembed (Boolean)
275                 // Don't use OEmbed to fetch more information about a link.
276                 'no_oembed' => false,
277
278                 // no_smilies (Boolean)
279                 // Don't show smilies.
280                 'no_smilies' => false,
281
282                 // no_view_full_size (Boolean)
283                 // Don't add the link "View full size" under a resized image.
284                 'no_view_full_size' => false,
285
286                 // optimize_items (Boolean)
287                 // Triggers an SQL command to optimize the item table before expiring items.
288                 'optimize_items' => false,
289
290                 // paranoia (Boolean)
291                 // Log out users if their IP address changed.
292                 'paranoia' => false,
293
294                 // permit_crawling (Boolean)
295                 // Restricts the search for not logged in users to one search per minute.
296                 'permit_crawling' => false,
297
298                 // pidfile (Path)
299                 // Daemon pid file path. For example: pidfile = /path/to/daemon.pid
300                 'pidfile' => '',
301
302                 // png_quality (Integer)
303                 // Sets the ImageMagick compression level for PNG images. Values ranges from 0 (uncompressed) to 9 (most compressed).
304                 'png_quality' => 8,
305
306                 // profiler (Boolean)
307                 // Enable internal timings to help optimize code. Needed for "rendertime" addon.
308                 'profiler' => false,
309
310                 // proxy_cache_time (Integer)
311                 // Period in seconds after which the cache is cleared.
312                 'proxy_cache_time' => 86400,
313
314                 // pushpoll_frequency (Integer)
315                 // Frequency of contact poll for subhub contact using the DFRM or OStatus network.
316                 // Available values:
317                 // - 5 = every month
318                 // - 4 = every week
319                 // - 3 = every day
320                 // - 2 = twice a day
321                 // - 1 = every hour
322                 // - 0 = every minute
323                 'pushpoll_frequency' => 3,
324
325                 // queue_no_dead_check (Boolean)
326                 // Ignore if the target contact or server seems to be dead during queue delivery.
327                 'queue_no_dead_check' => false,
328
329                 // redis_host (String)
330                 // Host name of the redis daemon.
331                 'redis_host' => '127.0.0.1',
332
333                 // redis_port (String)
334                 // Port number of the redis daemon.
335                 'redis_port' => 6379,
336
337                 // session_handler (database|cache|native)
338                 // Whether to use Cache to store session data or to use PHP native session storage.
339                 'session_handler' => 'database',
340
341                 // remove_multiplicated_lines (Boolean)
342                 // If enabled, multiple linefeeds in items are stripped to a single one.
343                 'remove_multiplicated_lines' => false,
344
345                 // sendmail_params (Boolean)
346                 // Normal sendmail command parameters will be added when the PHP mail() function is called for sending e-mails.
347                 // This ensures the Sender Email address setting is applied to the message envelope rather than the host's default address.
348                 // Set to false if your non-sendmail agent is incompatible, or to restore old behavior of using the host address.
349                 'sendmail_params' => true,
350
351                 // show_global_community_hint (Boolean)
352                 // 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.
353                 'show_global_community_hint' => false,
354
355                 // show_unsupported_addons (Boolean)
356                 // Show all addons including the unsupported ones.
357                 'show_unsupported_addons' => false,
358
359                 // show_unsupported_themes (Boolean)
360                 // Show all themes including the unsupported ones.
361                 'show_unsupported_themes' => false,
362
363                 // throttle_limit_day (Integer)
364                 // Maximum number of posts that a user can send per day with the API. 0 to disable daily throttling.
365                 'throttle_limit_day' => 0,
366
367                 // throttle_limit_week (Integer)
368                 // Maximum number of posts that a user can send per week with the API. 0 to disable weekly throttling.
369                 'throttle_limit_week' => 0,
370
371                 // throttle_limit_month (Integer)
372                 // Maximum number of posts that a user can send per month with the API. 0 to disable monthly throttling.
373                 'throttle_limit_month' => 0,
374
375                 // urlpath (String)
376                 // If you are using a subdirectory of your domain you will need to put the relative path (from the root of your domain) here.
377                 // For instance if your URL is 'http://example.com/directory/subdirectory', set urlpath to 'directory/subdirectory'.
378                 'urlpath' => '',
379
380                 // username_min_length (Integer)
381                 // The minimum character length a username can be.
382                 // This length is check once the username has been trimmed and multiple spaces have been collapsed into one.
383                 // Minimum for this config value is 1. Maximum is 64 as the resulting profile URL mustn't be longer than 255 chars.
384                 'username_min_length' => 3,
385
386                 // username_max_length (Integer)
387                 // The maximum character length a username can be.
388                 // This length is check once the username has been trimmed and multiple spaces have been collapsed into one.
389                 // Minimum for this config value is 1. Maximum is 64 as the resulting profile URL mustn't be longer than 255 chars.
390                 'username_max_length' => 48,
391
392                 // worker_cooldown (Integer)
393                 // Cooldown period in seconds after each worker function call.
394                 'worker_cooldown' => 0,
395
396                 // worker_debug (Boolean)
397                 // If enabled, it prints out the number of running processes split by priority.
398                 'worker_debug' => false,
399
400                 // worker_fetch_limit (Integer)
401                 // Number of worker tasks that are fetched in a single query.
402                 'worker_fetch_limit' => 1,
403
404                 // worker_jpm (Boolean)
405                 // If enabled, it prints out the jobs per minute.
406                 'worker_jpm' => false,
407
408                 // worker_jpm_range (String)
409                 // List of minutes for the jobs per minute (JPM) calculation
410                 'worker_jpm_range' => '1, 10, 60',
411
412                 // worker_load_exponent (Integer)
413                 // Default 3, which allows only 25% of the maximum worker queues when server load reaches around 37% of maximum load.
414                 // For a linear response where 25% of worker queues are allowed at 75% of maximum load, set this to 1.
415                 // Setting 0 would allow maximum worker queues at all times, which is not recommended.
416                 'worker_load_exponent' => 3,
417
418                 // xrd_timeout (Integer)
419                 // Timeout in seconds for fetching the XRD links.
420                 'xrd_timeout' => 20,
421         ],
422         'experimental' => [
423                 // exp_themes (Boolean)
424                 // Show experimental themes in user settings.
425                 'exp_themes' => false,
426         ],
427         'theme' => [
428                 // hide_eventlist (Boolean)
429                 // Don't show the birthdays and events on the profile and network page.
430                 'hide_eventlist' => false,
431         ],
432         'jabber' => [
433                 // debug (Boolean)
434                 // Enable debug level for the jabber account synchronisation.
435                 'debug' => false,
436                 // lockpath (Path)
437                 // Must be writable by the ejabberd process. if set then it will prevent the running of multiple processes.
438                 'lockpath' => '',
439         ],
440         'debug' => [
441                 // ap_inbox_log (Boolean)
442                 // Logs every call to /inbox as a JSON file in Friendica's temporary directory
443                 'ap_inbox_log' => false,
444
445                 // total_ap_delivery (Boolean)
446                 // Deliver via AP to every possible receiver and we suppress the delivery to these contacts with other protocols
447                 'total_ap_delivery' => false,
448         ]
449 ];