Merge branch '0.9.x'
[statusnet:mainline.git] / README
1 ------
2 README
3 ------
4
5 StatusNet 0.9.7 "World Leader Pretend"
6 17 March 2011
7
8 This is the README file for StatusNet, the Open Source microblogging
9 platform. It includes installation instructions, descriptions of
10 options you can set, warnings, tips, and general info for
11 administrators. Information on using StatusNet can be found in the
12 "doc" subdirectory or in the "help" section on-line.
13
14 About
15 =====
16
17 StatusNet is a Free and Open Source microblogging platform. It helps
18 people in a community, company or group to exchange short (140
19 characters, by default) messages over the Web. Users can choose which
20 people to "follow" and receive only their friends' or colleagues'
21 status messages. It provides a similar service to sites like Twitter,
22 Google Buzz, or Yammer.
23
24 With a little work, status messages can be sent to mobile phones,
25 instant messenger programs (GTalk/Jabber), and specially-designed
26 desktop clients that support the Twitter API.
27
28 StatusNet supports an open standard called OStatus
29 <http://ostatus.org/> that lets users in different networks follow
30 each other. It enables a distributed social network spread all across
31 the Web.
32
33 StatusNet was originally developed for the Open Software Service,
34 Identi.ca <http://identi.ca/>. It is shared with you in hope that you
35 too make an Open Software Service available to your users. To learn
36 more, please see the Open Software Service Definition 1.1:
37
38     http://www.opendefinition.org/ossd
39
40 StatusNet, Inc. <http://status.net/> also offers this software as a
41 Web service, requiring no installation on your part. See
42 <http://status.net/signup> for details. The software run
43 on status.net is identical to the software available for download, so
44 you can move back and forth between a hosted version or a version
45 installed on your own servers.
46
47 A commercial software subscription is available from StatusNet Inc. It
48 includes 24-hour technical support and developer support. More
49 information at http://status.net/contact or email sales@status.net.
50
51 License
52 =======
53
54 This program is free software: you can redistribute it and/or modify
55 it under the terms of the GNU Affero General Public License as
56 published by the Free Software Foundation, either version 3 of the
57 License, or (at your option) any later version.
58
59 This program is distributed in the hope that it will be useful, but
60 WITHOUT ANY WARRANTY; without even the implied warranty of
61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
62 Affero General Public License for more details.
63
64 You should have received a copy of the GNU Affero General Public
65 License along with this program, in the file "COPYING".  If not, see
66 <http://www.gnu.org/licenses/>.
67
68     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
69     *different requirements* from the "regular" GPL. In particular, if
70     you make modifications to the StatusNet source code on your server,
71     you *MUST MAKE AVAILABLE* the modified version of the source code
72     to your users under the same license. This is a legal requirement
73     of using the software, and if you do not wish to share your
74     modifications, *YOU MAY NOT INSTALL STATUSNET*.
75
76 Documentation in the /doc-src/ directory is available under the
77 Creative Commons Attribution 3.0 Unported license, with attribution to
78 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
79
80 CSS and images in the /theme/ directory are available under the
81 Creative Commons Attribution 3.0 Unported license, with attribution to
82 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
83
84 Our understanding and intention is that if you add your own theme that
85 uses only CSS and images, those files are not subject to the copyleft
86 requirements of the Affero General Public License 3.0. See
87 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
88 legal advice; consult your lawyer.
89
90 Additional library software has been made available in the 'extlib'
91 directory. All of it is Free Software and can be distributed under
92 liberal terms, but those terms may differ in detail from the AGPL's
93 particulars. See each package's license file in the extlib directory
94 for additional terms.
95
96 New this version
97 ================
98
99 This is a security, bug and feature release since version 0.9.6 released on
100 23 October 2010.
101
102 For best compatibility with client software and site federation, and a
103 lot of bug fixes, it is highly recommended that all public sites
104 upgrade to the new version. Upgrades require new database indexes for
105 best performance; see Upgrade below.
106
107 Notable changes this version:
108
109 - GroupPrivateMessage plugin lets users send private messages
110   to a group. (Similar to "private groups" on Yammer.)
111 - Support for Twitter streaming API in Twitter bridge plugin
112 - Support for a new Activity Streams-based API using AtomPub, allowing
113   richer API data. See http://status.net/wiki/AtomPub for details.
114 - Unified Facebook plugin, replacing previous Facebook application
115   and Facebook Connect plugin.
116 - A plugin to send out a daily summary email to network users.
117 - In-line thumbnails of some attachments (video, images) and oEmbed objects.
118 - Local copies of remote profiles to let moderators manage OStatus users.
119 - Upgrade upstream JS, minify everything.
120 - Allow pushing plugin JS, CSS, and static files to a CDN.
121 - Configurable nickname rules.
122 - Better support for bit.ly URL shortener.
123 - InProcessCache plugin for additional caching on top of memcached.
124 - Support for Activity Streams JSON feeds on many streams.
125 - User-initiated backup and restore of account data in Activity Streams
126   format.
127 - Bookmark plugin for making del.icio.us-like social bookmarking sites,
128   including del.icio.us backup file import. Supports OStatus.
129 - SQLProfile plugin to tune SQL queries.
130 - Better sorting on timelines to support restored or imported data.
131 - Hundreds of translations from http://translatewiki.net/
132 - Hundreds of performance tunings, bug fixes, and UI improvements.
133 - Remove deprecated data from Activity Streams Atom output, to the
134   extent possible.
135 - NewMenu plugin for new layout of menu items.
136 - Experimental support for moving an account from one server to
137   another, using new AtomPub API.
138
139 A full changelog is available at http://status.net/wiki/StatusNet_0.9.7.
140
141 Prerequisites
142 =============
143
144 The following software packages are *required* for this software to
145 run correctly.
146
147 - PHP 5.2.3+. It may be possible to run this software on earlier
148   versions of PHP, but many of the functions used are only available
149   in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
150   daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
151   release, but problems with some plugins are possible.
152 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
153   server. It has been primarily tested on 5.x servers, although it may
154   be possible to install on earlier (or later!) versions. The server
155   *must* support the MyISAM storage engine -- the default for most
156   MySQL servers -- *and* the InnoDB storage engine.
157 - A Web server. Preferably, you should have Apache 2.2.x with the
158   mod_rewrite extension installed and enabled.
159
160 Your PHP installation must include the following PHP extensions:
161
162 - Curl. This is for fetching files by HTTP.
163 - XMLWriter. This is for formatting XML and HTML output.
164 - MySQL. For accessing the database.
165 - GD. For scaling down avatar images.
166 - mbstring. For handling Unicode (UTF-8) encoded strings.
167
168 For some functionality, you will also need the following extensions:
169
170 - Memcache. A client for the memcached server, which caches database
171   information in volatile memory. This is important for adequate
172   performance on high-traffic sites. You will also need a memcached
173   server to store the data in.
174 - Mailparse. Efficient parsing of email requires this extension.
175   Submission by email or SMS-over-email uses this extension.
176 - Sphinx Search. A client for the sphinx server, an alternative
177   to MySQL or Postgresql fulltext search. You will also need a
178   Sphinx server to serve the search queries.
179 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
180   if you have OStatus configured.
181 - gettext. For multiple languages. Default on many PHP installs;
182   will be emulated if not present.
183
184 You will almost definitely get 2-3 times better performance from your
185 site if you install a PHP bytecode cache/accelerator. Some well-known
186 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
187 is a proprietary accelerator installed on some hosting sites.
188
189 External libraries
190 ------------------
191
192 A number of external PHP libraries are used to provide basic
193 functionality and optional functionality for your system. For your
194 convenience, they are available in the "extlib" directory of this
195 package, and you do not have to download and install them. However,
196 you may want to keep them up-to-date with the latest upstream version,
197 and the URLs are listed here for your convenience.
198
199 - DB_DataObject http://pear.php.net/package/DB_DataObject
200 - Validate http://pear.php.net/package/Validate
201 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
202   to use the openidenabled.com version since it's more widely
203   implemented, and seems to be better supported.
204   http://openidenabled.com/php-openid/
205 - PEAR DB. Although this is an older data access system (new
206   packages should probably use PHP DBO), the OpenID libraries
207   depend on PEAR DB so we use it here, too. DB_DataObject can
208   also use PEAR MDB2, which may give you better performance
209   but won't work with OpenID.
210   http://pear.php.net/package/DB
211 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
212 - markdown.php from http://michelf.com/projects/php-markdown/
213 - PEAR Mail, for sending out mail notifications
214   http://pear.php.net/package/Mail
215 - PEAR Net_SMTP, if you use the SMTP factory for notifications
216   http://pear.php.net/package/Net_SMTP
217 - PEAR Net_Socket, if you use the SMTP factory for notifications
218   http://pear.php.net/package/Net_Socket
219 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
220   library available for PHP. http://xmpphp.googlecode.com/. Note that
221   as of this writing the version of this library that is available in
222   the extlib directory is *significantly different* from the upstream
223   version (patches have been submitted). Upgrading to the upstream
224   version may render your StatusNet site unable to send or receive XMPP
225   messages.
226 - Facebook library. Used for the Facebook application.
227 - PEAR Validate is used for URL and email validation.
228 - Console_GetOpt for parsing command-line options.
229 - libomb. a library for implementing OpenMicroBlogging 0.1, the
230   predecessor to OStatus.
231 - HTTP_Request2, a library for making HTTP requests.
232 - PEAR Net_URL2 is an HTTP_Request2 dependency.
233
234 A design goal of StatusNet is that the basic Web functionality should
235 work on even the most restrictive commercial hosting services.
236 However, additional functionality, such as receiving messages by
237 Jabber/GTalk, require that you be able to run long-running processes
238 on your account. In addition, posting by email or from SMS require
239 that you be able to install a mail filter in your mail server.
240
241 Installation
242 ============
243
244 Installing the basic StatusNet Web component is relatively easy,
245 especially if you've previously installed PHP/MySQL packages.
246
247 1. Unpack the tarball you downloaded on your Web server. Usually a
248    command like this will work:
249
250        tar zxf statusnet-0.9.7.tar.gz
251
252    ...which will make a statusnet-0.9.7 subdirectory in your current
253    directory. (If you don't have shell access on your Web server, you
254    may have to unpack the tarball on your local computer and FTP the
255    files to the server.)
256
257 2. Move the tarball to a directory of your choosing in your Web root
258    directory. Usually something like this will work:
259
260        mv statusnet-0.9.7 /var/www/statusnet
261
262    This will make your StatusNet instance available in the statusnet path of
263    your server, like "http://example.net/statusnet". "microblog" or
264    "statusnet" might also be good path names. If you know how to
265    configure virtual hosts on your web server, you can try setting up
266    "http://micro.example.net/" or the like.
267
268 3. Make your target directory writeable by the Web server.
269
270        chmod a+w /var/www/statusnet/
271
272    On some systems, this will probably work:
273
274        chgrp www-data /var/www/statusnet/
275        chmod g+w /var/www/statusnet/
276
277    If your Web server runs as another user besides "www-data", try
278    that user's default group instead. As a last resort, you can create
279    a new group like "statusnet" and add the Web server's user to the group.
280
281 4. You should also take this moment to make your avatar, background, and
282    file subdirectories writeable by the Web server. An insecure way to do
283    this is:
284
285        chmod a+w /var/www/statusnet/avatar
286        chmod a+w /var/www/statusnet/background
287        chmod a+w /var/www/statusnet/file
288
289    You can also make the avatar, background, and file directories
290    writeable by the Web server group, as noted above.
291
292 5. Create a database to hold your microblog data. Something like this
293    should work:
294
295        mysqladmin -u "username" --password="password" create statusnet
296
297    Note that StatusNet must have its own database; you can't share the
298    database with another program. You can name it whatever you want,
299    though.
300
301    (If you don't have shell access to your server, you may need to use
302    a tool like PHPAdmin to create a database. Check your hosting
303    service's documentation for how to create a new MySQL database.)
304
305 6. Create a new database account that StatusNet will use to access the
306    database. If you have shell access, this will probably work from the
307    MySQL shell:
308
309        GRANT ALL on statusnet.*
310        TO 'statusnetuser'@'localhost'
311        IDENTIFIED BY 'statusnetpassword';
312
313    You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
314    username and password. You may want to test logging in to MySQL as
315    this new user.
316
317 7. In a browser, navigate to the StatusNet install script; something like:
318
319        http://yourserver.example.com/statusnet/install.php
320
321    Enter the database connection information and your site name. The
322    install program will configure your site and install the initial,
323    almost-empty database.
324
325 8. You should now be able to navigate to your microblog's main directory
326    and see the "Public Timeline", which will be empty. If not, magic
327    has happened! You can now register a new user, post some notices,
328    edit your profile, etc. However, you may want to wait to do that stuff
329    if you think you can set up "fancy URLs" (see below), since some
330    URLs are stored in the database.
331
332 Fancy URLs
333 ----------
334
335 By default, StatusNet will use URLs that include the main PHP program's
336 name in them. For example, a user's home profile might be
337 found at:
338
339     http://example.org/statusnet/index.php/statusnet/fred
340
341 On certain systems that don't support this kind of syntax, they'll
342 look like this:
343
344     http://example.org/statusnet/index.php?p=statusnet/fred
345
346 It's possible to configure the software so it looks like this instead:
347
348     http://example.org/statusnet/fred
349
350 These "fancy URLs" are more readable and memorable for users. To use
351 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
352 mod_rewrite enabled, -OR- know how to configure "url redirection" in
353 your server.
354
355 1. Copy the htaccess.sample file to .htaccess in your StatusNet
356    directory. Note: if you have control of your server's httpd.conf or
357    similar configuration files, it can greatly improve performance to
358    import the .htaccess file into your conf file instead. If you're
359    not sure how to do it, you may save yourself a lot of headache by
360    just leaving the .htaccess file.
361
362 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
363    to your StatusNet installation on your server. Typically this will
364    be the path to your StatusNet directory relative to your Web root.
365
366 3. Add or uncomment or change a line in your config.php file so it says:
367
368        $config['site']['fancy'] = true;
369
370 You should now be able to navigate to a "fancy" URL on your server,
371 like:
372
373     http://example.net/statusnet/main/register
374
375 If you changed your HTTP server configuration, you may need to restart
376 the server first.
377
378 If it doesn't work, double-check that AllowOverride for the StatusNet
379 directory is 'All' in your Apache configuration file. This is usually
380 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
381 /etc/apache2/sites-available/default. See the Apache documentation for
382 .htaccess files for more details:
383
384     http://httpd.apache.org/docs/2.2/howto/htaccess.html
385
386 Also, check that mod_rewrite is installed and enabled:
387
388     http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
389
390 Sphinx
391 ------
392
393 To use a Sphinx server to search users and notices, you'll need to
394 enable the SphinxSearch plugin. Add to your config.php:
395
396     addPlugin('SphinxSearch');
397     $config['sphinx']['server'] = 'searchhost.local';
398
399 You also need to install, compile and enable the sphinx pecl extension for
400 php on the client side, which itself depends on the sphinx development files.
401
402 See plugins/SphinxSearch/README for more details and server setup.
403
404 SMS
405 ---
406
407 StatusNet supports a cheap-and-dirty system for sending update messages
408 to mobile phones and for receiving updates from the mobile. Instead of
409 sending through the SMS network itself, which is costly and requires
410 buy-in from the wireless carriers, it simply piggybacks on the email
411 gateways that many carriers provide to their customers. So, SMS
412 configuration is essentially email configuration.
413
414 Each user sends to a made-up email address, which they keep a secret.
415 Incoming email that is "From" the user's SMS email address, and "To"
416 the users' secret email address on the site's domain, will be
417 converted to a notice and stored in the DB.
418
419 For this to work, there *must* be a domain or sub-domain for which all
420 (or most) incoming email can pass through the incoming mail filter.
421
422 1. Run the SQL script carrier.sql in your StatusNet database. This will
423    usually work:
424
425        mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
426
427    This will populate your database with a list of wireless carriers
428    that support email SMS gateways.
429
430 2. Make sure the maildaemon.php file is executable:
431
432        chmod +x scripts/maildaemon.php
433
434    Note that "daemon" is kind of a misnomer here; the script is more
435    of a filter than a daemon.
436
437 2. Edit /etc/aliases on your mail server and add the following line:
438
439        *: /path/to/statusnet/scripts/maildaemon.php
440
441 3. Run whatever code you need to to update your aliases database. For
442    many mail servers (Postfix, Exim, Sendmail), this should work:
443
444        newaliases
445
446    You may need to restart your mail server for the new database to
447    take effect.
448
449 4. Set the following in your config.php file:
450
451        $config['mail']['domain'] = 'yourdomain.example.net';
452
453 At this point, post-by-email and post-by-SMS-gateway should work. Note
454 that if your mail server is on a different computer from your email
455 server, you'll need to have a full installation of StatusNet, a working
456 config.php, and access to the StatusNet database from the mail server.
457
458 XMPP
459 ----
460
461 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
462 instant-messenger protocol that drives Jabber and GTalk IM. You can
463 distribute messages via XMPP using the system below; however, you
464 need to run the XMPP incoming daemon to allow incoming messages as
465 well.
466
467 1. You may want to strongly consider setting up your own XMPP server.
468    Ejabberd, OpenFire, and JabberD are all Open Source servers.
469    Jabber, Inc. provides a high-performance commercial server.
470
471 2. You must register a Jabber ID (JID) with your new server. It helps
472    to choose a name like "update@example.com" or "notice" or something
473    similar.  Alternately, your "update JID" can be registered on a
474    publicly-available XMPP service, like jabber.org or GTalk.
475
476    StatusNet will not register the JID with your chosen XMPP server;
477    you need to do this manually, with an XMPP client like Gajim,
478    Telepathy, or Pidgin.im.
479
480 3. Configure your site's XMPP variables, as described below in the
481    configuration section.
482
483 On a default installation, your site can broadcast messages using
484 XMPP. Users won't be able to post messages using XMPP unless you've
485 got the XMPP daemon running.  See 'Queues and daemons' below for how
486 to set that up. Also, once you have a sizable number of users, sending
487 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
488 can really slow down your site; it may cause posting to timeout.
489
490 NOTE: stream_select(), a crucial function for network programming, is
491 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
492 work around this bug in StatusNet; current recommendation is to move
493 off of amd64 to another server.
494
495 Public feed
496 -----------
497
498 You can send *all* messages from your microblogging site to a
499 third-party service using XMPP. This can be useful for providing
500 search, indexing, bridging, or other cool services.
501
502 To configure a downstream site to receive your public stream, add
503 their "JID" (Jabber ID) to your config.php as follows:
504
505     $config['xmpp']['public'][] = 'downstream@example.net';
506
507 (Don't miss those square brackets at the end.) Note that your XMPP
508 broadcasting must be configured as mentioned above. Although you can
509 send out messages at "Web time", high-volume sites should strongly
510 consider setting up queues and daemons.
511
512 Queues and daemons
513 ------------------
514
515 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
516 and XMPP messages, can be 'queued' and done by off-line bots instead.
517 For this to work, you must be able to run long-running offline
518 processes, either on your main Web server or on another server you
519 control. (Your other server will still need all the above
520 prerequisites, with the exception of Apache.) Installing on a separate
521 server is probably a good idea for high-volume sites.
522
523 1. You'll need the "CLI" (command-line interface) version of PHP
524    installed on whatever server you use.
525
526 2. If you're using a separate server for queues, install StatusNet
527    somewhere on the server. You don't need to worry about the
528    .htaccess file, but make sure that your config.php file is close
529    to, or identical to, your Web server's version.
530
531 3. In your config.php files (both the Web server and the queues
532    server!), set the following variable:
533
534        $config['queue']['enabled'] = true;
535
536    You may also want to look at the 'daemon' section of this file for
537    more daemon options. Note that if you set the 'user' and/or 'group'
538    options, you'll need to create that user and/or group by hand.
539    They're not created automatically.
540
541 4. On the queues server, run the command scripts/startdaemons.sh.
542
543 This will run the queue handlers:
544
545 * queuedaemon.php - polls for queued items for inbox processing and
546   pushing out to OStatus, SMS, XMPP, etc.
547 * xmppdaemon.php - listens for new XMPP messages from users and stores
548   them as notices in the database; also pulls queued XMPP output from
549   queuedaemon.php to push out to clients.
550
551 These two daemons will automatically restart in most cases of failure
552 including memory leaks (if a memory_limit is set), but may still die
553 or behave oddly if they lose connections to the XMPP or queue servers.
554
555 Additional daemons may be also started by this script for certain
556 plugins, such as the Twitter bridge.
557
558 It may be a good idea to use a daemon-monitoring service, like 'monit',
559 to check their status and keep them running.
560
561 All the daemons write their process IDs (pids) to /var/run/ by
562 default. This can be useful for starting, stopping, and monitoring the
563 daemons.
564
565 Since version 0.8.0, it's now possible to use a STOMP server instead of
566 our kind of hacky home-grown DB-based queue solution. This is strongly
567 recommended for best response time, especially when using XMPP.
568
569 See the "queues" config section below for how to configure to use STOMP.
570 As of this writing, the software has been tested with ActiveMQ 5.3.
571
572 Themes
573 ------
574
575 There are two themes shipped with this version of StatusNet: "identica",
576 which is what the Identi.ca site uses, and "default", which is a good
577 basis for other sites.
578
579 As of right now, your ability to change the theme is site-wide; users
580 can't choose their own theme. Additionally, the only thing you can
581 change in the theme is CSS stylesheets and some image files; you can't
582 change the HTML output, like adding or removing menu items.
583
584 You can choose a theme using the $config['site']['theme'] element in
585 the config.php file. See below for details.
586
587 You can add your own theme by making a sub-directory of the 'theme'
588 subdirectory with the name of your theme. Each theme can have the
589 following files:
590
591 display.css: a CSS2 file for "default" styling for all browsers.
592 ie6.css: a CSS2 file for override styling for fixing up Internet
593     Explorer 6.
594 ie7.css: a CSS2 file for override styling for fixing up Internet
595     Explorer 7.
596 logo.png: a logo image for the site.
597 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
598     users who don't upload their own.
599 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
600 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
601     listing on profile pages.
602
603 You may want to start by copying the files from the default theme to
604 your own directory.
605
606 NOTE: the HTML generated by StatusNet changed *radically* between
607 version 0.6.x and 0.7.x. Older themes will need signification
608 modification to use the new output format.
609
610 Translation
611 -----------
612
613 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
614 Theoretically, you can add your own sub-directory to the locale/
615 subdirectory to add a new language to your system. You'll need to
616 compile the ".po" files into ".mo" files, however.
617
618 Contributions of translation information to StatusNet are very easy:
619 you can use the Web interface at translatewiki.net to add one
620 or a few or lots of new translations -- or even new languages. You can
621 also download more up-to-date .po files there, if you so desire.
622
623 For info on helping with translations, see http://status.net/wiki/Translations
624
625 Backups
626 -------
627
628 There is no built-in system for doing backups in StatusNet. You can make
629 backups of a working StatusNet system by backing up the database and
630 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
631 and to backup the Web directory, try tar.
632
633 Private
634 -------
635
636 The administrator can set the "private" flag for a site so that it's
637 not visible to non-logged-in users. This might be useful for
638 workgroups who want to share a microblogging site for project
639 management, but host it on a public server.
640
641 Total privacy is not guaranteed or ensured. Also, privacy is
642 all-or-nothing for a site; you can't have some accounts or notices
643 private, and others public. The interaction of private sites
644 with OStatus is undefined.
645
646 Access to file attachments can also be restricted to logged-in users only.
647 1. Add a directory outside the web root where your file uploads will be
648    stored. Usually a command like this will work:
649
650        mkdir /var/www/statusnet-files
651
652 2. Make the file uploads directory writeable by the web server. An
653    insecure way to do this is:
654
655        chmod a+x /var/www/statusnet-files
656
657 3. Tell StatusNet to use this directory for file uploads. Add a line
658    like this to your config.php:
659
660        $config['attachments']['dir'] = '/var/www/statusnet-files';
661
662 Upgrading
663 =========
664
665 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
666 incorrectly-stored international characters ("UTF-8"). For new
667 installations, it will now store non-ASCII characters correctly.
668 However, older installations will have the incorrect storage, and will
669 consequently show up "wrong" in browsers. See below for how to deal
670 with this situation.
671
672 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
673 been tracking the "git" version of the software, you will probably
674 want to upgrade and keep your existing data. There is no automated
675 upgrade procedure in StatusNet 0.9.7. Try these step-by-step
676 instructions; read to the end first before trying them.
677
678 0. Download StatusNet and set up all the prerequisites as if you were
679    doing a new install.
680 1. Make backups of both your database and your Web directory. UNDER NO
681    CIRCUMSTANCES should you try to do an upgrade without a known-good
682    backup. You have been warned.
683 2. Shut down Web access to your site, either by turning off your Web
684    server or by redirecting all pages to a "sorry, under maintenance"
685    page.
686 3. Shut down XMPP access to your site, typically by shutting down the
687    xmppdaemon.php process and all other daemons that you're running.
688    If you've got "monit" or "cron" automatically restarting your
689    daemons, make sure to turn that off, too.
690 4. Shut down SMS and email access to your site. The easy way to do
691    this is to comment out the line piping incoming email to your
692    maildaemon.php file, and running something like "newaliases".
693 5. Once all writing processes to your site are turned off, make a
694    final backup of the Web directory and database.
695 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
696 7. Unpack your StatusNet 0.9.7 tarball and move it to "statusnet" or
697    wherever your code used to be.
698 8. Copy the config.php file and the contents of the avatar/, background/,
699    file/, and local/ subdirectories from your old directory to your new
700    directory.
701 9. Copy htaccess.sample to .htaccess in the new directory. Change the
702    RewriteBase to use the correct path.
703 10. Rebuild the database.
704
705     NOTE: this step is destructive and cannot be
706     reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
707     do it without a known-good backup!
708
709     If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a
710     special upgrade script:
711
712         mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
713
714     If you are upgrading from any 0.9.x version like 0.9.6, run this script:
715
716         mysql -u<rootuser> -p<rootpassword> <database> db/096to097.sql
717
718     Despite the name, it should work for any 0.9.x branch.
719
720     Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
721     BACKUP run the rebuilddb.sh script like this:
722
723         ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
724
725     Here, rootuser and rootpassword are the username and password for a
726     user who can drop and create databases as well as tables; typically
727     that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
728     your database and rebuilds it; if there is an error you have no
729     database. Make sure you have a backup.
730     For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
731     which operates slightly differently. Read the documentation in that
732     script before running it.
733 11. Use mysql or psql client to log into your database and make sure that
734     the notice, user, profile, subscription etc. tables are non-empty.
735 12. Turn back on the Web server, and check that things still work.
736 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
737     bots have changed since version 0.5; see above for details.
738
739 If you're upgrading from very old versions, you may want to look at
740 the fixup_* scripts in the scripts directories. These will store some
741 precooked data in the DB. All upgraders should check out the inboxes
742 options below.
743
744 NOTE: the database definition file, laconica.ini, has been renamed to
745 statusnet.ini (since this is the recommended database name). If you
746 have a line in your config.php pointing to the old name, you'll need
747 to update it.
748
749 Notice inboxes
750 --------------
751
752 Notice inboxes are now required. If you don't have inboxes enabled,
753 StatusNet will no longer run.
754
755 UTF-8 Database
756 --------------
757
758 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
759 international characters ("UTF-8"). This fix is not
760 backwards-compatible; installations from before 0.7.4 will show
761 non-ASCII characters of old notices incorrectly. This section explains
762 what to do.
763
764 0. You can disable the new behaviour by setting the 'db''utf8' config
765    option to "false". You should only do this until you're ready to
766    convert your DB to the new format.
767 1. When you're ready to convert, you can run the fixup_utf8.php script
768    in the scripts/ subdirectory. If you've had the "new behaviour"
769    enabled (probably a good idea), you can give the ID of the first
770    "new" notice as a parameter, and only notices before that one will
771    be converted. Notices are converted in reverse chronological order,
772    so the most recent (and visible) ones will be converted first. The
773    script should work whether or not you have the 'db''utf8' config
774    option enabled.
775 2. When you're ready, set $config['db']['utf8'] to true, so that
776    new notices will be stored correctly.
777
778 Configuration options
779 =====================
780
781 The main configuration file for StatusNet (excepting configurations for
782 dependency software) is config.php in your StatusNet directory. If you
783 edit any other file in the directory, like lib/default.php (where most
784 of the defaults are defined), you will lose your configuration options
785 in any upgrade, and you will wish that you had been more careful.
786
787 Starting with version 0.9.0, a Web based configuration panel has been
788 added to StatusNet. The preferred method for changing config options is
789 to use this panel.
790
791 A command-line script, setconfig.php, can be used to set individual
792 configuration options. It's in the scripts/ directory.
793
794 Starting with version 0.7.1, you can put config files in the
795 /etc/statusnet/ directory on your server, if it exists. Config files
796 will be included in this order:
797
798 * /etc/statusnet/statusnet.php - server-wide config
799 * /etc/statusnet/<servername>.php - for a virtual host
800 * /etc/statusnet/<servername>_<pathname>.php - for a path
801 * INSTALLDIR/config.php - for a particular implementation
802
803 Almost all configuration options are made through a two-dimensional
804 associative array, cleverly named $config. A typical configuration
805 line will be:
806
807     $config['section']['option'] = value;
808
809 For brevity, the following documentation describes each section and
810 option.
811
812 site
813 ----
814
815 This section is a catch-all for site-wide variables.
816
817 name: the name of your site, like 'YourCompany Microblog'.
818 server: the server part of your site's URLs, like 'example.net'.
819 path: The path part of your site's URLs, like 'statusnet' or ''
820     (installed in root).
821 fancy: whether or not your site uses fancy URLs (see Fancy URLs
822     section above). Default is false.
823 logfile: full path to a file for StatusNet to save logging
824     information to. You may want to use this if you don't have
825     access to syslog.
826 logdebug: whether to log additional debug info like backtraces on
827     hard errors. Default false.
828 locale_path: full path to the directory for locale data. Unless you
829     store all your locale data in one place, you probably
830     don't need to use this.
831 language: default language for your site. Defaults to US English.
832     Note that this is overridden if a user is logged in and has
833     selected a different language. It is also overridden if the
834     user is NOT logged in, but their browser requests a different
835     langauge. Since pretty much everybody's browser requests a
836     language, that means that changing this setting has little or
837     no effect in practice.
838 languages: A list of languages supported on your site. Typically you'd
839     only change this if you wanted to disable support for one
840     or another language:
841     "unset($config['site']['languages']['de'])" will disable
842     support for German.
843 theme: Theme for your site (see Theme section). Two themes are
844     provided by default: 'default' and 'stoica' (the one used by
845     Identi.ca). It's appreciated if you don't use the 'stoica' theme
846     except as the basis for your own.
847 email: contact email address for your site. By default, it's extracted
848     from your Web server environment; you may want to customize it.
849 broughtbyurl: name of an organization or individual who provides the
850     service. Each page will include a link to this name in the
851     footer. A good way to link to the blog, forum, wiki,
852     corporate portal, or whoever is making the service available.
853 broughtby: text used for the "brought by" link.
854 timezone: default timezone for message display. Users can set their
855     own time zone. Defaults to 'UTC', which is a pretty good default.
856 closed: If set to 'true', will disallow registration on your site.
857     This is a cheap way to restrict accounts to only one
858     individual or group; just register the accounts you want on
859     the service, *then* set this variable to 'true'.
860 inviteonly: If set to 'true', will only allow registration if the user
861     was invited by an existing user.
862 private: If set to 'true', anonymous users will be redirected to the
863     'login' page. Also, API methods that normally require no
864     authentication will require it. Note that this does not turn
865     off registration; use 'closed' or 'inviteonly' for the
866     behaviour you want.
867 notice: A plain string that will appear on every page. A good place
868     to put introductory information about your service, or info about
869     upgrades and outages, or other community info. Any HTML will
870     be escaped.
871 logo: URL of an image file to use as the logo for the site. Overrides
872     the logo in the theme, if any.
873 ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
874     theme logo is used instead.
875 ssl: Whether to use SSL and https:// URLs for some or all pages.
876     Possible values are 'always' (use it for all pages), 'never'
877     (don't use it for any pages), or 'sometimes' (use it for
878     sensitive pages that include passwords like login and registration,
879     but not for regular pages). Default to 'never'.
880 sslserver: use an alternate server name for SSL URLs, like
881     'secure.example.org'. You should be careful to set cookie
882     parameters correctly so that both the SSL server and the
883     "normal" server can access the session cookie and
884     preferably other cookies as well.
885 shorturllength: Length of URL at which URLs in a message exceeding 140
886     characters will be sent to the user's chosen
887     shortening service.
888 dupelimit: minimum time allowed for one person to say the same thing
889     twice. Default 60s. Anything lower is considered a user
890     or UI error.
891 textlimit: default max size for texts in the site. Defaults to 140.
892     0 means no limit. Can be fine-tuned for notices, messages,
893     profile bios and group descriptions.
894
895 db
896 --
897
898 This section is a reference to the configuration options for
899 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
900 set are listed below for clarity.
901
902 database: a DSN (Data Source Name) for your StatusNet database. This is
903     in the format 'protocol://username:password@hostname/databasename',
904     where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
905     really know what you're doing), 'username' is the username,
906     'password' is the password, and etc.
907 ini_yourdbname: if your database is not named 'statusnet', you'll need
908     to set this to point to the location of the
909     statusnet.ini file. Note that the real name of your database
910     should go in there, not literally 'yourdbname'.
911 db_driver: You can try changing this to 'MDB2' to use the other driver
912     type for DB_DataObject, but note that it breaks the OpenID
913     libraries, which only support PEAR::DB.
914 debug: On a database error, you may get a message saying to set this
915     value to 5 to see debug messages in the browser. This breaks
916     just about all pages, and will also expose the username and
917     password
918 quote_identifiers: Set this to true if you're using postgresql.
919 type: either 'mysql' or 'postgresql' (used for some bits of
920     database-type-specific SQL in the code). Defaults to mysql.
921 mirror: you can set this to an array of DSNs, like the above
922     'database' value. If it's set, certain read-only actions will
923     use a random value out of this array for the database, rather
924     than the one in 'database' (actually, 'database' is overwritten).
925     You can offload a busy DB server by setting up MySQL replication
926     and adding the slaves to this array. Note that if you want some
927     requests to go to the 'database' (master) server, you'll need
928     to include it in this array, too.
929 utf8: whether to talk to the database in UTF-8 mode. This is the default
930     with new installations, but older sites may want to turn it off
931     until they get their databases fixed up. See "UTF-8 database"
932     above for details.
933 schemacheck: when to let plugins check the database schema to add
934     tables or update them. Values can be 'runtime' (default)
935     or 'script'. 'runtime' can be costly (plugins check the
936     schema on every hit, adding potentially several db
937     queries, some quite long), but not everyone knows how to
938     run a script. If you can, set this to 'script' and run
939     scripts/checkschema.php whenever you install or upgrade a
940     plugin.
941
942 syslog
943 ------
944
945 By default, StatusNet sites log error messages to the syslog facility.
946 (You can override this using the 'logfile' parameter described above).
947
948 appname: The name that StatusNet uses to log messages. By default it's
949     "statusnet", but if you have more than one installation on the
950     server, you may want to change the name for each instance so
951     you can track log messages more easily.
952 priority: level to log at. Currently ignored.
953 facility: what syslog facility to used. Defaults to LOG_USER, only
954     reset if you know what syslog is and have a good reason
955     to change it.
956
957 queue
958 -----
959
960 You can configure the software to queue time-consuming tasks, like
961 sending out SMS email or XMPP messages, for off-line processing. See
962 'Queues and daemons' above for how to set this up.
963
964 enabled: Whether to uses queues. Defaults to false.
965 subsystem: Which kind of queueserver to use. Values include "db" for
966     our hacked-together database queuing (no other server
967     required) and "stomp" for a stomp server.
968 stomp_server: "broker URI" for stomp server. Something like
969     "tcp://hostname:61613". More complicated ones are
970     possible; see your stomp server's documentation for
971     details.
972 queue_basename: a root name to use for queues (stomp only). Typically
973     something like '/queue/sitename/' makes sense. If running
974     multiple instances on the same server, make sure that
975     either this setting or $config['site']['nickname'] are
976     unique for each site to keep them separate.
977
978 stomp_username: username for connecting to the stomp server; defaults
979     to null.
980 stomp_password: password for connecting to the stomp server; defaults
981     to null.
982
983 stomp_persistent: keep items across queue server restart, if enabled.
984     Under ActiveMQ, the server configuration determines if and how
985     persistent storage is actually saved.
986
987     If using a message queue server other than ActiveMQ, you may
988     need to disable this if it does not support persistence.
989
990 stomp_transactions: use transactions to aid in error detection.
991     A broken transaction will be seen quickly, allowing a message
992     to be redelivered immediately if a daemon crashes.
993
994     If using a message queue server other than ActiveMQ, you may
995     need to disable this if it does not support transactions.
996
997 stomp_acks: send acknowledgements to aid in flow control.
998     An acknowledgement of successful processing tells the server
999     we're ready for more and can help keep things moving smoothly.
1000
1001     This should *not* be turned off when running with ActiveMQ, but
1002     if using another message queue server that does not support
1003     acknowledgements you might need to disable this.
1004
1005 softlimit: an absolute or relative "soft memory limit"; daemons will
1006     restart themselves gracefully when they find they've hit
1007     this amount of memory usage. Defaults to 90% of PHP's global
1008     memory_limit setting.
1009
1010 inboxes: delivery of messages to receiver's inboxes can be delayed to
1011     queue time for best interactive performance on the sender.
1012     This may however be annoyingly slow when using the DB queues,
1013     so you can set this to false if it's causing trouble.
1014
1015 breakout: for stomp, individual queues are by default grouped up for
1016     best scalability. If some need to be run by separate daemons,
1017     etc they can be manually adjusted here.
1018
1019         Default will share all queues for all sites within each group.
1020         Specify as <group>/<queue> or <group>/<queue>/<site>,
1021         using nickname identifier as site.
1022
1023         'main/distrib' separate "distrib" queue covering all sites
1024         'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1025
1026 max_retries: for stomp, drop messages after N failed attempts to process.
1027     Defaults to 10.
1028
1029 dead_letter_dir: for stomp, optional directory to dump data on failed
1030     queue processing events after discarding them.
1031
1032 stomp_no_transactions: for stomp, the server does not support transactions,
1033     so do not try to user them. This is needed for http://www.morbidq.com/.
1034
1035 stomp_no_acks: for stomp, the server does not support acknowledgements.
1036     so do not try to user them. This is needed for http://www.morbidq.com/.
1037
1038 license
1039 -------
1040
1041 The default license to use for your users notices. The default is the
1042 Creative Commons Attribution 3.0 license, which is probably the right
1043 choice for any public site. Note that some other servers will not
1044 accept notices if you apply a stricter license than this.
1045
1046 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1047     (default copyright), or 'private' (for private and confidential
1048     information).
1049 owner: for 'allrightsreserved' or 'private', an assigned copyright
1050     holder (for example, an employer for a private site). If
1051     not specified, will be attributed to 'contributors'.
1052 url: URL of the license, used for links.
1053 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1054 image: A button shown on each page for the license.
1055
1056 mail
1057 ----
1058
1059 This is for configuring out-going email. We use PEAR's Mail module,
1060 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1061
1062 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1063     'smtp'. Defaults to PEAR's default, 'mail'.
1064 params: if the mail backend requires any parameters, you can provide
1065     them in an associative array.
1066
1067 nickname
1068 --------
1069
1070 This is for configuring nicknames in the service.
1071
1072 blacklist: an array of strings for usernames that may not be
1073     registered. A default array exists for strings that are
1074     used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1075     but you may want to add others if you have other software
1076     installed in a subdirectory of StatusNet or if you just
1077     don't want certain words used as usernames.
1078 featured: an array of nicknames of 'featured' users of the site.
1079     Can be useful to draw attention to well-known users, or
1080     interesting people, or whatever.
1081
1082 avatar
1083 ------
1084
1085 For configuring avatar access.
1086
1087 dir: Directory to look for avatar files and to put them into.
1088     Defaults to avatar subdirectory of install directory; if
1089     you change it, make sure to change path, too.
1090 path: Path to avatars. Defaults to path for avatar subdirectory,
1091     but you can change it if you wish. Note that this will
1092     be included with the avatar server, too.
1093 server: If set, defines another server where avatars are stored in the
1094     root directory. Note that the 'avatar' subdir still has to be
1095     writeable. You'd typically use this to split HTTP requests on
1096     the client to speed up page loading, either with another
1097     virtual server or with an NFS or SAMBA share. Clients
1098     typically only make 2 connections to a single server at a
1099     time <http://ur1.ca/6ih>, so this can parallelize the job.
1100     Defaults to null.
1101 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1102     to guess based on site-wide SSL settings.
1103
1104 public
1105 ------
1106
1107 For configuring the public stream.
1108
1109 localonly: If set to true, only messages posted by users of this
1110     service (rather than other services, filtered through OMB)
1111     are shown in the public stream. Default true.
1112 blacklist: An array of IDs of users to hide from the public stream.
1113     Useful if you have someone making excessive Twitterfeed posts
1114     to the site, other kinds of automated posts, testing bots, etc.
1115 autosource: Sources of notices that are from automatic posters, and thus
1116     should be kept off the public timeline. Default empty.
1117
1118 theme
1119 -----
1120
1121 server: Like avatars, you can speed up page loading by pointing the
1122     theme file lookup to another server (virtual or real).
1123     Defaults to NULL, meaning to use the site server.
1124 dir: Directory where theme files are stored. Used to determine
1125     whether to show parts of a theme file. Defaults to the theme
1126     subdirectory of the install directory.
1127 path: Path part of theme URLs, before the theme name. Relative to the
1128     theme server. It may make sense to change this path when upgrading,
1129     (using version numbers as the path) to make sure that all files are
1130     reloaded by caching clients or proxies. Defaults to null,
1131     which means to use the site path + '/theme'.
1132 ssl: Whether to use SSL for theme elements. Default is null, which means
1133     guess based on site SSL settings.
1134 sslserver: SSL server to use when page is HTTPS-encrypted. If
1135     unspecified, site ssl server and so on will be used.
1136 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1137
1138 javascript
1139 ----------
1140
1141 server: You can speed up page loading by pointing the
1142     theme file lookup to another server (virtual or real).
1143     Defaults to NULL, meaning to use the site server.
1144 path: Path part of Javascript URLs. Defaults to null,
1145     which means to use the site path + '/js/'.
1146 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1147     guess based on site SSL settings.
1148 sslserver: SSL server to use when page is HTTPS-encrypted. If
1149     unspecified, site ssl server and so on will be used.
1150 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1151 bustframes: If true, all web pages will break out of framesets. If false,
1152             can comfortably live in a frame or iframe... probably. Default
1153             to true.
1154
1155 xmpp
1156 ----
1157
1158 For configuring the XMPP sub-system.
1159
1160 enabled: Whether to accept and send messages by XMPP. Default false.
1161 server: server part of XMPP ID for update user.
1162 port: connection port for clients. Default 5222, which you probably
1163     shouldn't need to change.
1164 user: username for the client connection. Users will receive messages
1165     from 'user'@'server'.
1166 resource: a unique identifier for the connection to the server. This
1167     is actually used as a prefix for each XMPP component in the system.
1168 password: password for the user account.
1169 host: some XMPP domains are served by machines with a different
1170     hostname. (For example, @gmail.com GTalk users connect to
1171     talk.google.com). Set this to the correct hostname if that's the
1172     case with your server.
1173 encryption: Whether to encrypt the connection between StatusNet and the
1174     XMPP server. Defaults to true, but you can get
1175     considerably better performance turning it off if you're
1176     connecting to a server on the same machine or on a
1177     protected network.
1178 debug: if turned on, this will make the XMPP library blurt out all of
1179     the incoming and outgoing messages as XML stanzas. Use as a
1180     last resort, and never turn it on if you don't have queues
1181     enabled, since it will spit out sensitive data to the browser.
1182 public: an array of JIDs to send _all_ notices to. This is useful for
1183     participating in third-party search and archiving services.
1184
1185 invite
1186 ------
1187
1188 For configuring invites.
1189
1190 enabled: Whether to allow users to send invites. Default true.
1191
1192 tag
1193 ---
1194
1195 Miscellaneous tagging stuff.
1196
1197 dropoff: Decay factor for tag listing, in seconds.
1198     Defaults to exponential decay over ten days; you can twiddle
1199     with it to try and get better results for your site.
1200
1201 popular
1202 -------
1203
1204 Settings for the "popular" section of the site.
1205
1206 dropoff: Decay factor for popularity listing, in seconds.
1207     Defaults to exponential decay over ten days; you can twiddle
1208     with it to try and get better results for your site.
1209
1210 daemon
1211 ------
1212
1213 For daemon processes.
1214
1215 piddir: directory that daemon processes should write their PID file
1216     (process ID) to. Defaults to /var/run/, which is where this
1217     stuff should usually go on Unix-ish systems.
1218 user: If set, the daemons will try to change their effective user ID
1219     to this user before running. Probably a good idea, especially if
1220     you start the daemons as root. Note: user name, like 'daemon',
1221     not 1001.
1222 group: If set, the daemons will try to change their effective group ID
1223     to this named group. Again, a name, not a numerical ID.
1224
1225 memcached
1226 ---------
1227
1228 You can get a significant boost in performance by caching some
1229 database data in memcached <http://www.danga.com/memcached/>.
1230
1231 enabled: Set to true to enable. Default false.
1232 server: a string with the hostname of the memcached server. Can also
1233     be an array of hostnames, if you've got more than one server.
1234 base: memcached uses key-value pairs to store data. We build long,
1235     funny-looking keys to make sure we don't have any conflicts. The
1236     base of the key is usually a simplified version of the site name
1237     (like "Identi.ca" => "identica"), but you can overwrite this if
1238     you need to. You can safely ignore it if you only have one
1239     StatusNet site using your memcached server.
1240 port: Port to connect to; defaults to 11211.
1241
1242 emailpost
1243 ---------
1244
1245 For post-by-email.
1246
1247 enabled: Whether to enable post-by-email. Defaults to true. You will
1248     also need to set up maildaemon.php.
1249
1250 sms
1251 ---
1252
1253 For SMS integration.
1254
1255 enabled: Whether to enable SMS integration. Defaults to true. Queues
1256     should also be enabled.
1257
1258 integration
1259 -----------
1260
1261 A catch-all for integration with other systems.
1262
1263 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1264
1265 inboxes
1266 -------
1267
1268 For notice inboxes.
1269
1270 enabled: No longer used. If you set this to something other than true,
1271     StatusNet will no longer run.
1272
1273 throttle
1274 --------
1275
1276 For notice-posting throttles.
1277
1278 enabled: Whether to throttle posting. Defaults to false.
1279 count: Each user can make this many posts in 'timespan' seconds. So, if count
1280     is 100 and timespan is 3600, then there can be only 100 posts
1281     from a user every hour.
1282 timespan: see 'count'.
1283
1284 profile
1285 -------
1286
1287 Profile management.
1288
1289 biolimit: max character length of bio; 0 means no limit; null means to use
1290     the site text limit default.
1291 backup: whether users can backup their own profiles. Defaults to true.
1292 restore: whether users can restore their profiles from backup files. Defaults
1293          to true.
1294 delete: whether users can delete their own accounts. Defaults to false.
1295 move: whether users can move their accounts to another server. Defaults
1296       to true.   
1297
1298 newuser
1299 -------
1300
1301 Options with new users.
1302
1303 default: nickname of a user account to automatically subscribe new
1304     users to. Typically this would be system account for e.g.
1305     service updates or announcements. Users are able to unsub
1306     if they want. Default is null; no auto subscribe.
1307 welcome: nickname of a user account that sends welcome messages to new
1308     users. Can be the same as 'default' account, although on
1309     busy servers it may be a good idea to keep that one just for
1310     'urgent' messages. Default is null; no message.
1311
1312 If either of these special user accounts are specified, the users should
1313 be created before the configuration is updated.
1314
1315 snapshot
1316 --------
1317
1318 The software will, by default, send statistical snapshots about the
1319 local installation to a stats server on the status.net Web site. This
1320 data is used by the developers to prioritize development decisions. No
1321 identifying data about users or organizations is collected. The data
1322 is available to the public for review. Participating in this survey
1323 helps StatusNet developers take your needs into account when updating
1324 the software.
1325
1326 run: string indicating when to run the statistics. Values can be 'web'
1327     (run occasionally at Web time), 'cron' (run from a cron script),
1328     or 'never' (don't ever run). If you set it to 'cron', remember to
1329     schedule the script to run on a regular basis.
1330 frequency: if run value is 'web', how often to report statistics.
1331     Measured in Web hits; depends on how active your site is.
1332     Default is 10000 -- that is, one report every 10000 Web hits,
1333     on average.
1334 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1335     report system, but if they go evil or disappear you may
1336     need to update this to another value. Note: if you
1337     don't want to report stats, it's much better to
1338     set 'run' to 'never' than to set this value to something
1339     nonsensical.
1340
1341 attachments
1342 -----------
1343
1344 The software lets users upload files with their notices. You can configure
1345 the types of accepted files by mime types and a trio of quota options:
1346 per file, per user (total), per user per month.
1347
1348 We suggest the use of the pecl file_info extension to handle mime type
1349 detection.
1350
1351 supported: an array of mime types you accept to store and distribute,
1352     like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1353     setup your server to properly recognize the types you want to
1354     support.
1355 uploads: false to disable uploading files with notices (true by default).
1356 filecommand: The required MIME_Type library may need to use the 'file'
1357     command. It tries the one in the Web server's path, but if
1358     you're having problems with uploads, try setting this to the
1359     correct value. Note: 'file' must accept '-b' and '-i' options.
1360
1361 For quotas, be sure you've set the upload_max_filesize and post_max_size
1362 in php.ini to be large enough to handle your upload. In httpd.conf
1363 (if you're using apache), check that the LimitRequestBody directive isn't
1364 set too low (it's optional, so it may not be there at all).
1365
1366 file_quota: maximum size for a single file upload in bytes. A user can send
1367     any amount of notices with attachments as long as each attachment
1368     is smaller than file_quota.
1369 user_quota: total size in bytes a user can store on this server. Each user
1370     can store any number of files as long as their total size does
1371     not exceed the user_quota.
1372 monthly_quota: total size permitted in the current month. This is the total
1373     size in bytes that a user can upload each month.
1374 dir: directory accessible to the Web process where uploads should go.
1375     Defaults to the 'file' subdirectory of the install directory, which
1376     should be writeable by the Web user.
1377 server: server name to use when creating URLs for uploaded files.
1378     Defaults to null, meaning to use the default Web server. Using
1379     a virtual server here can speed up Web performance.
1380 path: URL path, relative to the server, to find files. Defaults to
1381     main path + '/file/'.
1382 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1383     guess based on other SSL settings.
1384 filecommand: command to use for determining the type of a file. May be
1385     skipped if fileinfo extension is installed. Defaults to
1386     '/usr/bin/file'.
1387 sslserver: if specified, this server will be used when creating HTTPS
1388     URLs. Otherwise, the site SSL server will be used, with /file/ path.
1389 sslpath: if this and the sslserver are specified, this path will be used
1390     when creating HTTPS URLs. Otherwise, the attachments|path value
1391     will be used.
1392
1393 group
1394 -----
1395
1396 Options for group functionality.
1397
1398 maxaliases: maximum number of aliases a group can have. Default 3. Set
1399     to 0 or less to prevent aliases in a group.
1400 desclimit: maximum number of characters to allow in group descriptions.
1401     null (default) means to use the site-wide text limits. 0
1402     means no limit.
1403
1404 oohembed
1405 --------
1406
1407 oEmbed endpoint for multimedia attachments (links in posts).
1408
1409 endpoint: oohembed endpoint using http://oohembed.com/ software.
1410
1411 search
1412 ------
1413
1414 Some stuff for search.
1415
1416 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1417     be 'fulltext' (default) or 'like'. The former is faster and more efficient
1418     but requires the lame old MyISAM engine for MySQL. The latter
1419     will work with InnoDB but could be miserably slow on large
1420     systems. We'll probably add another type sometime in the future,
1421     with our own indexing system (maybe like MediaWiki's).
1422
1423 sessions
1424 --------
1425
1426 Session handling.
1427
1428 handle: boolean. Whether we should register our own PHP session-handling
1429     code (using the database and memcache if enabled). Defaults to false.
1430     Setting this to true makes some sense on large or multi-server
1431     sites, but it probably won't hurt for smaller ones, either.
1432 debug: whether to output debugging info for session storage. Can help
1433     with weird session bugs, sometimes. Default false.
1434
1435 background
1436 ----------
1437
1438 Users can upload backgrounds for their pages; this section defines
1439 their use.
1440
1441 server: the server to use for background. Using a separate (even
1442     virtual) server for this can speed up load times. Default is
1443     null; same as site server.
1444 dir: directory to write backgrounds too. Default is '/background/'
1445     subdir of install dir.
1446 path: path to backgrounds. Default is sub-path of install path; note
1447     that you may need to change this if you change site-path too.
1448 sslserver: SSL server to use when page is HTTPS-encrypted. If
1449     unspecified, site ssl server and so on will be used.
1450 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1451
1452 ping
1453 ----
1454
1455 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1456 notify third-party servers of updates.
1457
1458 notify: an array of URLs for ping endpoints. Default is the empty
1459     array (no notification).
1460
1461 design
1462 ------
1463
1464 Default design (colors and background) for the site. Actual appearance
1465 depends on the theme.  Null values mean to use the theme defaults.
1466
1467 backgroundcolor: Hex color of the site background.
1468 contentcolor: Hex color of the content area background.
1469 sidebarcolor: Hex color of the sidebar background.
1470 textcolor: Hex color of all non-link text.
1471 linkcolor: Hex color of all links.
1472 backgroundimage: Image to use for the background.
1473 disposition: Flags for whether or not to tile the background image.
1474
1475 notice
1476 ------
1477
1478 Configuration options specific to notices.
1479
1480 contentlimit: max length of the plain-text content of a notice.
1481     Default is null, meaning to use the site-wide text limit.
1482     0 means no limit.
1483
1484 message
1485 -------
1486
1487 Configuration options specific to messages.
1488
1489 contentlimit: max length of the plain-text content of a message.
1490     Default is null, meaning to use the site-wide text limit.
1491     0 means no limit.
1492
1493 logincommand
1494 ------------
1495
1496 Configuration options for the login command.
1497
1498 disabled: whether to enable this command. If enabled, users who send
1499     the text 'login' to the site through any channel will
1500     receive a link to login to the site automatically in return.
1501     Possibly useful for users who primarily use an XMPP or SMS
1502     interface and can't be bothered to remember their site
1503     password. Note that the security implications of this are
1504     pretty serious and have not been thoroughly tested. You
1505     should enable it only after you've convinced yourself that
1506     it is safe. Default is 'false'.
1507
1508 singleuser
1509 ----------
1510
1511 If an installation has only one user, this can simplify a lot of the
1512 interface. It also makes the user's profile the root URL.
1513
1514 enabled: Whether to run in "single user mode". Default false.
1515 nickname: nickname of the single user. If no nickname is specified,
1516           the site owner account will be used (if present).
1517
1518 robotstxt
1519 ---------
1520
1521 We put out a default robots.txt file to guide the processing of
1522 Web crawlers. See http://www.robotstxt.org/ for more information
1523 on the format of this file.
1524
1525 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1526     for the robots.txt file. see http://ur1.ca/l5a0
1527     for more information. Default is zero, no explicit delay.
1528 disallow: Array of (virtual) directories to disallow. Default is 'main',
1529     'search', 'message', 'settings', 'admin'. Ignored when site
1530     is private, in which case the entire site ('/') is disallowed.
1531
1532 api
1533 ---
1534
1535 Options for the Twitter-like API.
1536
1537 realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
1538     for details). Some third-party tools like ping.fm want this to be
1539     'Identi.ca API', so set it to that if you want to. default = null,
1540     meaning 'something based on the site name'.
1541
1542 nofollow
1543 --------
1544
1545 We optionally put 'rel="nofollow"' on some links in some pages. The
1546 following configuration settings let you fine-tune how or when things
1547 are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
1548 information on what 'nofollow' means.
1549
1550 subscribers: whether to nofollow links to subscribers on the profile
1551     and personal pages. Default is true.
1552 members: links to members on the group page. Default true.
1553 peopletag: links to people listed in the peopletag page. Default true.
1554 external: external links in notices. One of three values: 'sometimes',
1555     'always', 'never'. If 'sometimes', then external links are not
1556     nofollowed on profile, notice, and favorites page. Default is
1557     'sometimes'.
1558
1559 router
1560 ------
1561
1562 We use a router class for mapping URLs to code. This section controls
1563 how that router works.
1564
1565 cache: whether to cache the router in memcache (or another caching
1566     mechanism). Defaults to true, but may be set to false for
1567     developers (who might be actively adding pages, so won't want the
1568     router cached) or others who see strange behavior. You're unlikely
1569     to need this unless you're a developer.
1570
1571 http
1572 ----
1573
1574 Settings for the HTTP client.
1575
1576 ssl_cafile: location of the CA file for SSL. If not set, won't verify
1577             SSL peers. Default unset.
1578 curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
1579       have the PHP curl extension installed for this to work.
1580 proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
1581             do any HTTP proxy stuff. Default unset.
1582 proxy_port: Port to use to connect to HTTP proxy host. Default null.
1583 proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
1584 proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
1585 proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
1586
1587 plugins
1588 -------
1589
1590 default: associative array mapping plugin name to array of arguments. To disable
1591          a default plugin, unset its value in this array.
1592 locale_path: path for finding plugin locale files. In the plugin's directory
1593              by default.
1594 server: Server to find static files for a plugin when the page is plain old HTTP.
1595         Defaults to site/server (same as pages). Use this to move plugin CSS and
1596         JS files to a CDN.
1597 sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
1598            to site/server (same as pages). Use this to move plugin CSS and JS files
1599            to a CDN.
1600 path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
1601       each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
1602       if you're using a CDN.
1603 sslpath: Path to use on the SSL server. Same as plugins/path.
1604
1605 Plugins
1606 =======
1607
1608 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1609 powerful plugin architecture. Important events in the code are named,
1610 like 'StartNoticeSave', and other software can register interest
1611 in those events. When the events happen, the other software is called
1612 and has a choice of accepting or rejecting the events.
1613
1614 In the simplest case, you can add a function to config.php and use the
1615 Event::addHandler() function to hook an event:
1616
1617     function AddGoogleLink($action)
1618     {
1619         $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1620         return true;
1621     }
1622
1623     Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1624
1625 This adds a menu item to the end of the main navigation menu. You can
1626 see the list of existing events, and parameters that handlers must
1627 implement, in EVENTS.txt.
1628
1629 The Plugin class in lib/plugin.php makes it easier to write more
1630 complex plugins. Sub-classes can just create methods named
1631 'onEventName', where 'EventName' is the name of the event (case
1632 matters!). These methods will be automatically registered as event
1633 handlers by the Plugin constructor (which you must call from your own
1634 class's constructor).
1635
1636 Several example plugins are included in the plugins/ directory. You
1637 can enable a plugin with the following line in config.php:
1638
1639     addPlugin('Example', array('param1' => 'value1',
1640                                'param2' => 'value2'));
1641
1642 This will look for and load files named 'ExamplePlugin.php' or
1643 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1644 plugins that ship with StatusNet) or in the local/ directory (for
1645 plugins you write yourself or that you get from somewhere else) or
1646 local/plugins/.
1647
1648 Plugins are documented in their own directories.
1649
1650 Troubleshooting
1651 ===============
1652
1653 The primary output for StatusNet is syslog, unless you configured a
1654 separate logfile. This is probably the first place to look if you're
1655 getting weird behaviour from StatusNet.
1656
1657 If you're tracking the unstable version of StatusNet in the git
1658 repository (see below), and you get a compilation error ("unexpected
1659 T_STRING") in the browser, check to see that you don't have any
1660 conflicts in your code.
1661
1662 If you upgraded to StatusNet 0.9.x without reading the "Notice
1663 inboxes" section above, and all your users' 'Personal' tabs are empty,
1664 read the "Notice inboxes" section above.
1665
1666 Myths
1667 =====
1668
1669 These are some myths you may see on the Web about StatusNet.
1670 Documentation from the core team about StatusNet has been pretty
1671 sparse, so some backtracking and guesswork resulted in some incorrect
1672 assumptions.
1673
1674 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1675   extremely bad idea. It's a tool built into DB_DataObject that will
1676   emit oodles of print lines directly to the browser of your users.
1677   Among these lines will be your database username and password. Do
1678   not enable this option on a production Web site for any reason.
1679
1680 - "Edit dataobject.ini with the following settings..." dataobject.ini
1681   is a development file for the DB_DataObject framework and is not
1682   used by the running software. It was removed from the StatusNet
1683   distribution because its presence was confusing. Do not bother
1684   configuring dataobject.ini, and do not put your database username
1685   and password into the file on a production Web server; unscrupulous
1686   persons may try to read it to get your passwords.
1687
1688 Unstable version
1689 ================
1690
1691 If you're adventurous or impatient, you may want to install the
1692 development version of StatusNet. To get it, use the git version
1693 control tool <http://git-scm.com/> like so:
1694
1695     git clone git@gitorious.org:statusnet/mainline.git
1696
1697 This is the version of the software that runs on Identi.ca and the
1698 status.net hosted service. Using it is a mixed bag. On the positive
1699 side, it usually includes the latest security and bug fix patches. On
1700 the downside, it may also include changes that require admin
1701 intervention (like running a script or even raw SQL!) that may not be
1702 documented yet. It may be a good idea to test this version before
1703 installing it on your production machines.
1704
1705 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1706
1707 Further information
1708 ===================
1709
1710 There are several ways to get more information about StatusNet.
1711
1712 * There is a mailing list for StatusNet developers and admins at
1713   http://mail.status.net/mailman/listinfo/statusnet-dev
1714 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1715 * The StatusNet wiki, http://status.net/wiki/
1716 * The StatusNet blog, http://status.net/blog/
1717 * The StatusNet status update, <http://status.status.net/> (!)
1718
1719 Feedback
1720 ========
1721
1722 * Microblogging messages to http://support.status.net/ are very welcome.
1723 * The microblogging group http://identi.ca/group/statusnet is a good
1724   place to discuss the software.
1725 * StatusNet has a bug tracker for any defects you may find, or ideas for
1726   making things better. http://status.net/bugs
1727
1728 Credits
1729 =======
1730
1731 The following is an incomplete list of developers who've worked on
1732 StatusNet. Apologies for any oversight; please let evan@status.net know
1733 if anyone's been overlooked in error.
1734
1735 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1736 * Zach Copley, StatusNet, Inc.
1737 * Earle Martin, StatusNet, Inc.
1738 * Marie-Claude Doyon, designer, StatusNet, Inc.
1739 * Sarven Capadisli, StatusNet, Inc.
1740 * Robin Millette, StatusNet, Inc.
1741 * Ciaran Gultnieks
1742 * Michael Landers
1743 * Ori Avtalion
1744 * Garret Buell
1745 * Mike Cochrane
1746 * Matthew Gregg
1747 * Florian Biree
1748 * Erik Stambaugh
1749 * 'drry'
1750 * Gina Haeussge
1751 * Tryggvi Bj√∂rgvinsson
1752 * Adrian Lang
1753 * Ori Avtalion
1754 * Meitar Moscovitz
1755 * Ken Sheppardson (Trac server, man-about-town)
1756 * Tiago 'gouki' Faria (i18n manager)
1757 * Sean Murphy
1758 * Leslie Michael Orchard
1759 * Eric Helgeson
1760 * Ken Sedgwick
1761 * Brian Hendrickson
1762 * Tobias Diekershoff
1763 * Dan Moore
1764 * Fil
1765 * Jeff Mitchell
1766 * Brenda Wallace
1767 * Jeffery To
1768 * Federico Marani
1769 * Craig Andrews
1770 * mEDI
1771 * Brett Taylor
1772 * Brigitte Schuster
1773 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
1774 * Brion Vibber, StatusNet, Inc.
1775 * James Walker, StatusNet, Inc.
1776 * Samantha Doherty, designer, StatusNet, Inc.
1777
1778 Thanks also to the developers of our upstream library code and to the
1779 thousands of people who have tried out Identi.ca, installed StatusNet,
1780 told their friends, and built the Open Microblogging network to what
1781 it is today.