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