lib/default.php

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