lib/default.php

   1 <?php
   2 /**
   3  * GNU social - a federating social network
   4  *
   5  *
   6  * LICENCE: This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * @category  Config
  20  * @package   GNUsocial
  21  * @author    Evan Prodromou <evan@status.net>
  22  * @copyright 2008-2009, 2019 Free Software Foundation http://fsf.org
  23  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  24  * @link      https://www.gnu.org/software/social/
  25  */
  26
  27 $default =
  28     array('site' =>
  29         array('name' => 'Just another GNU social node',
  30               'nickname' => 'gnusocial',
  31               'wildcard' => null,
  32               'server' => $_server,
  33               'theme' => 'neo-gnu',
  34               'path' => $_path,
  35               'logfile' => null,
  36               'logdebug' => false,
  37               'logo' => null,
  38               'ssllogo' => null,
  39               'logperf' => false, // Enable to dump performance counters to syslog
  40               'logperf_detail' => false, // Enable to dump every counter hit
  41               'fancy' => false,
  42               'locale_path' => INSTALLDIR.'/locale',
  43               'language' => 'en',
  44               'langdetect' => true,
  45               'languages' => get_all_languages(),
  46               'email' =>
  47               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
  48               'fakeaddressrecovery' => true,
  49               'broughtby' => null,
  50               'timezone' => 'UTC',
  51               'broughtbyurl' => null,
  52               'closed' => false,
  53               'inviteonly' => true,
  54               'private' => false,
  55               'ssl' => 'never',
  56               'sslproxy' => false,   // set to true to force GNU social to think it is HTTPS (i.e. using reverse proxy to enable it)
  57               'sslserver' => null,
  58               'dupelimit' => 60, // default for same person saying the same thing
  59               'textlimit' => 1000, // in chars; 0 == no limit
  60               'indent' => true,
  61               'use_x_sendfile' => false,
  62               'notice' => null, // site wide notice text
  63               'build' => 1, // build number, for code-dependent cache
  64               ),
  65         'security' =>
  66         array('hash_algos' => ['sha1', 'sha256', 'sha512'],   // set to null for anything that hash_hmac() can handle (and is in hash_algos())
  67         ),
  68         'db' =>
  69           array('database' => null, // must be set
  70               'schema_location' => INSTALLDIR . '/classes',
  71               'class_location' => INSTALLDIR . '/classes',
  72               'require_prefix' => 'classes/',
  73               'class_prefix' => '',
  74               'mirror' => null,
  75               'utf8' => true,
  76               'db_driver' => 'DB', # XXX: JanRain libs only work with DB
  77               'quote_identifiers' => false,
  78               'type' => 'mysql',
  79               'schemacheck' => 'runtime', // 'runtime' or 'script'
  80               'annotate_queries' => false, // true to add caller comments to queries, eg /* POST Notice::saveNew */
  81               'log_queries' => false, // true to log all DB queries
  82               'log_slow_queries' => 0, // if set, log queries taking over N seconds
  83               'mysql_foreign_keys' => false), // if set, enables experimental foreign key support on MySQL
  84         'fix' =>
  85         array('fancyurls' => true,   // makes sure aliases in WebFinger etc. are not f'd by index.php/ URLs
  86               'legacy_http' => false,   // set this to true if you have upgraded your site from http=>https
  87               ),
  88         'log' => [
  89                 'debugtrace' => false,  // index.php handleError function, whether to include exception backtrace in log
  90             ],
  91         'syslog' =>
  92         array('appname' => 'statusnet', # for syslog
  93               'priority' => 'debug', # XXX: currently ignored
  94               'facility' => LOG_USER),
  95         'queue' =>
  96         array('enabled' => true,
  97               'daemon' => false, # Use queuedaemon. Default to false
  98               'threads' => null,    # an empty value here uses processor count to determine
  99               'subsystem' => 'db', # default to database, or 'stomp'
 100               'stomp_server' => null,
 101               'queue_basename' => '/queue/statusnet/',
 102               'control_channel' => '/topic/statusnet/control', // broadcasts to all queue daemons
 103               'stomp_username' => null,
 104               'stomp_password' => null,
 105               'stomp_persistent' => true, // keep items across queue server restart, if persistence is enabled
 106               'stomp_transactions' => true, // use STOMP transactions to aid in detecting failures (supported by ActiveMQ, but not by all)
 107               'stomp_acks' => true, // send acknowledgements after successful processing (supported by ActiveMQ, but not by all)
 108               'stomp_manual_failover' => true, // if multiple servers are listed, treat them as separate (enqueue on one randomly, listen on all)
 109               'monitor' => null, // URL to monitor ping endpoint (work in progress)
 110               'softlimit' => '90%', // total size or % of memory_limit at which to restart queue threads gracefully
 111               'spawndelay' => 1, // Wait at least N seconds between (re)spawns of child processes to avoid slamming the queue server with subscription startup
 112               'debug_memory' => false, // true to spit memory usage to log
 113               'breakout' => array(), // List queue specifiers to break out when using Stomp queue.
 114                                      // Default will share all queues for all sites within each group.
 115                                      // Specify as <group>/<queue> or <group>/<queue>/<site>,
 116                                      // using nickname identifier as site.
 117                                      //
 118                                      // 'main/distrib' separate "distrib" queue covering all sites
 119                                      // 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
 120               'max_retries' => 10, // drop messages after N failed attempts to process (Stomp)
 121               'dead_letter_dir' => false, // set to directory to save dropped messages into (Stomp)
 122               ),
 123         'license' =>
 124         array('type' => 'cc', # can be 'cc', 'allrightsreserved', 'private'
 125               'owner' => null, # can be name of content owner e.g. for enterprise
 126               'url' => 'https://creativecommons.org/licenses/by/3.0/',
 127               'title' => 'Creative Commons Attribution 3.0',
 128               'image' => $_path . '/theme/licenses/cc_by_3.0_80x15.png'),
 129         'mail' =>
 130         array('backend' => 'mail',
 131               'params' => null,
 132               'domain_check' => true),
 133         'nickname' =>
 134         array('blacklist' => array(),
 135               'featured' => array()),
 136         'profile' =>
 137         array('banned' => array(),
 138               'biolimit' => null,
 139               'changenick' => false,
 140               'allowprivate' => false,  // whether to allow setting stream to private ("only followers can read")
 141               'backup' => false,    // can cause DoS, so should be done via CLI
 142               'restore' => false,
 143               'delete' => false,
 144               'move' => true),
 145         'image' =>
 146         array('jpegquality' => 85),
 147         'avatar' =>
 148         array('server' => null,
 149               'dir' => INSTALLDIR . '/avatar/',
 150               'path' => $_path . '/avatar/',
 151               'ssl' => null,
 152               'maxsize' => 300),
 153         'foaf' =>
 154         array(
 155               'mbox_sha1sum' => false,
 156             ),
 157         'public' =>
 158         array('localonly' => false,
 159               'blacklist' => array(),
 160               'autosource' => array()),
 161         'theme' =>
 162         array('server' => null,
 163               'dir' => null,
 164               'path'=> null,
 165               'ssl' => null),
 166         'usertheme' =>
 167         array('linkcolor' => 'black',
 168               'backgroundcolor' => 'black'),
 169         'theme_upload' =>
 170         array('enabled' => extension_loaded('zip')),
 171         'javascript' =>
 172         array('server' => null,
 173               'path'=> null,
 174               'ssl' => null,
 175               'bustframes' => true),
 176         'local' => // To override path/server for themes in 'local' dir (not currently applied to local plugins)
 177         array('server' => null,
 178               'dir' => null,
 179               'path' => null,
 180               'ssl' => null),
 181         'throttle' =>
 182         array('enabled' => false, // whether to throttle edits; false by default
 183               'count' => 20, // number of allowed messages in timespan
 184               'timespan' => 600), // timespan for throttling
 185         'invite' =>
 186         array('enabled' => true),
 187         'tag' =>
 188         array('dropoff' => 864000.0,   # controls weighting based on age
 189               'cutoff' => 86400 * 90), # only look at notices posted in last 90 days
 190         'popular' =>
 191         array('dropoff' => 864000.0,   # controls weighting based on age
 192               'cutoff' => 86400 * 90), # only look at notices favorited in last 90 days
 193         'daemon' =>
 194         array('piddir' => sys_get_temp_dir(),
 195               'user' => false,
 196               'group' => false),
 197         'emailpost' =>
 198         array('enabled' => false),
 199         'sms' =>
 200         array('enabled' => false),
 201         'twitterimport' =>
 202         array('enabled' => false),
 203         'integration' =>
 204         array('source' => 'StatusNet', # source attribute for Twitter
 205               'taguri' => null), # base for tag URIs
 206         'twitter' =>
 207         array('signin' => true,
 208               'consumer_key' => null,
 209               'consumer_secret' => null),
 210         'cache' =>
 211         array('base' => null),
 212         'ping' =>
 213         array('notify' => array(),
 214               'timeout' => 2),
 215         'inboxes' =>
 216         array('enabled' => true), # ignored after 0.9.x
 217         'newuser' =>
 218         array('default' => null,
 219               'welcome' => null),
 220         'linkify' => array(
 221             // "bare" below means "without schema", like domain.com vs. https://domain.com
 222             'bare_domains' => false,  // convert domain.com to <a href="http://domain.com/" ...>domain.com</a> ?
 223             'bare_ipv4' => false,   // convert IPv4 addresses to hyperlinks?
 224             'bare_ipv6' => false,   // convert IPv6 addresses to hyperlinks?
 225         ),
 226         'attachments' =>
 227         array('server' => null,
 228               'dir' => INSTALLDIR . '/file/',
 229               'path' => $_path . '/file/',
 230               'sslserver' => null,
 231               'sslpath' => null,
 232               'ssl' => null,
 233               'supported' => array(
 234                                 'application/vnd.oasis.opendocument.chart'                  => 'odc',
 235                                 'application/vnd.oasis.opendocument.formula'                => 'odf',
 236                                 'application/vnd.oasis.opendocument.graphics'               => 'odg',
 237                                 'application/vnd.oasis.opendocument.graphics-template'      => 'otg',
 238                                 'application/vnd.oasis.opendocument.image'                  => 'odi',
 239                                 'application/vnd.oasis.opendocument.presentation'           => 'odp',
 240                                 'application/vnd.oasis.opendocument.presentation-template'  => 'otp',
 241                                 'application/vnd.oasis.opendocument.spreadsheet'            => 'ods',
 242                                 'application/vnd.oasis.opendocument.spreadsheet-template'   => 'ots',
 243                                 'application/vnd.oasis.opendocument.text'                   => 'odt',
 244                                 'application/vnd.oasis.opendocument.text-master'            => 'odm',
 245                                 'application/vnd.oasis.opendocument.text-template'          => 'ott',
 246                                 'application/vnd.oasis.opendocument.text-web'               => 'oth',
 247                                 'application/pdf'   => 'pdf',
 248                                 'application/zip'   => 'zip',
 249                                 'application/x-bzip2' => 'bz2',
 250                                 'application/x-go-sgf' => 'sgf',
 251                                 'application/xml'   => 'xml',
 252                                 'application/gpx+xml' => 'gpx',
 253                                 image_type_to_mime_type(IMAGETYPE_PNG)  => image_type_to_extension(IMAGETYPE_PNG),
 254                                 image_type_to_mime_type(IMAGETYPE_JPEG) => image_type_to_extension(IMAGETYPE_JPEG),
 255                                 image_type_to_mime_type(IMAGETYPE_GIF)  => image_type_to_extension(IMAGETYPE_GIF),
 256                                 'image/svg+xml'     => 'svg', // No built-in constant
 257                                 image_type_to_mime_type(IMAGETYPE_ICO)  => image_type_to_extension(IMAGETYPE_ICO),
 258                                 'audio/ogg'         => 'ogg',
 259                                 'audio/mpeg'        => 'mpg',
 260                                 'audio/x-speex'     => 'spx',
 261                                 'application/ogg'   => 'ogx',
 262                                 'text/plain'        => 'txt',
 263                                 'video/mpeg'        => 'mpeg',
 264                                 'video/mp4'         => 'mp4',
 265                                 'video/ogg'         => 'ogv',
 266                                 'video/quicktime'   => 'mov',
 267                                 'video/webm'        => 'webm',
 268                                 ),
 269               'file_quota' => 5000000,
 270               'user_quota' => 50000000,
 271               'monthly_quota' => 15000000,
 272               'uploads' => true,
 273               'show_html' => false,  // show (filtered) text/html attachments (and oEmbed HTML etc.). Doesn't affect AJAX calls.
 274               'show_thumbs' => true, // show thumbnails in notice lists for uploaded images, and photos and videos linked remotely that provide oEmbed info
 275               'process_links' => true, // check linked resources for embeddable photos and videos; this will hit referenced external web sites when processing new messages.
 276               'extblacklist' => [
 277                     'php' => 'phps',    // this turns .php into .phps
 278                     'exe' => false,  // this would deny any uploads to keep the "exe" file extension
 279                 ],
 280               'memory_limit' => '1024M' // PHP's memory limit to use temporarily when handling images
 281               ),
 282         'thumbnail' => [
 283               'dir' => null,    // falls back to File::path('thumb') (equivalent to ['attachments']['dir'] .  '/thumb/')
 284               'path' => null,   // falls back to generating a URL with File::url('thumb/$filename') (equivalent to ['attachments']['path'] . '/thumb/')
 285               'server' => null, // Only used if ['thumbnail']['path'] is NOT empty, and then it falls back to ['site']['server'], schema is decided from GNUsocial::useHTTPS()
 286
 287               'crop' => false,      // overridden to true if thumb height === null
 288               'maxsize' => 1000,     // thumbs with an edge larger than this will not be generated
 289               'width' => 450,
 290               'height' => 600,
 291               'upscale' => false,
 292               'animated' => false, // null="UseFileAsThumbnail", false="can use still frame". true requires ImageMagickPlugin
 293             ],
 294         'application' =>
 295         array('desclimit' => null),
 296         'group' =>
 297         array('maxaliases' => 3,
 298               'desclimit' => null,
 299               'addtag' => true),
 300         'peopletag' =>
 301         array('maxtags' => 100, // maximum number of tags a user can create.
 302               'maxpeople' => 500, // maximum no. of people with the same tag by the same user
 303               'allow_tagging' => array('all' => true), // equivalent to array('local' => true, 'remote' => true)
 304               'desclimit' => null),
 305         'search' =>
 306         array('type' => 'like'),
 307         'sessions' =>
 308         array('handle' => false,   // whether to handle sessions ourselves
 309               'debug' => false,    // debugging output for sessions
 310               'gc_limit' => 1000), // max sessions to expire at a time
 311         'htmlfilter' => [  // remove tags from user/remotely generated HTML if they are === true
 312             'img' => true,
 313             'video' => true,
 314             'audio' => true,
 315         ],
 316         'htmlpurifier' => [ // configurable options for HTMLPurifier
 317             'Cache.DefinitionImpl'  => 'Serializer',
 318             'Cache.SerializerPath'  => implode(DIRECTORY_SEPARATOR, [sys_get_temp_dir(), 'gnusocial']),
 319         ],
 320         'notice' =>
 321         array('contentlimit' => null,
 322               'allowprivate' => false,  // whether to allow users to "check the padlock" to publish notices available for their subscribers.
 323               'defaultscope' => null, // null means 1 if site/private, 0 otherwise
 324               'hidespam' => true), // Whether to hide silenced users from timelines
 325         'message' =>
 326         array('contentlimit' => null),
 327         'location' =>
 328         array('share' => 'user', // whether to share location; 'always', 'user', 'never'
 329               'sharedefault' => false),
 330         'logincommand' =>
 331         array('disabled' => true),
 332         'plugins' =>
 333         array('core' => array(
 334                             'ActivityVerb' => array(),
 335                             'ActivityVerbPost' => array(),
 336                             'ActivityModeration' => array(),
 337                             'AuthCrypt' => array(),
 338                             'Cronish' => array(),
 339                             'Favorite' => array(),
 340                             'HTMLPurifierSchemes' => array(),
 341                             'Share' => array(),
 342                             'LRDD' => array(),
 343                         ),
 344               'default' => array(
 345                             'Activity' => array(),
 346                             'AntiBrute' => array(),
 347                             'Blacklist' => array(),
 348                             'Bookmark' => array(),
 349                             'ClientSideShorten' => array(),
 350                             'DefaultLayout' => array(),
 351                             'Directory' => array(),
 352                             'DirectMessage' => array(),
 353                             'EmailAuthentication' => array(),
 354                             'Event' => array(),
 355                             'Oembed' => array(),
 356                             'OpenID' => array(),
 357                             'OpportunisticQM' => array(),
 358                             'OStatus' => array(),
 359                             'Poll' => array(),
 360                             'SimpleCaptcha' => array(),
 361                             'TagSub' => array(),
 362                             'WebFinger' => array(),
 363                             'Nodeinfo' => array(),
 364                         ),
 365               'locale_path' => false, // Set to a path to use *instead of* each plugin's own locale subdirectories
 366               'server' => null,
 367               'sslserver' => null,
 368               'path' => null,
 369               'sslpath' => null,
 370               ),
 371         'admin' =>
 372         array('panels' => array('site', 'user', 'paths', 'access', 'sessions', 'sitenotice', 'license', 'plugins')),
 373         'singleuser' =>
 374         array('enabled' => false,
 375               'nickname' => null),
 376         'robotstxt' =>
 377         array('crawldelay' => 0,
 378               'disallow' => array('main', 'settings', 'admin', 'search', 'message')
 379               ),
 380         'api' =>
 381         array('realm' => null),
 382         'nofollow' =>
 383         array('subscribers' => true,
 384               'members' => true,
 385               'peopletag' => true,
 386               'external' => 'sometimes'), // Options: 'sometimes', 'never', default = 'sometimes'
 387         'url' =>
 388         array('shortener' => 'internal',
 389               'maxurllength' => 100,
 390               'maxnoticelength' => -1),
 391         'http' => // HTTP client settings when contacting other sites
 392         array('ssl_cafile' => false, // To enable SSL cert validation, point to a CA bundle (eg '/usr/lib/ssl/certs/ca-certificates.crt') (this activates "ssl_verify_peer")
 393               'ssl_verify_host' => true,    // HTTPRequest2 makes sure this is set to CURLOPT_SSL_VERIFYHOST==2 if using curl
 394               'curl' => false, // Use CURL backend for HTTP fetches if available. (If not, PHP's socket streams will be used.)
 395               'connect_timeout' => 5,
 396               'timeout' => intval(ini_get('default_socket_timeout')),   // effectively should be this by default already, but this makes it more explicitly configurable for you users .)
 397               'proxy_host' => null,
 398               'proxy_port' => null,
 399               'proxy_user' => null,
 400               'proxy_password' => null,
 401               'proxy_auth_scheme' => null,
 402               ),
 403         'router' =>
 404         array('cache' => true), // whether to cache the router object. Defaults to true, turn off for devel
 405         'discovery' =>
 406           array('cors' => false), // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 407         'performance' => array('high' => false) // disable some features for higher performance; default false
 408     );