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