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