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