]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - CONFIGURE
Stricted typing + protected on FilteringNoticeStream->filter
[quix0rs-gnu-social.git] / CONFIGURE
1 Configuration options
2 =====================
3
4 The main configuration file for StatusNet (excepting configurations for
5 dependency software) is config.php in your StatusNet directory. If you
6 edit any other file in the directory, like lib/default.php (where most
7 of the defaults are defined), you will lose your configuration options
8 in any upgrade, and you will wish that you had been more careful.
9
10 Starting with version 0.9.0, a Web based configuration panel has been
11 added to StatusNet. The preferred method for changing config options is
12 to use this panel.
13
14 A command-line script, setconfig.php, can be used to set individual
15 configuration options. It's in the scripts/ directory.
16
17 Starting with version 0.7.1, you can put config files in the
18 /etc/statusnet/ directory on your server, if it exists. Config files
19 will be included in this order:
20
21 * /etc/statusnet/statusnet.php - server-wide config
22 * /etc/statusnet/<servername>.php - for a virtual host
23 * /etc/statusnet/<servername>_<pathname>.php - for a path
24 * INSTALLDIR/config.php - for a particular implementation
25
26 Almost all configuration options are made through a two-dimensional
27 associative array, cleverly named $config. A typical configuration
28 line will be:
29
30     $config['section']['option'] = value;
31
32 For brevity, the following documentation describes each section and
33 option.
34
35 site
36 ----
37
38 This section is a catch-all for site-wide variables.
39
40 name: the name of your site, like 'YourCompany Microblog'.
41 server: the server part of your site's URLs, like 'example.net'.
42 path: The path part of your site's URLs, like 'statusnet' or ''
43     (installed in root).
44 fancy: whether or not your site uses fancy URLs (see Fancy URLs
45     section above). Default is false.
46 logfile: full path to a file for StatusNet to save logging
47     information to. You may want to use this if you don't have
48     access to syslog.
49 logdebug: whether to log additional debug info like backtraces on
50     hard errors. Default false.
51 locale_path: full path to the directory for locale data. Unless you
52     store all your locale data in one place, you probably
53     don't need to use this.
54 language: default language for your site. Defaults to US English.
55     Note that this is overridden if a user is logged in and has
56     selected a different language. It is also overridden if the
57     user is NOT logged in, but their browser requests a different
58     langauge. Since pretty much everybody's browser requests a
59     language, that means that changing this setting has little or
60     no effect in practice.
61 languages: A list of languages supported on your site. Typically you'd
62     only change this if you wanted to disable support for one
63     or another language:
64     "unset($config['site']['languages']['de'])" will disable
65     support for German.
66 theme: Theme for your site (see Theme section). Two themes are
67     provided by default: 'default' and 'stoica' (the one used by
68     Identi.ca). It's appreciated if you don't use the 'stoica' theme
69     except as the basis for your own.
70 email: contact email address for your site. By default, it's extracted
71     from your Web server environment; you may want to customize it.
72 broughtbyurl: name of an organization or individual who provides the
73     service. Each page will include a link to this name in the
74     footer. A good way to link to the blog, forum, wiki,
75     corporate portal, or whoever is making the service available.
76 broughtby: text used for the "brought by" link.
77 timezone: default timezone for message display. Users can set their
78     own time zone. Defaults to 'UTC', which is a pretty good default.
79 closed: If set to 'true', will disallow registration on your site.
80     This is a cheap way to restrict accounts to only one
81     individual or group; just register the accounts you want on
82     the service, *then* set this variable to 'true'.
83 inviteonly: If set to 'true', will only allow registration if the user
84     was invited by an existing user.
85 private: If set to 'true', anonymous users will be redirected to the
86     'login' page. Also, API methods that normally require no
87     authentication will require it. Note that this does not turn
88     off registration; use 'closed' or 'inviteonly' for the
89     behaviour you want.
90 notice: A plain string that will appear on every page. A good place
91     to put introductory information about your service, or info about
92     upgrades and outages, or other community info. Any HTML will
93     be escaped.
94 logo: URL of an image file to use as the logo for the site. Overrides
95     the logo in the theme, if any.
96 ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
97     theme logo is used instead.
98 ssl: Whether to use SSL and https:// URLs for some or all pages.
99     Possible values are 'always' (use it for all pages), 'never'
100     (don't use it for any pages), or 'sometimes' (use it for
101     sensitive pages that include passwords like login and registration,
102     but not for regular pages). Default to 'never'.
103 sslproxy: Whether to force GNUsocial to think it is HTTPS when the
104     server gives no such information. I.e. when you're using a reverse
105     proxy that adds the encryption layer but the webserver that runs PHP
106     isn't configured with a key and certificate.
107 sslserver: use an alternate server name for SSL URLs, like
108     'secure.example.org'. You should be careful to set cookie
109     parameters correctly so that both the SSL server and the
110     "normal" server can access the session cookie and
111     preferably other cookies as well.
112 shorturllength: ignored. See 'url' section below.
113 dupelimit: minimum time allowed for one person to say the same thing
114     twice. Default 60s. Anything lower is considered a user
115     or UI error.
116 textlimit: default max size for texts in the site. Defaults to 0 (no limit).
117     Can be fine-tuned for notices, messages, profile bios and group descriptions.
118
119 db
120 --
121
122 This section is a reference to the configuration options for
123 DB_DataObject (see
124 <http://pear.php.net/manual/en/package.database.db-dataobject.intro-configuration.php>).
125 The ones that you may want to set are listed below for clarity.
126
127 database: a DSN (Data Source Name) for your StatusNet database. This is
128     in the format 'protocol://username:password@hostname/databasename',
129     where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
130     really know what you're doing), 'username' is the username,
131     'password' is the password, and etc.
132 ini_yourdbname: if your database is not named 'statusnet', you'll need
133     to set this to point to the location of the
134     statusnet.ini file. Note that the real name of your database
135     should go in there, not literally 'yourdbname'.
136 db_driver: You can try changing this to 'MDB2' to use the other driver
137     type for DB_DataObject, but note that it breaks the OpenID
138     libraries, which only support PEAR::DB.
139 debug: On a database error, you may get a message saying to set this
140     value to 5 to see debug messages in the browser. This breaks
141     just about all pages, and will also expose the username and
142     password
143 quote_identifiers: Set this to true if you're using postgresql.
144 type: either 'mysql' or 'postgresql' (used for some bits of
145     database-type-specific SQL in the code). Defaults to mysql.
146 mirror: you can set this to an array of DSNs, like the above
147     'database' value. If it's set, certain read-only actions will
148     use a random value out of this array for the database, rather
149     than the one in 'database' (actually, 'database' is overwritten).
150     You can offload a busy DB server by setting up MySQL replication
151     and adding the slaves to this array. Note that if you want some
152     requests to go to the 'database' (master) server, you'll need
153     to include it in this array, too.
154 utf8: whether to talk to the database in UTF-8 mode. This is the default
155     with new installations, but older sites may want to turn it off
156     until they get their databases fixed up. See "UTF-8 database"
157     above for details.
158 schemacheck: when to let plugins check the database schema to add
159     tables or update them. Values can be 'runtime' (default)
160     or 'script'. 'runtime' can be costly (plugins check the
161     schema on every hit, adding potentially several db
162     queries, some quite long), but not everyone knows how to
163     run a script. If you can, set this to 'script' and run
164     scripts/checkschema.php whenever you install or upgrade a
165     plugin.
166
167 syslog
168 ------
169
170 By default, StatusNet sites log error messages to the syslog facility.
171 (You can override this using the 'logfile' parameter described above).
172
173 appname: The name that StatusNet uses to log messages. By default it's
174     "statusnet", but if you have more than one installation on the
175     server, you may want to change the name for each instance so
176     you can track log messages more easily.
177 priority: level to log at. Currently ignored.
178 facility: what syslog facility to used. Defaults to LOG_USER, only
179     reset if you know what syslog is and have a good reason
180     to change it.
181
182 queue
183 -----
184
185 You can configure the software to queue time-consuming tasks, like
186 sending out SMS email or XMPP messages, for off-line processing. See
187 'Queues and daemons' above for how to set this up.
188
189 enabled: Whether to uses queues. Defaults to false.
190 daemon: Wather to use queuedaemon. Defaults to false, which means
191     you'll use OpportunisticQM plugin.
192 subsystem: Which kind of queueserver to use. Values include "db" for
193     our hacked-together database queuing (no other server
194     required) and "stomp" for a stomp server.
195 stomp_server: "broker URI" for stomp server. Something like
196     "tcp://hostname:61613". More complicated ones are
197     possible; see your stomp server's documentation for
198     details.
199 queue_basename: a root name to use for queues (stomp only). Typically
200     something like '/queue/sitename/' makes sense. If running
201     multiple instances on the same server, make sure that
202     either this setting or $config['site']['nickname'] are
203     unique for each site to keep them separate.
204
205 stomp_username: username for connecting to the stomp server; defaults
206     to null.
207 stomp_password: password for connecting to the stomp server; defaults
208     to null.
209
210 stomp_persistent: keep items across queue server restart, if enabled.
211     Under ActiveMQ, the server configuration determines if and how
212     persistent storage is actually saved.
213
214     If using a message queue server other than ActiveMQ, you may
215     need to disable this if it does not support persistence.
216
217 stomp_transactions: use transactions to aid in error detection.
218     A broken transaction will be seen quickly, allowing a message
219     to be redelivered immediately if a daemon crashes.
220
221     If using a message queue server other than ActiveMQ, you may
222     need to disable this if it does not support transactions.
223
224 stomp_acks: send acknowledgements to aid in flow control.
225     An acknowledgement of successful processing tells the server
226     we're ready for more and can help keep things moving smoothly.
227
228     This should *not* be turned off when running with ActiveMQ, but
229     if using another message queue server that does not support
230     acknowledgements you might need to disable this.
231
232 softlimit: an absolute or relative "soft memory limit"; daemons will
233     restart themselves gracefully when they find they've hit
234     this amount of memory usage. Defaults to 90% of PHP's global
235     memory_limit setting.
236
237 inboxes: delivery of messages to receiver's inboxes can be delayed to
238     queue time for best interactive performance on the sender.
239     This may however be annoyingly slow when using the DB queues,
240     so you can set this to false if it's causing trouble.
241
242 breakout: for stomp, individual queues are by default grouped up for
243     best scalability. If some need to be run by separate daemons,
244     etc they can be manually adjusted here.
245
246         Default will share all queues for all sites within each group.
247         Specify as <group>/<queue> or <group>/<queue>/<site>,
248         using nickname identifier as site.
249
250         'main/distrib' separate "distrib" queue covering all sites
251         'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
252
253 max_retries: for stomp, drop messages after N failed attempts to process.
254     Defaults to 10.
255
256 dead_letter_dir: for stomp, optional directory to dump data on failed
257     queue processing events after discarding them.
258
259 stomp_no_transactions: for stomp, the server does not support transactions,
260     so do not try to user them. This is needed for http://www.morbidq.com/.
261
262 stomp_no_acks: for stomp, the server does not support acknowledgements.
263     so do not try to user them. This is needed for http://www.morbidq.com/.
264
265 license
266 -------
267
268 The default license to use for your users notices. The default is the
269 Creative Commons Attribution 3.0 license, which is probably the right
270 choice for any public site. Note that some other servers will not
271 accept notices if you apply a stricter license than this.
272
273 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
274     (default copyright), or 'private' (for private and confidential
275     information).
276 owner: for 'allrightsreserved' or 'private', an assigned copyright
277     holder (for example, an employer for a private site). If
278     not specified, will be attributed to 'contributors'.
279 url: URL of the license, used for links.
280 title: Title for the license, like 'Creative Commons Attribution 3.0'.
281 image: A button shown on each page for the license.
282
283 mail
284 ----
285
286 This is for configuring out-going email. We use PEAR's Mail module,
287 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
288
289 backend: the backend to use for mail, one of 'mail', 'sendmail', and
290     'smtp'. Defaults to PEAR's default, 'mail'.
291 params: if the mail backend requires any parameters, you can provide
292     them in an associative array.
293
294 nickname
295 --------
296
297 This is for configuring nicknames in the service.
298
299 blacklist: an array of strings for usernames that may not be
300     registered. A default array exists for strings that are
301     used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
302     but you may want to add others if you have other software
303     installed in a subdirectory of StatusNet or if you just
304     don't want certain words used as usernames.
305 featured: an array of nicknames of 'featured' users of the site.
306     Can be useful to draw attention to well-known users, or
307     interesting people, or whatever.
308
309 avatar
310 ------
311
312 For configuring avatar access.
313
314 dir: Directory to look for avatar files and to put them into.
315     Defaults to avatar subdirectory of install directory; if
316     you change it, make sure to change path, too.
317 path: Path to avatars. Defaults to path for avatar subdirectory,
318     but you can change it if you wish. Note that this will
319     be included with the avatar server, too.
320 server: If set, defines another server where avatars are stored in the
321     root directory. Note that the 'avatar' subdir still has to be
322     writeable. You'd typically use this to split HTTP requests on
323     the client to speed up page loading, either with another
324     virtual server or with an NFS or SAMBA share. Clients
325     typically only make 2 connections to a single server at a
326     time <https://www.w3.org/Protocols/rfc2616/rfc2616-sec8.html#sec8.1.4>,
327     so this can parallelize the job. Defaults to null.
328 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
329     to guess based on site-wide SSL settings.
330
331 public
332 ------
333
334 For configuring the public stream.
335
336 localonly: If set to true, only messages posted by users of this
337     service (rather than other services, filtered through OStatus)
338     are shown in the public stream. Default true.
339 blacklist: An array of IDs of users to hide from the public stream.
340     Useful if you have someone making excessive Twitterfeed posts
341     to the site, other kinds of automated posts, testing bots, etc.
342 autosource: Sources of notices that are from automatic posters, and thus
343     should be kept off the public timeline. Default empty.
344
345 theme
346 -----
347
348 server: Like avatars, you can speed up page loading by pointing the
349     theme file lookup to another server (virtual or real).
350     Defaults to NULL, meaning to use the site server.
351 dir: Directory where theme files are stored. Used to determine
352     whether to show parts of a theme file. Defaults to the theme
353     subdirectory of the install directory.
354 path: Path part of theme URLs, before the theme name. Relative to the
355     theme server. It may make sense to change this path when upgrading,
356     (using version numbers as the path) to make sure that all files are
357     reloaded by caching clients or proxies. Defaults to null,
358     which means to use the site path + '/theme'.
359 ssl: Whether to use SSL for theme elements. Default is null, which means
360     guess based on site SSL settings.
361 sslserver: SSL server to use when page is HTTPS-encrypted. If
362     unspecified, site ssl server and so on will be used.
363 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
364
365 javascript
366 ----------
367
368 server: You can speed up page loading by pointing the
369     theme file lookup to another server (virtual or real).
370     Defaults to NULL, meaning to use the site server.
371 path: Path part of Javascript URLs. Defaults to null,
372     which means to use the site path + '/js/'.
373 ssl: Whether to use SSL for JavaScript files. Default is null, which means
374     guess based on site SSL settings.
375 sslserver: SSL server to use when page is HTTPS-encrypted. If
376     unspecified, site ssl server and so on will be used.
377 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
378 bustframes: If true, all web pages will break out of framesets. If false,
379             can comfortably live in a frame or iframe... probably. Default
380             to true.
381
382 xmpp
383 ----
384
385 For configuring the XMPP sub-system.
386
387 enabled: Whether to accept and send messages by XMPP. Default false.
388 server: server part of XMPP ID for update user.
389 port: connection port for clients. Default 5222, which you probably
390     shouldn't need to change.
391 user: username for the client connection. Users will receive messages
392     from 'user'@'server'.
393 resource: a unique identifier for the connection to the server. This
394     is actually used as a prefix for each XMPP component in the system.
395 password: password for the user account.
396 host: some XMPP domains are served by machines with a different
397     hostname. (For example, @gmail.com GTalk users connect to
398     talk.google.com). Set this to the correct hostname if that's the
399     case with your server.
400 encryption: Whether to encrypt the connection between StatusNet and the
401     XMPP server. Defaults to true, but you can get
402     considerably better performance turning it off if you're
403     connecting to a server on the same machine or on a
404     protected network.
405 debug: if turned on, this will make the XMPP library blurt out all of
406     the incoming and outgoing messages as XML stanzas. Use as a
407     last resort, and never turn it on if you don't have queues
408     enabled, since it will spit out sensitive data to the browser.
409 public: an array of JIDs to send _all_ notices to. This is useful for
410     participating in third-party search and archiving services.
411
412 invite
413 ------
414
415 For configuring invites.
416
417 enabled: Whether to allow users to send invites. Default true.
418
419 tag
420 ---
421
422 Miscellaneous tagging stuff.
423
424 dropoff: Decay factor for tag listing, in seconds.
425     Defaults to exponential decay over ten days; you can twiddle
426     with it to try and get better results for your site.
427
428 popular
429 -------
430
431 Settings for the "popular" section of the site.
432
433 dropoff: Decay factor for popularity listing, in seconds.
434     Defaults to exponential decay over ten days; you can twiddle
435     with it to try and get better results for your site.
436
437 daemon
438 ------
439
440 For daemon processes.
441
442 piddir: directory that daemon processes should write their PID file
443     (process ID) to. Defaults to /var/run/, which is where this
444     stuff should usually go on Unix-ish systems.
445 user: If set, the daemons will try to change their effective user ID
446     to this user before running. Probably a good idea, especially if
447     you start the daemons as root. Note: user name, like 'daemon',
448     not 1001.
449 group: If set, the daemons will try to change their effective group ID
450     to this named group. Again, a name, not a numerical ID.
451
452 emailpost
453 ---------
454
455 For post-by-email.
456
457 enabled: Whether to enable post-by-email. Defaults to true. You will
458     also need to set up maildaemon.php.
459
460 sms
461 ---
462
463 For SMS integration.
464
465 enabled: Whether to enable SMS integration. Defaults to true. Queues
466     should also be enabled.
467
468 integration
469 -----------
470
471 A catch-all for integration with other systems.
472
473 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
474
475 inboxes
476 -------
477
478 For notice inboxes.
479
480 enabled: No longer used. If you set this to something other than true,
481     StatusNet will no longer run.
482
483 throttle
484 --------
485
486 For notice-posting throttles.
487
488 enabled: Whether to throttle posting. Defaults to false.
489 count: Each user can make this many posts in 'timespan' seconds. So, if count
490     is 100 and timespan is 3600, then there can be only 100 posts
491     from a user every hour.
492 timespan: see 'count'.
493
494 profile
495 -------
496
497 Profile management.
498
499 biolimit: max character length of bio; 0 means no limit; null means to use
500     the site text limit default.
501 backup: whether users can backup their own profiles. Defaults to true.
502 restore: whether users can restore their profiles from backup files. Defaults
503          to true.
504 delete: whether users can delete their own accounts. Defaults to false.
505 move: whether users can move their accounts to another server. Defaults
506       to true.   
507
508 newuser
509 -------
510
511 Options with new users.
512
513 default: nickname of a user account to automatically subscribe new
514     users to. Typically this would be system account for e.g.
515     service updates or announcements. Users are able to unsub
516     if they want. Default is null; no auto subscribe.
517 welcome: nickname of a user account that sends welcome messages to new
518     users. Can be the same as 'default' account, although on
519     busy servers it may be a good idea to keep that one just for
520     'urgent' messages. Default is null; no message.
521
522 If either of these special user accounts are specified, the users should
523 be created before the configuration is updated.
524
525 attachments
526 -----------
527
528 The software lets users upload files with their notices. You can configure
529 the types of accepted files by mime types and a trio of quota options:
530 per file, per user (total), per user per month.
531
532 We suggest the use of the pecl file_info extension to handle mime type
533 detection.
534
535 supported: an array of mime types you accept to store and distribute,
536     like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
537     setup your server to properly recognize the types you want to
538     support.
539 uploads: false to disable uploading files with notices (true by default).
540
541 For quotas, be sure you've set the upload_max_filesize and post_max_size
542 in php.ini to be large enough to handle your upload. In httpd.conf
543 (if you're using apache), check that the LimitRequestBody directive isn't
544 set too low (it's optional, so it may not be there at all).
545
546 process_links: follow redirects and save all available file information
547     (mimetype, date, size, oembed, etc.). Defaults to true.
548 file_quota: maximum size for a single file upload in bytes. A user can send
549     any amount of notices with attachments as long as each attachment
550     is smaller than file_quota.
551 user_quota: total size in bytes a user can store on this server. Each user
552     can store any number of files as long as their total size does
553     not exceed the user_quota.
554 monthly_quota: total size permitted in the current month. This is the total
555     size in bytes that a user can upload each month.
556 dir: directory accessible to the Web process where uploads should go.
557     Defaults to the 'file' subdirectory of the install directory, which
558     should be writeable by the Web user.
559 server: server name to use when creating URLs for uploaded files.
560     Defaults to null, meaning to use the default Web server. Using
561     a virtual server here can speed up Web performance.
562 path: URL path, relative to the server, to find files. Defaults to
563     main path + '/file/'.
564 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
565     guess based on other SSL settings.
566 sslserver: if specified, this server will be used when creating HTTPS
567     URLs. Otherwise, the site SSL server will be used, with /file/ path.
568 sslpath: if this and the sslserver are specified, this path will be used
569     when creating HTTPS URLs. Otherwise, the attachments|path value
570     will be used.
571 show_thumbs: show thumbnails in notice lists for uploaded images, and photos
572     and videos linked remotely that provide oEmbed info. Defaults to true.
573 show_html: show (filtered) text/html attachments (and oEmbed HTML etc.).
574     Doesn't affect AJAX calls. Defaults to false.
575 filename_base: for new files, choose one: 'upload', 'hash'. Defaults to hash.
576
577 group
578 -----
579
580 Options for group functionality.
581
582 maxaliases: maximum number of aliases a group can have. Default 3. Set
583     to 0 or less to prevent aliases in a group.
584 desclimit: maximum number of characters to allow in group descriptions.
585     null (default) means to use the site-wide text limits. 0
586     means no limit.
587 addtag: Whether to add a tag for the group nickname for every group post 
588         (pre-1.0.x behaviour). Defaults to false.
589
590 search
591 ------
592
593 Some stuff for search.
594
595 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
596     be 'fulltext' or 'like' (default). The former is faster and more efficient
597     but requires the lame old MyISAM engine for MySQL. The latter
598     will work with InnoDB but could be miserably slow on large
599     systems. We'll probably add another type sometime in the future,
600     with our own indexing system (maybe like MediaWiki's).
601
602 sessions
603 --------
604
605 Session handling.
606
607 handle: boolean. Whether we should register our own PHP session-handling
608     code (using the database and cache layers if enabled). Defaults to false.
609     Setting this to true makes some sense on large or multi-server
610     sites, but it probably won't hurt for smaller ones, either.
611 debug: whether to output debugging info for session storage. Can help
612     with weird session bugs, sometimes. Default false.
613
614 ping
615 ----
616
617 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
618 notify third-party servers of updates.
619
620 notify: an array of URLs for ping endpoints. Default is the empty
621     array (no notification).
622
623 notice
624 ------
625
626 Configuration options specific to notices.
627
628 contentlimit: max length of the plain-text content of a notice.
629     Default is null, meaning to use the site-wide text limit.
630     0 means no limit.
631 defaultscope: default scope for notices. If null, the default
632         scope depends on site/private. It's 1 if the site is private,
633         0 otherwise. Set this value to override.
634
635 message
636 -------
637
638 Configuration options specific to messages.
639
640 contentlimit: max length of the plain-text content of a message.
641     Default is null, meaning to use the site-wide text limit.
642     0 means no limit.
643
644 logincommand
645 ------------
646
647 Configuration options for the login command.
648
649 disabled: whether to enable this command. If enabled, users who send
650     the text 'login' to the site through any channel will
651     receive a link to login to the site automatically in return.
652     Possibly useful for users who primarily use an XMPP or SMS
653     interface and can't be bothered to remember their site
654     password. Note that the security implications of this are
655     pretty serious and have not been thoroughly tested. You
656     should enable it only after you've convinced yourself that
657     it is safe. Default is 'false'.
658
659 singleuser
660 ----------
661
662 If an installation has only one user, this can simplify a lot of the
663 interface. It also makes the user's profile the root URL.
664
665 enabled: Whether to run in "single user mode". Default false.
666 nickname: nickname of the single user. If no nickname is specified,
667           the site owner account will be used (if present).
668
669 robotstxt
670 ---------
671
672 We put out a default robots.txt file to guide the processing of
673 Web crawlers. See http://www.robotstxt.org/ for more information
674 on the format of this file.
675
676 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
677     for the robots.txt file. see <https://en.wikipedia.org/wiki/Robots_exclusion_standard#Crawl-delay_directive>
678     for more information. Default is zero, no explicit delay.
679 disallow: Array of (virtual) directories to disallow. Default is 'main',
680     'search', 'message', 'settings', 'admin'. Ignored when site
681     is private, in which case the entire site ('/') is disallowed.
682
683 api
684 ---
685
686 Options for the Twitter-like API.
687
688 realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
689     for details). Some third-party tools like ping.fm want this to be
690     'Identi.ca API', so set it to that if you want to. default = null,
691     meaning 'something based on the site name'.
692
693 nofollow
694 --------
695
696 We optionally put 'rel="nofollow"' on some links in some pages. The
697 following configuration settings let you fine-tune how or when things
698 are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
699 information on what 'nofollow' means.
700
701 subscribers: whether to nofollow links to subscribers on the profile
702     and personal pages. Default is true.
703 members: links to members on the group page. Default true.
704 peopletag: links to people listed in the peopletag page. Default true.
705 external: external links in notices. One of three values: 'sometimes',
706     'always', 'never'. If 'sometimes', then external links are not
707     nofollowed on profile, notice, and favorites page. Default is
708     'sometimes'.
709
710 url
711 ---
712
713 These are some options for fine-tuning how and when the server will 
714 shorten URLs.
715
716 shortener: URL shortening service to use by default. Users can override
717            individually. 'internal' by default.
718 maxurllength: If an URL is strictly longer than this limit, it will be
719            shortened. Note that the URL shortener service may return an
720            URL longer than this limit. Defaults to 100. Users can
721            override. If set to 0, all URLs will be shortened.
722 maxnoticelength: If a notice is strictly longer than this limit, all
723            URLs in the notice will be shortened. Users can override.
724            -1 means the text limit for notices.
725
726 router
727 ------
728
729 We use a router class for mapping URLs to code. This section controls
730 how that router works.
731
732 cache: whether to cache the router in cache layers. Defaults to true,
733     but may be set to false for developers (who might be actively
734     adding pages, so won't want the router cached) or others who see
735     strange behavior. You're unlikely to need this unless developing..
736
737 http
738 ----
739
740 Settings for the HTTP client.
741
742 ssl_cafile: location of the CA file for SSL. If not set, won't verify
743             SSL peers. Default unset.
744 curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
745       have the PHP curl extension installed for this to work.
746 proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
747             do any HTTP proxy stuff. Default unset.
748 proxy_port: Port to use to connect to HTTP proxy host. Default null.
749 proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
750 proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
751 proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
752
753 plugins
754 -------
755
756 default: associative array mapping plugin name to array of arguments. To disable
757          a default plugin, unset its value in this array.
758 locale_path: path for finding plugin locale files. In the plugin's directory
759              by default.
760 server: Server to find static files for a plugin when the page is plain old HTTP.
761         Defaults to site/server (same as pages). Use this to move plugin CSS and
762         JS files to a CDN.
763 sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
764            to site/server (same as pages). Use this to move plugin CSS and JS files
765            to a CDN.
766 path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
767       each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
768       if you're using a CDN.
769 sslpath: Path to use on the SSL server. Same as plugins/path.
770
771 performance
772 -----------
773
774 high: if you need high performance, or if you're seeing bad
775       performance, set this to true. It will turn off some high-intensity code from
776       the site.
777
778 oldschool
779 ---------
780
781 enabled: enable certain old-style user settings options, like stream-only mode,
782          conversation trees, and nicknames in streams. Off by default, and
783          may not be well supported in future versions.
784
785