5 StatusNet 0.9.4 "Orange Crush"
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.
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.
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.
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
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:
38 http://www.opendefinition.org/ossd
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.
46 A commercial software subscription is available from StatusNet Inc. It
47 includes 24-hour technical support and developer support. More
48 information at http://status.net/contact or email sales@status.net.
53 This program is free software: you can redistribute it and/or modify
54 it under the terms of the GNU Affero General Public License as
55 published by the Free Software Foundation, either version 3 of the
56 License, or (at your option) any later version.
58 This program is distributed in the hope that it will be useful, but
59 WITHOUT ANY WARRANTY; without even the implied warranty of
60 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
61 Affero General Public License for more details.
63 You should have received a copy of the GNU Affero General Public
64 License along with this program, in the file "COPYING". If not, see
65 <http://www.gnu.org/licenses/>.
67 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
68 *different requirements* from the "regular" GPL. In particular, if
69 you make modifications to the StatusNet source code on your server,
70 you *MUST MAKE AVAILABLE* the modified version of the source code
71 to your users under the same license. This is a legal requirement
72 of using the software, and if you do not wish to share your
73 modifications, *YOU MAY NOT INSTALL STATUSNET*.
75 Additional library software has been made available in the 'extlib'
76 directory. All of it is Free Software and can be distributed under
77 liberal terms, but those terms may differ in detail from the AGPL's
78 particulars. See each package's license file in the extlib directory
84 This is a security, bug and feature release since version 0.9.3 released on
87 For best compatibility with client software and site federation, and a lot of
88 bug fixes, it is highly recommended that all public sites upgrade to the new
91 Notable changes this version:
93 - OpenID and OAuth libraries patched for potential timing attack
94 - OStatus feed i/o updated for Activity Streams
95 - Correctness fixes on XRD, other discovery bits
96 - Support for contacting SNI-based SSL virtual hosts when SSL
97 certificate verification is enabled (requires PHP 5.3.2+ or
98 enabling CURL backend with $config['http']['curl'] = true)
99 - Experimental SubMirror plugin
100 - Multi-site status_network table mode has been tweaked to support
102 - Many updates to user interface translation from TranslateWiki
103 - Many other bugfixes
105 A full changelog is available at http://status.net/wiki/StatusNet_0.9.4.
110 The following software packages are *required* for this software to
113 - PHP 5.2.3+. It may be possible to run this software on earlier
114 versions of PHP, but many of the functions used are only available
115 in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
116 daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
117 release, but problems with some plugins are possible.
118 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
119 server. It has been primarily tested on 5.x servers, although it may
120 be possible to install on earlier (or later!) versions. The server
121 *must* support the MyISAM storage engine -- the default for most
122 MySQL servers -- *and* the InnoDB storage engine.
123 - A Web server. Preferably, you should have Apache 2.2.x with the
124 mod_rewrite extension installed and enabled.
126 Your PHP installation must include the following PHP extensions:
128 - Curl. This is for fetching files by HTTP.
129 - XMLWriter. This is for formatting XML and HTML output.
130 - MySQL. For accessing the database.
131 - GD. For scaling down avatar images.
132 - mbstring. For handling Unicode (UTF-8) encoded strings.
134 For some functionality, you will also need the following extensions:
136 - Memcache. A client for the memcached server, which caches database
137 information in volatile memory. This is important for adequate
138 performance on high-traffic sites. You will also need a memcached
139 server to store the data in.
140 - Mailparse. Efficient parsing of email requires this extension.
141 Submission by email or SMS-over-email uses this extension.
142 - Sphinx Search. A client for the sphinx server, an alternative
143 to MySQL or Postgresql fulltext search. You will also need a
144 Sphinx server to serve the search queries.
145 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
146 if you have OStatus configured.
147 - gettext. For multiple languages. Default on many PHP installs;
148 will be emulated if not present.
150 You will almost definitely get 2-3 times better performance from your
151 site if you install a PHP bytecode cache/accelerator. Some well-known
152 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
153 is a proprietary accelerator installed on some hosting sites.
158 A number of external PHP libraries are used to provide basic
159 functionality and optional functionality for your system. For your
160 convenience, they are available in the "extlib" directory of this
161 package, and you do not have to download and install them. However,
162 you may want to keep them up-to-date with the latest upstream version,
163 and the URLs are listed here for your convenience.
165 - DB_DataObject http://pear.php.net/package/DB_DataObject
166 - Validate http://pear.php.net/package/Validate
167 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
168 to use the openidenabled.com version since it's more widely
169 implemented, and seems to be better supported.
170 http://openidenabled.com/php-openid/
171 - PEAR DB. Although this is an older data access system (new
172 packages should probably use PHP DBO), the OpenID libraries
173 depend on PEAR DB so we use it here, too. DB_DataObject can
174 also use PEAR MDB2, which may give you better performance
175 but won't work with OpenID.
176 http://pear.php.net/package/DB
177 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
178 - markdown.php from http://michelf.com/projects/php-markdown/
179 - PEAR Mail, for sending out mail notifications
180 http://pear.php.net/package/Mail
181 - PEAR Net_SMTP, if you use the SMTP factory for notifications
182 http://pear.php.net/package/Net_SMTP
183 - PEAR Net_Socket, if you use the SMTP factory for notifications
184 http://pear.php.net/package/Net_Socket
185 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
186 library available for PHP. http://xmpphp.googlecode.com/. Note that
187 as of this writing the version of this library that is available in
188 the extlib directory is *significantly different* from the upstream
189 version (patches have been submitted). Upgrading to the upstream
190 version may render your StatusNet site unable to send or receive XMPP
192 - Facebook library. Used for the Facebook application.
193 - PEAR Services_oEmbed. Used for some multimedia integration.
194 - PEAR HTTP_Request is an oEmbed dependency.
195 - PEAR Validate is an oEmbed dependency.
196 - PEAR Net_URL2 is an oEmbed dependency.
197 - Console_GetOpt for parsing command-line options.
198 - libomb. a library for implementing OpenMicroBlogging 0.1, the
199 predecessor to OStatus.
200 - HTTP_Request2, a library for making HTTP requests.
202 A design goal of StatusNet is that the basic Web functionality should
203 work on even the most restrictive commercial hosting services.
204 However, additional functionality, such as receiving messages by
205 Jabber/GTalk, require that you be able to run long-running processes
206 on your account. In addition, posting by email or from SMS require
207 that you be able to install a mail filter in your mail server.
212 Installing the basic StatusNet Web component is relatively easy,
213 especially if you've previously installed PHP/MySQL packages.
215 1. Unpack the tarball you downloaded on your Web server. Usually a
216 command like this will work:
218 tar zxf statusnet-0.9.4.tar.gz
220 ...which will make a statusnet-0.9.2 subdirectory in your current
221 directory. (If you don't have shell access on your Web server, you
222 may have to unpack the tarball on your local computer and FTP the
223 files to the server.)
225 2. Move the tarball to a directory of your choosing in your Web root
226 directory. Usually something like this will work:
228 mv statusnet-0.9.4 /var/www/statusnet
230 This will make your StatusNet instance available in the statusnet path of
231 your server, like "http://example.net/statusnet". "microblog" or
232 "statusnet" might also be good path names. If you know how to
233 configure virtual hosts on your web server, you can try setting up
234 "http://micro.example.net/" or the like.
236 3. Make your target directory writeable by the Web server.
238 chmod a+w /var/www/statusnet/
240 On some systems, this will probably work:
242 chgrp www-data /var/www/statusnet/
243 chmod g+w /var/www/statusnet/
245 If your Web server runs as another user besides "www-data", try
246 that user's default group instead. As a last resort, you can create
247 a new group like "statusnet" and add the Web server's user to the group.
249 4. You should also take this moment to make your avatar, background, and
250 file subdirectories writeable by the Web server. An insecure way to do
253 chmod a+w /var/www/statusnet/avatar
254 chmod a+w /var/www/statusnet/background
255 chmod a+w /var/www/statusnet/file
257 You can also make the avatar, background, and file directories
258 writeable by the Web server group, as noted above.
260 5. Create a database to hold your microblog data. Something like this
263 mysqladmin -u "username" --password="password" create statusnet
265 Note that StatusNet must have its own database; you can't share the
266 database with another program. You can name it whatever you want,
269 (If you don't have shell access to your server, you may need to use
270 a tool like PHPAdmin to create a database. Check your hosting
271 service's documentation for how to create a new MySQL database.)
273 6. Create a new database account that StatusNet will use to access the
274 database. If you have shell access, this will probably work from the
277 GRANT ALL on statusnet.*
278 TO 'statusnetuser'@'localhost'
279 IDENTIFIED BY 'statusnetpassword';
281 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
282 username and password. You may want to test logging in to MySQL as
285 7. In a browser, navigate to the StatusNet install script; something like:
287 http://yourserver.example.com/statusnet/install.php
289 Enter the database connection information and your site name. The
290 install program will configure your site and install the initial,
291 almost-empty database.
293 8. You should now be able to navigate to your microblog's main directory
294 and see the "Public Timeline", which will be empty. If not, magic
295 has happened! You can now register a new user, post some notices,
296 edit your profile, etc. However, you may want to wait to do that stuff
297 if you think you can set up "fancy URLs" (see below), since some
298 URLs are stored in the database.
303 By default, StatusNet will use URLs that include the main PHP program's
304 name in them. For example, a user's home profile might be
307 http://example.org/statusnet/index.php/statusnet/fred
309 On certain systems that don't support this kind of syntax, they'll
312 http://example.org/statusnet/index.php?p=statusnet/fred
314 It's possible to configure the software so it looks like this instead:
316 http://example.org/statusnet/fred
318 These "fancy URLs" are more readable and memorable for users. To use
319 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
320 mod_rewrite enabled, -OR- know how to configure "url redirection" in
323 1. Copy the htaccess.sample file to .htaccess in your StatusNet
324 directory. Note: if you have control of your server's httpd.conf or
325 similar configuration files, it can greatly improve performance to
326 import the .htaccess file into your conf file instead. If you're
327 not sure how to do it, you may save yourself a lot of headache by
328 just leaving the .htaccess file.
330 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
331 to your StatusNet installation on your server. Typically this will
332 be the path to your StatusNet directory relative to your Web root.
334 3. Add or uncomment or change a line in your config.php file so it says:
336 $config['site']['fancy'] = true;
338 You should now be able to navigate to a "fancy" URL on your server,
341 http://example.net/statusnet/main/register
343 If you changed your HTTP server configuration, you may need to restart
346 If it doesn't work, double-check that AllowOverride for the StatusNet
347 directory is 'All' in your Apache configuration file. This is usually
348 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
349 /etc/apache2/sites-available/default. See the Apache documentation for
350 .htaccess files for more details:
352 http://httpd.apache.org/docs/2.2/howto/htaccess.html
354 Also, check that mod_rewrite is installed and enabled:
356 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
361 To use a Sphinx server to search users and notices, you'll need to
362 enable the SphinxSearch plugin. Add to your config.php:
364 addPlugin('SphinxSearch');
365 $config['sphinx']['server'] = 'searchhost.local';
367 You also need to install, compile and enable the sphinx pecl extension for
368 php on the client side, which itself depends on the sphinx development files.
370 See plugins/SphinxSearch/README for more details and server setup.
375 StatusNet supports a cheap-and-dirty system for sending update messages
376 to mobile phones and for receiving updates from the mobile. Instead of
377 sending through the SMS network itself, which is costly and requires
378 buy-in from the wireless carriers, it simply piggybacks on the email
379 gateways that many carriers provide to their customers. So, SMS
380 configuration is essentially email configuration.
382 Each user sends to a made-up email address, which they keep a secret.
383 Incoming email that is "From" the user's SMS email address, and "To"
384 the users' secret email address on the site's domain, will be
385 converted to a notice and stored in the DB.
387 For this to work, there *must* be a domain or sub-domain for which all
388 (or most) incoming email can pass through the incoming mail filter.
390 1. Run the SQL script carrier.sql in your StatusNet database. This will
393 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
395 This will populate your database with a list of wireless carriers
396 that support email SMS gateways.
398 2. Make sure the maildaemon.php file is executable:
400 chmod +x scripts/maildaemon.php
402 Note that "daemon" is kind of a misnomer here; the script is more
403 of a filter than a daemon.
405 2. Edit /etc/aliases on your mail server and add the following line:
407 *: /path/to/statusnet/scripts/maildaemon.php
409 3. Run whatever code you need to to update your aliases database. For
410 many mail servers (Postfix, Exim, Sendmail), this should work:
414 You may need to restart your mail server for the new database to
417 4. Set the following in your config.php file:
419 $config['mail']['domain'] = 'yourdomain.example.net';
421 At this point, post-by-email and post-by-SMS-gateway should work. Note
422 that if your mail server is on a different computer from your email
423 server, you'll need to have a full installation of StatusNet, a working
424 config.php, and access to the StatusNet database from the mail server.
429 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
430 instant-messenger protocol that drives Jabber and GTalk IM. You can
431 distribute messages via XMPP using the system below; however, you
432 need to run the XMPP incoming daemon to allow incoming messages as
435 1. You may want to strongly consider setting up your own XMPP server.
436 Ejabberd, OpenFire, and JabberD are all Open Source servers.
437 Jabber, Inc. provides a high-performance commercial server.
439 2. You must register a Jabber ID (JID) with your new server. It helps
440 to choose a name like "update@example.com" or "notice" or something
441 similar. Alternately, your "update JID" can be registered on a
442 publicly-available XMPP service, like jabber.org or GTalk.
444 StatusNet will not register the JID with your chosen XMPP server;
445 you need to do this manually, with an XMPP client like Gajim,
446 Telepathy, or Pidgin.im.
448 3. Configure your site's XMPP variables, as described below in the
449 configuration section.
451 On a default installation, your site can broadcast messages using
452 XMPP. Users won't be able to post messages using XMPP unless you've
453 got the XMPP daemon running. See 'Queues and daemons' below for how
454 to set that up. Also, once you have a sizable number of users, sending
455 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
456 can really slow down your site; it may cause posting to timeout.
458 NOTE: stream_select(), a crucial function for network programming, is
459 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
460 work around this bug in StatusNet; current recommendation is to move
461 off of amd64 to another server.
466 You can send *all* messages from your microblogging site to a
467 third-party service using XMPP. This can be useful for providing
468 search, indexing, bridging, or other cool services.
470 To configure a downstream site to receive your public stream, add
471 their "JID" (Jabber ID) to your config.php as follows:
473 $config['xmpp']['public'][] = 'downstream@example.net';
475 (Don't miss those square brackets at the end.) Note that your XMPP
476 broadcasting must be configured as mentioned above. Although you can
477 send out messages at "Web time", high-volume sites should strongly
478 consider setting up queues and daemons.
483 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
484 and XMPP messages, can be 'queued' and done by off-line bots instead.
485 For this to work, you must be able to run long-running offline
486 processes, either on your main Web server or on another server you
487 control. (Your other server will still need all the above
488 prerequisites, with the exception of Apache.) Installing on a separate
489 server is probably a good idea for high-volume sites.
491 1. You'll need the "CLI" (command-line interface) version of PHP
492 installed on whatever server you use.
494 2. If you're using a separate server for queues, install StatusNet
495 somewhere on the server. You don't need to worry about the
496 .htaccess file, but make sure that your config.php file is close
497 to, or identical to, your Web server's version.
499 3. In your config.php files (both the Web server and the queues
500 server!), set the following variable:
502 $config['queue']['enabled'] = true;
504 You may also want to look at the 'daemon' section of this file for
505 more daemon options. Note that if you set the 'user' and/or 'group'
506 options, you'll need to create that user and/or group by hand.
507 They're not created automatically.
509 4. On the queues server, run the command scripts/startdaemons.sh.
511 This will run the queue handlers:
513 * queuedaemon.php - polls for queued items for inbox processing and
514 pushing out to OStatus, SMS, XMPP, etc.
515 * xmppdaemon.php - listens for new XMPP messages from users and stores
516 them as notices in the database; also pulls queued XMPP output from
517 queuedaemon.php to push out to clients.
519 These two daemons will automatically restart in most cases of failure
520 including memory leaks (if a memory_limit is set), but may still die
521 or behave oddly if they lose connections to the XMPP or queue servers.
523 Additional daemons may be also started by this script for certain
524 plugins, such as the Twitter bridge.
526 It may be a good idea to use a daemon-monitoring service, like 'monit',
527 to check their status and keep them running.
529 All the daemons write their process IDs (pids) to /var/run/ by
530 default. This can be useful for starting, stopping, and monitoring the
533 Since version 0.8.0, it's now possible to use a STOMP server instead of
534 our kind of hacky home-grown DB-based queue solution. This is strongly
535 recommended for best response time, especially when using XMPP.
537 See the "queues" config section below for how to configure to use STOMP.
538 As of this writing, the software has been tested with ActiveMQ 5.3.
543 There are two themes shipped with this version of StatusNet: "identica",
544 which is what the Identi.ca site uses, and "default", which is a good
545 basis for other sites.
547 As of right now, your ability to change the theme is site-wide; users
548 can't choose their own theme. Additionally, the only thing you can
549 change in the theme is CSS stylesheets and some image files; you can't
550 change the HTML output, like adding or removing menu items.
552 You can choose a theme using the $config['site']['theme'] element in
553 the config.php file. See below for details.
555 You can add your own theme by making a sub-directory of the 'theme'
556 subdirectory with the name of your theme. Each theme can have the
559 display.css: a CSS2 file for "default" styling for all browsers.
560 ie6.css: a CSS2 file for override styling for fixing up Internet
562 ie7.css: a CSS2 file for override styling for fixing up Internet
564 logo.png: a logo image for the site.
565 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
566 users who don't upload their own.
567 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
568 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
569 listing on profile pages.
571 You may want to start by copying the files from the default theme to
574 NOTE: the HTML generated by StatusNet changed *radically* between
575 version 0.6.x and 0.7.x. Older themes will need signification
576 modification to use the new output format.
581 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
582 Theoretically, you can add your own sub-directory to the locale/
583 subdirectory to add a new language to your system. You'll need to
584 compile the ".po" files into ".mo" files, however.
586 Contributions of translation information to StatusNet are very easy:
587 you can use the Web interface at TranslateWiki.net to add one
588 or a few or lots of new translations -- or even new languages. You can
589 also download more up-to-date .po files there, if you so desire.
591 For info on helping with translations, see http://status.net/wiki/Translations
596 There is no built-in system for doing backups in StatusNet. You can make
597 backups of a working StatusNet system by backing up the database and
598 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
599 and to backup the Web directory, try tar.
604 The administrator can set the "private" flag for a site so that it's
605 not visible to non-logged-in users. This might be useful for
606 workgroups who want to share a microblogging site for project
607 management, but host it on a public server.
609 Total privacy is not guaranteed or ensured. Also, privacy is
610 all-or-nothing for a site; you can't have some accounts or notices
611 private, and others public. The interaction of private sites
612 with OStatus is undefined.
614 Access to file attachments can also be restricted to logged-in users only.
615 1. Add a directory outside the web root where your file uploads will be
616 stored. Usually a command like this will work:
618 mkdir /var/www/statusnet-files
620 2. Make the file uploads directory writeable by the web server. An
621 insecure way to do this is:
623 chmod a+x /var/www/statusnet-files
625 3. Tell StatusNet to use this directory for file uploads. Add a line
626 like this to your config.php:
628 $config['attachments']['dir'] = '/var/www/statusnet-files';
633 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
634 incorrectly-stored international characters ("UTF-8"). For new
635 installations, it will now store non-ASCII characters correctly.
636 However, older installations will have the incorrect storage, and will
637 consequently show up "wrong" in browsers. See below for how to deal
640 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
641 been tracking the "git" version of the software, you will probably
642 want to upgrade and keep your existing data. There is no automated
643 upgrade procedure in StatusNet 0.9.2. Try these step-by-step
644 instructions; read to the end first before trying them.
646 0. Download StatusNet and set up all the prerequisites as if you were
648 1. Make backups of both your database and your Web directory. UNDER NO
649 CIRCUMSTANCES should you try to do an upgrade without a known-good
650 backup. You have been warned.
651 2. Shut down Web access to your site, either by turning off your Web
652 server or by redirecting all pages to a "sorry, under maintenance"
654 3. Shut down XMPP access to your site, typically by shutting down the
655 xmppdaemon.php process and all other daemons that you're running.
656 If you've got "monit" or "cron" automatically restarting your
657 daemons, make sure to turn that off, too.
658 4. Shut down SMS and email access to your site. The easy way to do
659 this is to comment out the line piping incoming email to your
660 maildaemon.php file, and running something like "newaliases".
661 5. Once all writing processes to your site are turned off, make a
662 final backup of the Web directory and database.
663 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
664 7. Unpack your StatusNet 0.9.2 tarball and move it to "statusnet" or
665 wherever your code used to be.
666 8. Copy the config.php file and avatar directory from your old
667 directory to your new directory.
668 9. Copy htaccess.sample to .htaccess in the new directory. Change the
669 RewriteBase to use the correct path.
670 10. Rebuild the database. (You can safely skip this step and go to #12
671 if you're upgrading from another 0.9.x version).
673 NOTE: this step is destructive and cannot be
674 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
675 do it without a known-good backup!
677 If your database is at version 0.8.0 or above, you can run a
678 special upgrade script:
680 mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
682 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
683 BACKUP run the rebuilddb.sh script like this:
685 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
687 Here, rootuser and rootpassword are the username and password for a
688 user who can drop and create databases as well as tables; typically
689 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
690 your database and rebuilds it; if there is an error you have no
691 database. Make sure you have a backup.
692 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
693 which operates slightly differently. Read the documentation in that
694 script before running it.
695 11. Use mysql or psql client to log into your database and make sure that
696 the notice, user, profile, subscription etc. tables are non-empty.
697 12. Turn back on the Web server, and check that things still work.
698 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
699 bots have changed since version 0.5; see above for details.
701 If you're upgrading from very old versions, you may want to look at
702 the fixup_* scripts in the scripts directories. These will store some
703 precooked data in the DB. All upgraders should check out the inboxes
706 NOTE: the database definition file, laconica.ini, has been renamed to
707 statusnet.ini (since this is the recommended database name). If you
708 have a line in your config.php pointing to the old name, you'll need
714 Notice inboxes are now required. If you don't have inboxes enabled,
715 StatusNet will no longer run.
720 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
721 international characters ("UTF-8"). This fix is not
722 backwards-compatible; installations from before 0.7.4 will show
723 non-ASCII characters of old notices incorrectly. This section explains
726 0. You can disable the new behaviour by setting the 'db''utf8' config
727 option to "false". You should only do this until you're ready to
728 convert your DB to the new format.
729 1. When you're ready to convert, you can run the fixup_utf8.php script
730 in the scripts/ subdirectory. If you've had the "new behaviour"
731 enabled (probably a good idea), you can give the ID of the first
732 "new" notice as a parameter, and only notices before that one will
733 be converted. Notices are converted in reverse chronological order,
734 so the most recent (and visible) ones will be converted first. The
735 script should work whether or not you have the 'db''utf8' config
737 2. When you're ready, set $config['db']['utf8'] to true, so that
738 new notices will be stored correctly.
740 Configuration options
741 =====================
743 The main configuration file for StatusNet (excepting configurations for
744 dependency software) is config.php in your StatusNet directory. If you
745 edit any other file in the directory, like lib/default.php (where most
746 of the defaults are defined), you will lose your configuration options
747 in any upgrade, and you will wish that you had been more careful.
749 Starting with version 0.9.0, a Web based configuration panel has been
750 added to StatusNet. The preferred method for changing config options is
753 A command-line script, setconfig.php, can be used to set individual
754 configuration options. It's in the scripts/ directory.
756 Starting with version 0.7.1, you can put config files in the
757 /etc/statusnet/ directory on your server, if it exists. Config files
758 will be included in this order:
760 * /etc/statusnet/statusnet.php - server-wide config
761 * /etc/statusnet/<servername>.php - for a virtual host
762 * /etc/statusnet/<servername>_<pathname>.php - for a path
763 * INSTALLDIR/config.php - for a particular implementation
765 Almost all configuration options are made through a two-dimensional
766 associative array, cleverly named $config. A typical configuration
769 $config['section']['option'] = value;
771 For brevity, the following documentation describes each section and
777 This section is a catch-all for site-wide variables.
779 name: the name of your site, like 'YourCompany Microblog'.
780 server: the server part of your site's URLs, like 'example.net'.
781 path: The path part of your site's URLs, like 'statusnet' or ''
783 fancy: whether or not your site uses fancy URLs (see Fancy URLs
784 section above). Default is false.
785 logfile: full path to a file for StatusNet to save logging
786 information to. You may want to use this if you don't have
788 logdebug: whether to log additional debug info like backtraces on
789 hard errors. Default false.
790 locale_path: full path to the directory for locale data. Unless you
791 store all your locale data in one place, you probably
792 don't need to use this.
793 language: default language for your site. Defaults to US English.
794 Note that this is overridden if a user is logged in and has
795 selected a different language. It is also overridden if the
796 user is NOT logged in, but their browser requests a different
797 langauge. Since pretty much everybody's browser requests a
798 language, that means that changing this setting has little or
799 no effect in practice.
800 languages: A list of languages supported on your site. Typically you'd
801 only change this if you wanted to disable support for one
803 "unset($config['site']['languages']['de'])" will disable
805 theme: Theme for your site (see Theme section). Two themes are
806 provided by default: 'default' and 'stoica' (the one used by
807 Identi.ca). It's appreciated if you don't use the 'stoica' theme
808 except as the basis for your own.
809 email: contact email address for your site. By default, it's extracted
810 from your Web server environment; you may want to customize it.
811 broughtbyurl: name of an organization or individual who provides the
812 service. Each page will include a link to this name in the
813 footer. A good way to link to the blog, forum, wiki,
814 corporate portal, or whoever is making the service available.
815 broughtby: text used for the "brought by" link.
816 timezone: default timezone for message display. Users can set their
817 own time zone. Defaults to 'UTC', which is a pretty good default.
818 closed: If set to 'true', will disallow registration on your site.
819 This is a cheap way to restrict accounts to only one
820 individual or group; just register the accounts you want on
821 the service, *then* set this variable to 'true'.
822 inviteonly: If set to 'true', will only allow registration if the user
823 was invited by an existing user.
824 private: If set to 'true', anonymous users will be redirected to the
825 'login' page. Also, API methods that normally require no
826 authentication will require it. Note that this does not turn
827 off registration; use 'closed' or 'inviteonly' for the
829 notice: A plain string that will appear on every page. A good place
830 to put introductory information about your service, or info about
831 upgrades and outages, or other community info. Any HTML will
833 logo: URL of an image file to use as the logo for the site. Overrides
834 the logo in the theme, if any.
835 ssl: Whether to use SSL and https:// URLs for some or all pages.
836 Possible values are 'always' (use it for all pages), 'never'
837 (don't use it for any pages), or 'sometimes' (use it for
838 sensitive pages that include passwords like login and registration,
839 but not for regular pages). Default to 'never'.
840 sslserver: use an alternate server name for SSL URLs, like
841 'secure.example.org'. You should be careful to set cookie
842 parameters correctly so that both the SSL server and the
843 "normal" server can access the session cookie and
844 preferably other cookies as well.
845 shorturllength: Length of URL at which URLs in a message exceeding 140
846 characters will be sent to the user's chosen
848 dupelimit: minimum time allowed for one person to say the same thing
849 twice. Default 60s. Anything lower is considered a user
851 textlimit: default max size for texts in the site. Defaults to 140.
852 0 means no limit. Can be fine-tuned for notices, messages,
853 profile bios and group descriptions.
858 This section is a reference to the configuration options for
859 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
860 set are listed below for clarity.
862 database: a DSN (Data Source Name) for your StatusNet database. This is
863 in the format 'protocol://username:password@hostname/databasename',
864 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
865 really know what you're doing), 'username' is the username,
866 'password' is the password, and etc.
867 ini_yourdbname: if your database is not named 'statusnet', you'll need
868 to set this to point to the location of the
869 statusnet.ini file. Note that the real name of your database
870 should go in there, not literally 'yourdbname'.
871 db_driver: You can try changing this to 'MDB2' to use the other driver
872 type for DB_DataObject, but note that it breaks the OpenID
873 libraries, which only support PEAR::DB.
874 debug: On a database error, you may get a message saying to set this
875 value to 5 to see debug messages in the browser. This breaks
876 just about all pages, and will also expose the username and
878 quote_identifiers: Set this to true if you're using postgresql.
879 type: either 'mysql' or 'postgresql' (used for some bits of
880 database-type-specific SQL in the code). Defaults to mysql.
881 mirror: you can set this to an array of DSNs, like the above
882 'database' value. If it's set, certain read-only actions will
883 use a random value out of this array for the database, rather
884 than the one in 'database' (actually, 'database' is overwritten).
885 You can offload a busy DB server by setting up MySQL replication
886 and adding the slaves to this array. Note that if you want some
887 requests to go to the 'database' (master) server, you'll need
888 to include it in this array, too.
889 utf8: whether to talk to the database in UTF-8 mode. This is the default
890 with new installations, but older sites may want to turn it off
891 until they get their databases fixed up. See "UTF-8 database"
893 schemacheck: when to let plugins check the database schema to add
894 tables or update them. Values can be 'runtime' (default)
895 or 'script'. 'runtime' can be costly (plugins check the
896 schema on every hit, adding potentially several db
897 queries, some quite long), but not everyone knows how to
898 run a script. If you can, set this to 'script' and run
899 scripts/checkschema.php whenever you install or upgrade a
905 By default, StatusNet sites log error messages to the syslog facility.
906 (You can override this using the 'logfile' parameter described above).
908 appname: The name that StatusNet uses to log messages. By default it's
909 "statusnet", but if you have more than one installation on the
910 server, you may want to change the name for each instance so
911 you can track log messages more easily.
912 priority: level to log at. Currently ignored.
913 facility: what syslog facility to used. Defaults to LOG_USER, only
914 reset if you know what syslog is and have a good reason
920 You can configure the software to queue time-consuming tasks, like
921 sending out SMS email or XMPP messages, for off-line processing. See
922 'Queues and daemons' above for how to set this up.
924 enabled: Whether to uses queues. Defaults to false.
925 subsystem: Which kind of queueserver to use. Values include "db" for
926 our hacked-together database queuing (no other server
927 required) and "stomp" for a stomp server.
928 stomp_server: "broker URI" for stomp server. Something like
929 "tcp://hostname:61613". More complicated ones are
930 possible; see your stomp server's documentation for
932 queue_basename: a root name to use for queues (stomp only). Typically
933 something like '/queue/sitename/' makes sense. If running
934 multiple instances on the same server, make sure that
935 either this setting or $config['site']['nickname'] are
936 unique for each site to keep them separate.
938 stomp_username: username for connecting to the stomp server; defaults
940 stomp_password: password for connecting to the stomp server; defaults
943 stomp_persistent: keep items across queue server restart, if enabled.
944 Under ActiveMQ, the server configuration determines if and how
945 persistent storage is actually saved.
947 If using a message queue server other than ActiveMQ, you may
948 need to disable this if it does not support persistence.
950 stomp_transactions: use transactions to aid in error detection.
951 A broken transaction will be seen quickly, allowing a message
952 to be redelivered immediately if a daemon crashes.
954 If using a message queue server other than ActiveMQ, you may
955 need to disable this if it does not support transactions.
957 stomp_acks: send acknowledgements to aid in flow control.
958 An acknowledgement of successful processing tells the server
959 we're ready for more and can help keep things moving smoothly.
961 This should *not* be turned off when running with ActiveMQ, but
962 if using another message queue server that does not support
963 acknowledgements you might need to disable this.
965 softlimit: an absolute or relative "soft memory limit"; daemons will
966 restart themselves gracefully when they find they've hit
967 this amount of memory usage. Defaults to 90% of PHP's global
968 memory_limit setting.
970 inboxes: delivery of messages to receiver's inboxes can be delayed to
971 queue time for best interactive performance on the sender.
972 This may however be annoyingly slow when using the DB queues,
973 so you can set this to false if it's causing trouble.
975 breakout: for stomp, individual queues are by default grouped up for
976 best scalability. If some need to be run by separate daemons,
977 etc they can be manually adjusted here.
979 Default will share all queues for all sites within each group.
980 Specify as <group>/<queue> or <group>/<queue>/<site>,
981 using nickname identifier as site.
983 'main/distrib' separate "distrib" queue covering all sites
984 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
986 max_retries: for stomp, drop messages after N failed attempts to process.
989 dead_letter_dir: for stomp, optional directory to dump data on failed
990 queue processing events after discarding them.
992 stomp_no_transactions: for stomp, the server does not support transactions,
993 so do not try to user them. This is needed for http://www.morbidq.com/.
995 stomp_no_acks: for stomp, the server does not support acknowledgements.
996 so do not try to user them. This is needed for http://www.morbidq.com/.
1001 The default license to use for your users notices. The default is the
1002 Creative Commons Attribution 3.0 license, which is probably the right
1003 choice for any public site. Note that some other servers will not
1004 accept notices if you apply a stricter license than this.
1006 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1007 (default copyright), or 'private' (for private and confidential
1009 owner: for 'allrightsreserved' or 'private', an assigned copyright
1010 holder (for example, an employer for a private site). If
1011 not specified, will be attributed to 'contributors'.
1012 url: URL of the license, used for links.
1013 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1014 image: A button shown on each page for the license.
1019 This is for configuring out-going email. We use PEAR's Mail module,
1020 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1022 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1023 'smtp'. Defaults to PEAR's default, 'mail'.
1024 params: if the mail backend requires any parameters, you can provide
1025 them in an associative array.
1030 This is for configuring nicknames in the service.
1032 blacklist: an array of strings for usernames that may not be
1033 registered. A default array exists for strings that are
1034 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1035 but you may want to add others if you have other software
1036 installed in a subdirectory of StatusNet or if you just
1037 don't want certain words used as usernames.
1038 featured: an array of nicknames of 'featured' users of the site.
1039 Can be useful to draw attention to well-known users, or
1040 interesting people, or whatever.
1045 For configuring avatar access.
1047 dir: Directory to look for avatar files and to put them into.
1048 Defaults to avatar subdirectory of install directory; if
1049 you change it, make sure to change path, too.
1050 path: Path to avatars. Defaults to path for avatar subdirectory,
1051 but you can change it if you wish. Note that this will
1052 be included with the avatar server, too.
1053 server: If set, defines another server where avatars are stored in the
1054 root directory. Note that the 'avatar' subdir still has to be
1055 writeable. You'd typically use this to split HTTP requests on
1056 the client to speed up page loading, either with another
1057 virtual server or with an NFS or SAMBA share. Clients
1058 typically only make 2 connections to a single server at a
1059 time <http://ur1.ca/6ih>, so this can parallelize the job.
1061 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1062 to guess based on site-wide SSL settings.
1067 For configuring the public stream.
1069 localonly: If set to true, only messages posted by users of this
1070 service (rather than other services, filtered through OMB)
1071 are shown in the public stream. Default true.
1072 blacklist: An array of IDs of users to hide from the public stream.
1073 Useful if you have someone making excessive Twitterfeed posts
1074 to the site, other kinds of automated posts, testing bots, etc.
1075 autosource: Sources of notices that are from automatic posters, and thus
1076 should be kept off the public timeline. Default empty.
1081 server: Like avatars, you can speed up page loading by pointing the
1082 theme file lookup to another server (virtual or real).
1083 Defaults to NULL, meaning to use the site server.
1084 dir: Directory where theme files are stored. Used to determine
1085 whether to show parts of a theme file. Defaults to the theme
1086 subdirectory of the install directory.
1087 path: Path part of theme URLs, before the theme name. Relative to the
1088 theme server. It may make sense to change this path when upgrading,
1089 (using version numbers as the path) to make sure that all files are
1090 reloaded by caching clients or proxies. Defaults to null,
1091 which means to use the site path + '/theme'.
1092 ssl: Whether to use SSL for theme elements. Default is null, which means
1093 guess based on site SSL settings.
1098 server: You can speed up page loading by pointing the
1099 theme file lookup to another server (virtual or real).
1100 Defaults to NULL, meaning to use the site server.
1101 path: Path part of Javascript URLs. Defaults to null,
1102 which means to use the site path + '/js/'.
1103 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1104 guess based on site SSL settings.
1109 For configuring the XMPP sub-system.
1111 enabled: Whether to accept and send messages by XMPP. Default false.
1112 server: server part of XMPP ID for update user.
1113 port: connection port for clients. Default 5222, which you probably
1114 shouldn't need to change.
1115 user: username for the client connection. Users will receive messages
1116 from 'user'@'server'.
1117 resource: a unique identifier for the connection to the server. This
1118 is actually used as a prefix for each XMPP component in the system.
1119 password: password for the user account.
1120 host: some XMPP domains are served by machines with a different
1121 hostname. (For example, @gmail.com GTalk users connect to
1122 talk.google.com). Set this to the correct hostname if that's the
1123 case with your server.
1124 encryption: Whether to encrypt the connection between StatusNet and the
1125 XMPP server. Defaults to true, but you can get
1126 considerably better performance turning it off if you're
1127 connecting to a server on the same machine or on a
1129 debug: if turned on, this will make the XMPP library blurt out all of
1130 the incoming and outgoing messages as XML stanzas. Use as a
1131 last resort, and never turn it on if you don't have queues
1132 enabled, since it will spit out sensitive data to the browser.
1133 public: an array of JIDs to send _all_ notices to. This is useful for
1134 participating in third-party search and archiving services.
1139 For configuring invites.
1141 enabled: Whether to allow users to send invites. Default true.
1146 Miscellaneous tagging stuff.
1148 dropoff: Decay factor for tag listing, in seconds.
1149 Defaults to exponential decay over ten days; you can twiddle
1150 with it to try and get better results for your site.
1155 Settings for the "popular" section of the site.
1157 dropoff: Decay factor for popularity listing, in seconds.
1158 Defaults to exponential decay over ten days; you can twiddle
1159 with it to try and get better results for your site.
1164 For daemon processes.
1166 piddir: directory that daemon processes should write their PID file
1167 (process ID) to. Defaults to /var/run/, which is where this
1168 stuff should usually go on Unix-ish systems.
1169 user: If set, the daemons will try to change their effective user ID
1170 to this user before running. Probably a good idea, especially if
1171 you start the daemons as root. Note: user name, like 'daemon',
1173 group: If set, the daemons will try to change their effective group ID
1174 to this named group. Again, a name, not a numerical ID.
1179 You can get a significant boost in performance by caching some
1180 database data in memcached <http://www.danga.com/memcached/>.
1182 enabled: Set to true to enable. Default false.
1183 server: a string with the hostname of the memcached server. Can also
1184 be an array of hostnames, if you've got more than one server.
1185 base: memcached uses key-value pairs to store data. We build long,
1186 funny-looking keys to make sure we don't have any conflicts. The
1187 base of the key is usually a simplified version of the site name
1188 (like "Identi.ca" => "identica"), but you can overwrite this if
1189 you need to. You can safely ignore it if you only have one
1190 StatusNet site using your memcached server.
1191 port: Port to connect to; defaults to 11211.
1198 enabled: Whether to enable post-by-email. Defaults to true. You will
1199 also need to set up maildaemon.php.
1204 For SMS integration.
1206 enabled: Whether to enable SMS integration. Defaults to true. Queues
1207 should also be enabled.
1212 A catch-all for integration with other systems.
1214 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1221 enabled: No longer used. If you set this to something other than true,
1222 StatusNet will no longer run.
1227 For notice-posting throttles.
1229 enabled: Whether to throttle posting. Defaults to false.
1230 count: Each user can make this many posts in 'timespan' seconds. So, if count
1231 is 100 and timespan is 3600, then there can be only 100 posts
1232 from a user every hour.
1233 timespan: see 'count'.
1240 biolimit: max character length of bio; 0 means no limit; null means to use
1241 the site text limit default.
1246 Options with new users.
1248 default: nickname of a user account to automatically subscribe new
1249 users to. Typically this would be system account for e.g.
1250 service updates or announcements. Users are able to unsub
1251 if they want. Default is null; no auto subscribe.
1252 welcome: nickname of a user account that sends welcome messages to new
1253 users. Can be the same as 'default' account, although on
1254 busy servers it may be a good idea to keep that one just for
1255 'urgent' messages. Default is null; no message.
1257 If either of these special user accounts are specified, the users should
1258 be created before the configuration is updated.
1263 The software will, by default, send statistical snapshots about the
1264 local installation to a stats server on the status.net Web site. This
1265 data is used by the developers to prioritize development decisions. No
1266 identifying data about users or organizations is collected. The data
1267 is available to the public for review. Participating in this survey
1268 helps StatusNet developers take your needs into account when updating
1271 run: string indicating when to run the statistics. Values can be 'web'
1272 (run occasionally at Web time), 'cron' (run from a cron script),
1273 or 'never' (don't ever run). If you set it to 'cron', remember to
1274 schedule the script to run on a regular basis.
1275 frequency: if run value is 'web', how often to report statistics.
1276 Measured in Web hits; depends on how active your site is.
1277 Default is 10000 -- that is, one report every 10000 Web hits,
1279 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1280 report system, but if they go evil or disappear you may
1281 need to update this to another value. Note: if you
1282 don't want to report stats, it's much better to
1283 set 'run' to 'never' than to set this value to something
1289 The software lets users upload files with their notices. You can configure
1290 the types of accepted files by mime types and a trio of quota options:
1291 per file, per user (total), per user per month.
1293 We suggest the use of the pecl file_info extension to handle mime type
1296 supported: an array of mime types you accept to store and distribute,
1297 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1298 setup your server to properly recognize the types you want to
1300 uploads: false to disable uploading files with notices (true by default).
1301 filecommand: The required MIME_Type library may need to use the 'file'
1302 command. It tries the one in the Web server's path, but if
1303 you're having problems with uploads, try setting this to the
1304 correct value. Note: 'file' must accept '-b' and '-i' options.
1306 For quotas, be sure you've set the upload_max_filesize and post_max_size
1307 in php.ini to be large enough to handle your upload. In httpd.conf
1308 (if you're using apache), check that the LimitRequestBody directive isn't
1309 set too low (it's optional, so it may not be there at all).
1311 file_quota: maximum size for a single file upload in bytes. A user can send
1312 any amount of notices with attachments as long as each attachment
1313 is smaller than file_quota.
1314 user_quota: total size in bytes a user can store on this server. Each user
1315 can store any number of files as long as their total size does
1316 not exceed the user_quota.
1317 monthly_quota: total size permitted in the current month. This is the total
1318 size in bytes that a user can upload each month.
1319 dir: directory accessible to the Web process where uploads should go.
1320 Defaults to the 'file' subdirectory of the install directory, which
1321 should be writeable by the Web user.
1322 server: server name to use when creating URLs for uploaded files.
1323 Defaults to null, meaning to use the default Web server. Using
1324 a virtual server here can speed up Web performance.
1325 path: URL path, relative to the server, to find files. Defaults to
1326 main path + '/file/'.
1327 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1328 guess based on other SSL settings.
1329 filecommand: command to use for determining the type of a file. May be
1330 skipped if fileinfo extension is installed. Defaults to
1336 Options for group functionality.
1338 maxaliases: maximum number of aliases a group can have. Default 3. Set
1339 to 0 or less to prevent aliases in a group.
1340 desclimit: maximum number of characters to allow in group descriptions.
1341 null (default) means to use the site-wide text limits. 0
1347 oEmbed endpoint for multimedia attachments (links in posts).
1349 endpoint: oohembed endpoint using http://oohembed.com/ software.
1354 Some stuff for search.
1356 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1357 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1358 but requires the lame old MyISAM engine for MySQL. The latter
1359 will work with InnoDB but could be miserably slow on large
1360 systems. We'll probably add another type sometime in the future,
1361 with our own indexing system (maybe like MediaWiki's).
1368 handle: boolean. Whether we should register our own PHP session-handling
1369 code (using the database and memcache if enabled). Defaults to false.
1370 Setting this to true makes some sense on large or multi-server
1371 sites, but it probably won't hurt for smaller ones, either.
1372 debug: whether to output debugging info for session storage. Can help
1373 with weird session bugs, sometimes. Default false.
1378 Users can upload backgrounds for their pages; this section defines
1381 server: the server to use for background. Using a separate (even
1382 virtual) server for this can speed up load times. Default is
1383 null; same as site server.
1384 dir: directory to write backgrounds too. Default is '/background/'
1385 subdir of install dir.
1386 path: path to backgrounds. Default is sub-path of install path; note
1387 that you may need to change this if you change site-path too.
1388 ssl: Whether or not to use HTTPS for background files. Defaults to
1389 null, meaning to guess from site-wide SSL settings.
1394 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1395 notify third-party servers of updates.
1397 notify: an array of URLs for ping endpoints. Default is the empty
1398 array (no notification).
1403 Default design (colors and background) for the site. Actual appearance
1404 depends on the theme. Null values mean to use the theme defaults.
1406 backgroundcolor: Hex color of the site background.
1407 contentcolor: Hex color of the content area background.
1408 sidebarcolor: Hex color of the sidebar background.
1409 textcolor: Hex color of all non-link text.
1410 linkcolor: Hex color of all links.
1411 backgroundimage: Image to use for the background.
1412 disposition: Flags for whether or not to tile the background image.
1417 Configuration options specific to notices.
1419 contentlimit: max length of the plain-text content of a notice.
1420 Default is null, meaning to use the site-wide text limit.
1426 Configuration options specific to messages.
1428 contentlimit: max length of the plain-text content of a message.
1429 Default is null, meaning to use the site-wide text limit.
1435 Configuration options for the login command.
1437 disabled: whether to enable this command. If enabled, users who send
1438 the text 'login' to the site through any channel will
1439 receive a link to login to the site automatically in return.
1440 Possibly useful for users who primarily use an XMPP or SMS
1441 interface and can't be bothered to remember their site
1442 password. Note that the security implications of this are
1443 pretty serious and have not been thoroughly tested. You
1444 should enable it only after you've convinced yourself that
1445 it is safe. Default is 'false'.
1450 If an installation has only one user, this can simplify a lot of the
1451 interface. It also makes the user's profile the root URL.
1453 enabled: Whether to run in "single user mode". Default false.
1454 nickname: nickname of the single user.
1459 We put out a default robots.txt file to guide the processing of
1460 Web crawlers. See http://www.robotstxt.org/ for more information
1461 on the format of this file.
1463 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1464 for the robots.txt file. see http://ur1.ca/l5a0
1465 for more information. Default is zero, no explicit delay.
1466 disallow: Array of (virtual) directories to disallow. Default is 'main',
1467 'search', 'message', 'settings', 'admin'. Ignored when site
1468 is private, in which case the entire site ('/') is disallowed.
1473 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1474 powerful plugin architecture. Important events in the code are named,
1475 like 'StartNoticeSave', and other software can register interest
1476 in those events. When the events happen, the other software is called
1477 and has a choice of accepting or rejecting the events.
1479 In the simplest case, you can add a function to config.php and use the
1480 Event::addHandler() function to hook an event:
1482 function AddGoogleLink($action)
1484 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1488 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1490 This adds a menu item to the end of the main navigation menu. You can
1491 see the list of existing events, and parameters that handlers must
1492 implement, in EVENTS.txt.
1494 The Plugin class in lib/plugin.php makes it easier to write more
1495 complex plugins. Sub-classes can just create methods named
1496 'onEventName', where 'EventName' is the name of the event (case
1497 matters!). These methods will be automatically registered as event
1498 handlers by the Plugin constructor (which you must call from your own
1499 class's constructor).
1501 Several example plugins are included in the plugins/ directory. You
1502 can enable a plugin with the following line in config.php:
1504 addPlugin('Example', array('param1' => 'value1',
1505 'param2' => 'value2'));
1507 This will look for and load files named 'ExamplePlugin.php' or
1508 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1509 plugins that ship with StatusNet) or in the local/ directory (for
1510 plugins you write yourself or that you get from somewhere else) or
1513 Plugins are documented in their own directories.
1518 The primary output for StatusNet is syslog, unless you configured a
1519 separate logfile. This is probably the first place to look if you're
1520 getting weird behaviour from StatusNet.
1522 If you're tracking the unstable version of StatusNet in the git
1523 repository (see below), and you get a compilation error ("unexpected
1524 T_STRING") in the browser, check to see that you don't have any
1525 conflicts in your code.
1527 If you upgraded to StatusNet 0.9.2 without reading the "Notice
1528 inboxes" section above, and all your users' 'Personal' tabs are empty,
1529 read the "Notice inboxes" section above.
1534 These are some myths you may see on the Web about StatusNet.
1535 Documentation from the core team about StatusNet has been pretty
1536 sparse, so some backtracking and guesswork resulted in some incorrect
1539 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1540 extremely bad idea. It's a tool built into DB_DataObject that will
1541 emit oodles of print lines directly to the browser of your users.
1542 Among these lines will be your database username and password. Do
1543 not enable this option on a production Web site for any reason.
1545 - "Edit dataobject.ini with the following settings..." dataobject.ini
1546 is a development file for the DB_DataObject framework and is not
1547 used by the running software. It was removed from the StatusNet
1548 distribution because its presence was confusing. Do not bother
1549 configuring dataobject.ini, and do not put your database username
1550 and password into the file on a production Web server; unscrupulous
1551 persons may try to read it to get your passwords.
1556 If you're adventurous or impatient, you may want to install the
1557 development version of StatusNet. To get it, use the git version
1558 control tool <http://git-scm.com/> like so:
1560 git clone git@gitorious.org:statusnet/mainline.git
1562 This is the version of the software that runs on Identi.ca and the
1563 status.net hosted service. Using it is a mixed bag. On the positive
1564 side, it usually includes the latest security and bug fix patches. On
1565 the downside, it may also include changes that require admin
1566 intervention (like running a script or even raw SQL!) that may not be
1567 documented yet. It may be a good idea to test this version before
1568 installing it on your production machines.
1570 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1575 There are several ways to get more information about StatusNet.
1577 * There is a mailing list for StatusNet developers and admins at
1578 http://mail.status.net/mailman/listinfo/statusnet-dev
1579 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1580 * The StatusNet wiki, http://status.net/wiki/
1581 * The StatusNet blog, http://status.net/blog/
1582 * The StatusNet status update, <http://status.status.net/> (!)
1587 * Microblogging messages to http://support.status.net/ are very welcome.
1588 * The microblogging group http://identi.ca/group/statusnet is a good
1589 place to discuss the software.
1590 * StatusNet has a bug tracker for any defects you may find, or ideas for
1591 making things better. http://status.net/bugs
1596 The following is an incomplete list of developers who've worked on
1597 StatusNet. Apologies for any oversight; please let evan@status.net know
1598 if anyone's been overlooked in error.
1600 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1601 * Zach Copley, StatusNet, Inc.
1602 * Earle Martin, StatusNet, Inc.
1603 * Marie-Claude Doyon, designer, StatusNet, Inc.
1604 * Sarven Capadisli, StatusNet, Inc.
1605 * Robin Millette, StatusNet, Inc.
1616 * Tryggvi Björgvinsson
1620 * Ken Sheppardson (Trac server, man-about-town)
1621 * Tiago 'gouki' Faria (i18n manager)
1623 * Leslie Michael Orchard
1627 * Tobias Diekershoff
1639 Thanks also to the developers of our upstream library code and to the
1640 thousands of people who have tried out Identi.ca, installed StatusNet,
1641 told their friends, and built the Open Microblogging network to what