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