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