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