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 CSS and images in the /theme/ directory are available under the
76 Creative Commons Attribution 3.0 Unported license, with attribution to
77 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
79 Our understanding and intention is that if you add your own theme that
80 uses only CSS and images, those files are not subject to the copyleft
81 requirements of the Affero General Public License 3.0. See
82 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
83 legal advice; consult your lawyer.
85 Additional library software has been made available in the 'extlib'
86 directory. All of it is Free Software and can be distributed under
87 liberal terms, but those terms may differ in detail from the AGPL's
88 particulars. See each package's license file in the extlib directory
94 This is a security, bug and feature release since version 0.9.3 released on
97 For best compatibility with client software and site federation, and a lot of
98 bug fixes, it is highly recommended that all public sites upgrade to the new
101 Notable changes this version:
103 - OpenID and OAuth libraries patched for potential timing attack
104 - OStatus feed i/o updated for Activity Streams
105 - Correctness fixes on XRD, other discovery bits
106 - Support for contacting SNI-based SSL virtual hosts when SSL
107 certificate verification is enabled (requires PHP 5.3.2+ or
108 enabling CURL backend with $config['http']['curl'] = true)
109 - Experimental SubMirror plugin
110 - Multi-site status_network table mode has been tweaked to support
112 - Many updates to user interface translation from TranslateWiki
113 - Many other bugfixes
115 A full changelog is available at http://status.net/wiki/StatusNet_0.9.4.
120 The following software packages are *required* for this software to
123 - PHP 5.2.3+. It may be possible to run this software on earlier
124 versions of PHP, but many of the functions used are only available
125 in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
126 daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
127 release, but problems with some plugins are possible.
128 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
129 server. It has been primarily tested on 5.x servers, although it may
130 be possible to install on earlier (or later!) versions. The server
131 *must* support the MyISAM storage engine -- the default for most
132 MySQL servers -- *and* the InnoDB storage engine.
133 - A Web server. Preferably, you should have Apache 2.2.x with the
134 mod_rewrite extension installed and enabled.
136 Your PHP installation must include the following PHP extensions:
138 - Curl. This is for fetching files by HTTP.
139 - XMLWriter. This is for formatting XML and HTML output.
140 - MySQL. For accessing the database.
141 - GD. For scaling down avatar images.
142 - mbstring. For handling Unicode (UTF-8) encoded strings.
144 For some functionality, you will also need the following extensions:
146 - Memcache. A client for the memcached server, which caches database
147 information in volatile memory. This is important for adequate
148 performance on high-traffic sites. You will also need a memcached
149 server to store the data in.
150 - Mailparse. Efficient parsing of email requires this extension.
151 Submission by email or SMS-over-email uses this extension.
152 - Sphinx Search. A client for the sphinx server, an alternative
153 to MySQL or Postgresql fulltext search. You will also need a
154 Sphinx server to serve the search queries.
155 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
156 if you have OStatus configured.
157 - gettext. For multiple languages. Default on many PHP installs;
158 will be emulated if not present.
160 You will almost definitely get 2-3 times better performance from your
161 site if you install a PHP bytecode cache/accelerator. Some well-known
162 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
163 is a proprietary accelerator installed on some hosting sites.
168 A number of external PHP libraries are used to provide basic
169 functionality and optional functionality for your system. For your
170 convenience, they are available in the "extlib" directory of this
171 package, and you do not have to download and install them. However,
172 you may want to keep them up-to-date with the latest upstream version,
173 and the URLs are listed here for your convenience.
175 - DB_DataObject http://pear.php.net/package/DB_DataObject
176 - Validate http://pear.php.net/package/Validate
177 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
178 to use the openidenabled.com version since it's more widely
179 implemented, and seems to be better supported.
180 http://openidenabled.com/php-openid/
181 - PEAR DB. Although this is an older data access system (new
182 packages should probably use PHP DBO), the OpenID libraries
183 depend on PEAR DB so we use it here, too. DB_DataObject can
184 also use PEAR MDB2, which may give you better performance
185 but won't work with OpenID.
186 http://pear.php.net/package/DB
187 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
188 - markdown.php from http://michelf.com/projects/php-markdown/
189 - PEAR Mail, for sending out mail notifications
190 http://pear.php.net/package/Mail
191 - PEAR Net_SMTP, if you use the SMTP factory for notifications
192 http://pear.php.net/package/Net_SMTP
193 - PEAR Net_Socket, if you use the SMTP factory for notifications
194 http://pear.php.net/package/Net_Socket
195 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
196 library available for PHP. http://xmpphp.googlecode.com/. Note that
197 as of this writing the version of this library that is available in
198 the extlib directory is *significantly different* from the upstream
199 version (patches have been submitted). Upgrading to the upstream
200 version may render your StatusNet site unable to send or receive XMPP
202 - Facebook library. Used for the Facebook application.
203 - PEAR Services_oEmbed. Used for some multimedia integration.
204 - PEAR HTTP_Request is an oEmbed dependency.
205 - PEAR Validate is an oEmbed dependency.
206 - PEAR Net_URL2 is an oEmbed dependency.
207 - Console_GetOpt for parsing command-line options.
208 - libomb. a library for implementing OpenMicroBlogging 0.1, the
209 predecessor to OStatus.
210 - HTTP_Request2, a library for making HTTP requests.
212 A design goal of StatusNet is that the basic Web functionality should
213 work on even the most restrictive commercial hosting services.
214 However, additional functionality, such as receiving messages by
215 Jabber/GTalk, require that you be able to run long-running processes
216 on your account. In addition, posting by email or from SMS require
217 that you be able to install a mail filter in your mail server.
222 Installing the basic StatusNet Web component is relatively easy,
223 especially if you've previously installed PHP/MySQL packages.
225 1. Unpack the tarball you downloaded on your Web server. Usually a
226 command like this will work:
228 tar zxf statusnet-0.9.4.tar.gz
230 ...which will make a statusnet-0.9.2 subdirectory in your current
231 directory. (If you don't have shell access on your Web server, you
232 may have to unpack the tarball on your local computer and FTP the
233 files to the server.)
235 2. Move the tarball to a directory of your choosing in your Web root
236 directory. Usually something like this will work:
238 mv statusnet-0.9.4 /var/www/statusnet
240 This will make your StatusNet instance available in the statusnet path of
241 your server, like "http://example.net/statusnet". "microblog" or
242 "statusnet" might also be good path names. If you know how to
243 configure virtual hosts on your web server, you can try setting up
244 "http://micro.example.net/" or the like.
246 3. Make your target directory writeable by the Web server.
248 chmod a+w /var/www/statusnet/
250 On some systems, this will probably work:
252 chgrp www-data /var/www/statusnet/
253 chmod g+w /var/www/statusnet/
255 If your Web server runs as another user besides "www-data", try
256 that user's default group instead. As a last resort, you can create
257 a new group like "statusnet" and add the Web server's user to the group.
259 4. You should also take this moment to make your avatar, background, and
260 file subdirectories writeable by the Web server. An insecure way to do
263 chmod a+w /var/www/statusnet/avatar
264 chmod a+w /var/www/statusnet/background
265 chmod a+w /var/www/statusnet/file
267 You can also make the avatar, background, and file directories
268 writeable by the Web server group, as noted above.
270 5. Create a database to hold your microblog data. Something like this
273 mysqladmin -u "username" --password="password" create statusnet
275 Note that StatusNet must have its own database; you can't share the
276 database with another program. You can name it whatever you want,
279 (If you don't have shell access to your server, you may need to use
280 a tool like PHPAdmin to create a database. Check your hosting
281 service's documentation for how to create a new MySQL database.)
283 6. Create a new database account that StatusNet will use to access the
284 database. If you have shell access, this will probably work from the
287 GRANT ALL on statusnet.*
288 TO 'statusnetuser'@'localhost'
289 IDENTIFIED BY 'statusnetpassword';
291 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
292 username and password. You may want to test logging in to MySQL as
295 7. In a browser, navigate to the StatusNet install script; something like:
297 http://yourserver.example.com/statusnet/install.php
299 Enter the database connection information and your site name. The
300 install program will configure your site and install the initial,
301 almost-empty database.
303 8. You should now be able to navigate to your microblog's main directory
304 and see the "Public Timeline", which will be empty. If not, magic
305 has happened! You can now register a new user, post some notices,
306 edit your profile, etc. However, you may want to wait to do that stuff
307 if you think you can set up "fancy URLs" (see below), since some
308 URLs are stored in the database.
313 By default, StatusNet will use URLs that include the main PHP program's
314 name in them. For example, a user's home profile might be
317 http://example.org/statusnet/index.php/statusnet/fred
319 On certain systems that don't support this kind of syntax, they'll
322 http://example.org/statusnet/index.php?p=statusnet/fred
324 It's possible to configure the software so it looks like this instead:
326 http://example.org/statusnet/fred
328 These "fancy URLs" are more readable and memorable for users. To use
329 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
330 mod_rewrite enabled, -OR- know how to configure "url redirection" in
333 1. Copy the htaccess.sample file to .htaccess in your StatusNet
334 directory. Note: if you have control of your server's httpd.conf or
335 similar configuration files, it can greatly improve performance to
336 import the .htaccess file into your conf file instead. If you're
337 not sure how to do it, you may save yourself a lot of headache by
338 just leaving the .htaccess file.
340 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
341 to your StatusNet installation on your server. Typically this will
342 be the path to your StatusNet directory relative to your Web root.
344 3. Add or uncomment or change a line in your config.php file so it says:
346 $config['site']['fancy'] = true;
348 You should now be able to navigate to a "fancy" URL on your server,
351 http://example.net/statusnet/main/register
353 If you changed your HTTP server configuration, you may need to restart
356 If it doesn't work, double-check that AllowOverride for the StatusNet
357 directory is 'All' in your Apache configuration file. This is usually
358 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
359 /etc/apache2/sites-available/default. See the Apache documentation for
360 .htaccess files for more details:
362 http://httpd.apache.org/docs/2.2/howto/htaccess.html
364 Also, check that mod_rewrite is installed and enabled:
366 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
371 To use a Sphinx server to search users and notices, you'll need to
372 enable the SphinxSearch plugin. Add to your config.php:
374 addPlugin('SphinxSearch');
375 $config['sphinx']['server'] = 'searchhost.local';
377 You also need to install, compile and enable the sphinx pecl extension for
378 php on the client side, which itself depends on the sphinx development files.
380 See plugins/SphinxSearch/README for more details and server setup.
385 StatusNet supports a cheap-and-dirty system for sending update messages
386 to mobile phones and for receiving updates from the mobile. Instead of
387 sending through the SMS network itself, which is costly and requires
388 buy-in from the wireless carriers, it simply piggybacks on the email
389 gateways that many carriers provide to their customers. So, SMS
390 configuration is essentially email configuration.
392 Each user sends to a made-up email address, which they keep a secret.
393 Incoming email that is "From" the user's SMS email address, and "To"
394 the users' secret email address on the site's domain, will be
395 converted to a notice and stored in the DB.
397 For this to work, there *must* be a domain or sub-domain for which all
398 (or most) incoming email can pass through the incoming mail filter.
400 1. Run the SQL script carrier.sql in your StatusNet database. This will
403 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
405 This will populate your database with a list of wireless carriers
406 that support email SMS gateways.
408 2. Make sure the maildaemon.php file is executable:
410 chmod +x scripts/maildaemon.php
412 Note that "daemon" is kind of a misnomer here; the script is more
413 of a filter than a daemon.
415 2. Edit /etc/aliases on your mail server and add the following line:
417 *: /path/to/statusnet/scripts/maildaemon.php
419 3. Run whatever code you need to to update your aliases database. For
420 many mail servers (Postfix, Exim, Sendmail), this should work:
424 You may need to restart your mail server for the new database to
427 4. Set the following in your config.php file:
429 $config['mail']['domain'] = 'yourdomain.example.net';
431 At this point, post-by-email and post-by-SMS-gateway should work. Note
432 that if your mail server is on a different computer from your email
433 server, you'll need to have a full installation of StatusNet, a working
434 config.php, and access to the StatusNet database from the mail server.
439 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
440 instant-messenger protocol that drives Jabber and GTalk IM. You can
441 distribute messages via XMPP using the system below; however, you
442 need to run the XMPP incoming daemon to allow incoming messages as
445 1. You may want to strongly consider setting up your own XMPP server.
446 Ejabberd, OpenFire, and JabberD are all Open Source servers.
447 Jabber, Inc. provides a high-performance commercial server.
449 2. You must register a Jabber ID (JID) with your new server. It helps
450 to choose a name like "update@example.com" or "notice" or something
451 similar. Alternately, your "update JID" can be registered on a
452 publicly-available XMPP service, like jabber.org or GTalk.
454 StatusNet will not register the JID with your chosen XMPP server;
455 you need to do this manually, with an XMPP client like Gajim,
456 Telepathy, or Pidgin.im.
458 3. Configure your site's XMPP variables, as described below in the
459 configuration section.
461 On a default installation, your site can broadcast messages using
462 XMPP. Users won't be able to post messages using XMPP unless you've
463 got the XMPP daemon running. See 'Queues and daemons' below for how
464 to set that up. Also, once you have a sizable number of users, sending
465 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
466 can really slow down your site; it may cause posting to timeout.
468 NOTE: stream_select(), a crucial function for network programming, is
469 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
470 work around this bug in StatusNet; current recommendation is to move
471 off of amd64 to another server.
476 You can send *all* messages from your microblogging site to a
477 third-party service using XMPP. This can be useful for providing
478 search, indexing, bridging, or other cool services.
480 To configure a downstream site to receive your public stream, add
481 their "JID" (Jabber ID) to your config.php as follows:
483 $config['xmpp']['public'][] = 'downstream@example.net';
485 (Don't miss those square brackets at the end.) Note that your XMPP
486 broadcasting must be configured as mentioned above. Although you can
487 send out messages at "Web time", high-volume sites should strongly
488 consider setting up queues and daemons.
493 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
494 and XMPP messages, can be 'queued' and done by off-line bots instead.
495 For this to work, you must be able to run long-running offline
496 processes, either on your main Web server or on another server you
497 control. (Your other server will still need all the above
498 prerequisites, with the exception of Apache.) Installing on a separate
499 server is probably a good idea for high-volume sites.
501 1. You'll need the "CLI" (command-line interface) version of PHP
502 installed on whatever server you use.
504 2. If you're using a separate server for queues, install StatusNet
505 somewhere on the server. You don't need to worry about the
506 .htaccess file, but make sure that your config.php file is close
507 to, or identical to, your Web server's version.
509 3. In your config.php files (both the Web server and the queues
510 server!), set the following variable:
512 $config['queue']['enabled'] = true;
514 You may also want to look at the 'daemon' section of this file for
515 more daemon options. Note that if you set the 'user' and/or 'group'
516 options, you'll need to create that user and/or group by hand.
517 They're not created automatically.
519 4. On the queues server, run the command scripts/startdaemons.sh.
521 This will run the queue handlers:
523 * queuedaemon.php - polls for queued items for inbox processing and
524 pushing out to OStatus, SMS, XMPP, etc.
525 * xmppdaemon.php - listens for new XMPP messages from users and stores
526 them as notices in the database; also pulls queued XMPP output from
527 queuedaemon.php to push out to clients.
529 These two daemons will automatically restart in most cases of failure
530 including memory leaks (if a memory_limit is set), but may still die
531 or behave oddly if they lose connections to the XMPP or queue servers.
533 Additional daemons may be also started by this script for certain
534 plugins, such as the Twitter bridge.
536 It may be a good idea to use a daemon-monitoring service, like 'monit',
537 to check their status and keep them running.
539 All the daemons write their process IDs (pids) to /var/run/ by
540 default. This can be useful for starting, stopping, and monitoring the
543 Since version 0.8.0, it's now possible to use a STOMP server instead of
544 our kind of hacky home-grown DB-based queue solution. This is strongly
545 recommended for best response time, especially when using XMPP.
547 See the "queues" config section below for how to configure to use STOMP.
548 As of this writing, the software has been tested with ActiveMQ 5.3.
553 There are two themes shipped with this version of StatusNet: "identica",
554 which is what the Identi.ca site uses, and "default", which is a good
555 basis for other sites.
557 As of right now, your ability to change the theme is site-wide; users
558 can't choose their own theme. Additionally, the only thing you can
559 change in the theme is CSS stylesheets and some image files; you can't
560 change the HTML output, like adding or removing menu items.
562 You can choose a theme using the $config['site']['theme'] element in
563 the config.php file. See below for details.
565 You can add your own theme by making a sub-directory of the 'theme'
566 subdirectory with the name of your theme. Each theme can have the
569 display.css: a CSS2 file for "default" styling for all browsers.
570 ie6.css: a CSS2 file for override styling for fixing up Internet
572 ie7.css: a CSS2 file for override styling for fixing up Internet
574 logo.png: a logo image for the site.
575 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
576 users who don't upload their own.
577 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
578 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
579 listing on profile pages.
581 You may want to start by copying the files from the default theme to
584 NOTE: the HTML generated by StatusNet changed *radically* between
585 version 0.6.x and 0.7.x. Older themes will need signification
586 modification to use the new output format.
591 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
592 Theoretically, you can add your own sub-directory to the locale/
593 subdirectory to add a new language to your system. You'll need to
594 compile the ".po" files into ".mo" files, however.
596 Contributions of translation information to StatusNet are very easy:
597 you can use the Web interface at TranslateWiki.net to add one
598 or a few or lots of new translations -- or even new languages. You can
599 also download more up-to-date .po files there, if you so desire.
601 For info on helping with translations, see http://status.net/wiki/Translations
606 There is no built-in system for doing backups in StatusNet. You can make
607 backups of a working StatusNet system by backing up the database and
608 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
609 and to backup the Web directory, try tar.
614 The administrator can set the "private" flag for a site so that it's
615 not visible to non-logged-in users. This might be useful for
616 workgroups who want to share a microblogging site for project
617 management, but host it on a public server.
619 Total privacy is not guaranteed or ensured. Also, privacy is
620 all-or-nothing for a site; you can't have some accounts or notices
621 private, and others public. The interaction of private sites
622 with OStatus is undefined.
624 Access to file attachments can also be restricted to logged-in users only.
625 1. Add a directory outside the web root where your file uploads will be
626 stored. Usually a command like this will work:
628 mkdir /var/www/statusnet-files
630 2. Make the file uploads directory writeable by the web server. An
631 insecure way to do this is:
633 chmod a+x /var/www/statusnet-files
635 3. Tell StatusNet to use this directory for file uploads. Add a line
636 like this to your config.php:
638 $config['attachments']['dir'] = '/var/www/statusnet-files';
643 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
644 incorrectly-stored international characters ("UTF-8"). For new
645 installations, it will now store non-ASCII characters correctly.
646 However, older installations will have the incorrect storage, and will
647 consequently show up "wrong" in browsers. See below for how to deal
650 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
651 been tracking the "git" version of the software, you will probably
652 want to upgrade and keep your existing data. There is no automated
653 upgrade procedure in StatusNet 0.9.2. Try these step-by-step
654 instructions; read to the end first before trying them.
656 0. Download StatusNet and set up all the prerequisites as if you were
658 1. Make backups of both your database and your Web directory. UNDER NO
659 CIRCUMSTANCES should you try to do an upgrade without a known-good
660 backup. You have been warned.
661 2. Shut down Web access to your site, either by turning off your Web
662 server or by redirecting all pages to a "sorry, under maintenance"
664 3. Shut down XMPP access to your site, typically by shutting down the
665 xmppdaemon.php process and all other daemons that you're running.
666 If you've got "monit" or "cron" automatically restarting your
667 daemons, make sure to turn that off, too.
668 4. Shut down SMS and email access to your site. The easy way to do
669 this is to comment out the line piping incoming email to your
670 maildaemon.php file, and running something like "newaliases".
671 5. Once all writing processes to your site are turned off, make a
672 final backup of the Web directory and database.
673 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
674 7. Unpack your StatusNet 0.9.2 tarball and move it to "statusnet" or
675 wherever your code used to be.
676 8. Copy the config.php file and avatar directory from your old
677 directory to your new directory.
678 9. Copy htaccess.sample to .htaccess in the new directory. Change the
679 RewriteBase to use the correct path.
680 10. Rebuild the database. (You can safely skip this step and go to #12
681 if you're upgrading from another 0.9.x version).
683 NOTE: this step is destructive and cannot be
684 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
685 do it without a known-good backup!
687 If your database is at version 0.8.0 or above, you can run a
688 special upgrade script:
690 mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
692 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
693 BACKUP run the rebuilddb.sh script like this:
695 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
697 Here, rootuser and rootpassword are the username and password for a
698 user who can drop and create databases as well as tables; typically
699 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
700 your database and rebuilds it; if there is an error you have no
701 database. Make sure you have a backup.
702 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
703 which operates slightly differently. Read the documentation in that
704 script before running it.
705 11. Use mysql or psql client to log into your database and make sure that
706 the notice, user, profile, subscription etc. tables are non-empty.
707 12. Turn back on the Web server, and check that things still work.
708 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
709 bots have changed since version 0.5; see above for details.
711 If you're upgrading from very old versions, you may want to look at
712 the fixup_* scripts in the scripts directories. These will store some
713 precooked data in the DB. All upgraders should check out the inboxes
716 NOTE: the database definition file, laconica.ini, has been renamed to
717 statusnet.ini (since this is the recommended database name). If you
718 have a line in your config.php pointing to the old name, you'll need
724 Notice inboxes are now required. If you don't have inboxes enabled,
725 StatusNet will no longer run.
730 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
731 international characters ("UTF-8"). This fix is not
732 backwards-compatible; installations from before 0.7.4 will show
733 non-ASCII characters of old notices incorrectly. This section explains
736 0. You can disable the new behaviour by setting the 'db''utf8' config
737 option to "false". You should only do this until you're ready to
738 convert your DB to the new format.
739 1. When you're ready to convert, you can run the fixup_utf8.php script
740 in the scripts/ subdirectory. If you've had the "new behaviour"
741 enabled (probably a good idea), you can give the ID of the first
742 "new" notice as a parameter, and only notices before that one will
743 be converted. Notices are converted in reverse chronological order,
744 so the most recent (and visible) ones will be converted first. The
745 script should work whether or not you have the 'db''utf8' config
747 2. When you're ready, set $config['db']['utf8'] to true, so that
748 new notices will be stored correctly.
750 Configuration options
751 =====================
753 The main configuration file for StatusNet (excepting configurations for
754 dependency software) is config.php in your StatusNet directory. If you
755 edit any other file in the directory, like lib/default.php (where most
756 of the defaults are defined), you will lose your configuration options
757 in any upgrade, and you will wish that you had been more careful.
759 Starting with version 0.9.0, a Web based configuration panel has been
760 added to StatusNet. The preferred method for changing config options is
763 A command-line script, setconfig.php, can be used to set individual
764 configuration options. It's in the scripts/ directory.
766 Starting with version 0.7.1, you can put config files in the
767 /etc/statusnet/ directory on your server, if it exists. Config files
768 will be included in this order:
770 * /etc/statusnet/statusnet.php - server-wide config
771 * /etc/statusnet/<servername>.php - for a virtual host
772 * /etc/statusnet/<servername>_<pathname>.php - for a path
773 * INSTALLDIR/config.php - for a particular implementation
775 Almost all configuration options are made through a two-dimensional
776 associative array, cleverly named $config. A typical configuration
779 $config['section']['option'] = value;
781 For brevity, the following documentation describes each section and
787 This section is a catch-all for site-wide variables.
789 name: the name of your site, like 'YourCompany Microblog'.
790 server: the server part of your site's URLs, like 'example.net'.
791 path: The path part of your site's URLs, like 'statusnet' or ''
793 fancy: whether or not your site uses fancy URLs (see Fancy URLs
794 section above). Default is false.
795 logfile: full path to a file for StatusNet to save logging
796 information to. You may want to use this if you don't have
798 logdebug: whether to log additional debug info like backtraces on
799 hard errors. Default false.
800 locale_path: full path to the directory for locale data. Unless you
801 store all your locale data in one place, you probably
802 don't need to use this.
803 language: default language for your site. Defaults to US English.
804 Note that this is overridden if a user is logged in and has
805 selected a different language. It is also overridden if the
806 user is NOT logged in, but their browser requests a different
807 langauge. Since pretty much everybody's browser requests a
808 language, that means that changing this setting has little or
809 no effect in practice.
810 languages: A list of languages supported on your site. Typically you'd
811 only change this if you wanted to disable support for one
813 "unset($config['site']['languages']['de'])" will disable
815 theme: Theme for your site (see Theme section). Two themes are
816 provided by default: 'default' and 'stoica' (the one used by
817 Identi.ca). It's appreciated if you don't use the 'stoica' theme
818 except as the basis for your own.
819 email: contact email address for your site. By default, it's extracted
820 from your Web server environment; you may want to customize it.
821 broughtbyurl: name of an organization or individual who provides the
822 service. Each page will include a link to this name in the
823 footer. A good way to link to the blog, forum, wiki,
824 corporate portal, or whoever is making the service available.
825 broughtby: text used for the "brought by" link.
826 timezone: default timezone for message display. Users can set their
827 own time zone. Defaults to 'UTC', which is a pretty good default.
828 closed: If set to 'true', will disallow registration on your site.
829 This is a cheap way to restrict accounts to only one
830 individual or group; just register the accounts you want on
831 the service, *then* set this variable to 'true'.
832 inviteonly: If set to 'true', will only allow registration if the user
833 was invited by an existing user.
834 private: If set to 'true', anonymous users will be redirected to the
835 'login' page. Also, API methods that normally require no
836 authentication will require it. Note that this does not turn
837 off registration; use 'closed' or 'inviteonly' for the
839 notice: A plain string that will appear on every page. A good place
840 to put introductory information about your service, or info about
841 upgrades and outages, or other community info. Any HTML will
843 logo: URL of an image file to use as the logo for the site. Overrides
844 the logo in the theme, if any.
845 ssl: Whether to use SSL and https:// URLs for some or all pages.
846 Possible values are 'always' (use it for all pages), 'never'
847 (don't use it for any pages), or 'sometimes' (use it for
848 sensitive pages that include passwords like login and registration,
849 but not for regular pages). Default to 'never'.
850 sslserver: use an alternate server name for SSL URLs, like
851 'secure.example.org'. You should be careful to set cookie
852 parameters correctly so that both the SSL server and the
853 "normal" server can access the session cookie and
854 preferably other cookies as well.
855 shorturllength: Length of URL at which URLs in a message exceeding 140
856 characters will be sent to the user's chosen
858 dupelimit: minimum time allowed for one person to say the same thing
859 twice. Default 60s. Anything lower is considered a user
861 textlimit: default max size for texts in the site. Defaults to 140.
862 0 means no limit. Can be fine-tuned for notices, messages,
863 profile bios and group descriptions.
868 This section is a reference to the configuration options for
869 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
870 set are listed below for clarity.
872 database: a DSN (Data Source Name) for your StatusNet database. This is
873 in the format 'protocol://username:password@hostname/databasename',
874 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
875 really know what you're doing), 'username' is the username,
876 'password' is the password, and etc.
877 ini_yourdbname: if your database is not named 'statusnet', you'll need
878 to set this to point to the location of the
879 statusnet.ini file. Note that the real name of your database
880 should go in there, not literally 'yourdbname'.
881 db_driver: You can try changing this to 'MDB2' to use the other driver
882 type for DB_DataObject, but note that it breaks the OpenID
883 libraries, which only support PEAR::DB.
884 debug: On a database error, you may get a message saying to set this
885 value to 5 to see debug messages in the browser. This breaks
886 just about all pages, and will also expose the username and
888 quote_identifiers: Set this to true if you're using postgresql.
889 type: either 'mysql' or 'postgresql' (used for some bits of
890 database-type-specific SQL in the code). Defaults to mysql.
891 mirror: you can set this to an array of DSNs, like the above
892 'database' value. If it's set, certain read-only actions will
893 use a random value out of this array for the database, rather
894 than the one in 'database' (actually, 'database' is overwritten).
895 You can offload a busy DB server by setting up MySQL replication
896 and adding the slaves to this array. Note that if you want some
897 requests to go to the 'database' (master) server, you'll need
898 to include it in this array, too.
899 utf8: whether to talk to the database in UTF-8 mode. This is the default
900 with new installations, but older sites may want to turn it off
901 until they get their databases fixed up. See "UTF-8 database"
903 schemacheck: when to let plugins check the database schema to add
904 tables or update them. Values can be 'runtime' (default)
905 or 'script'. 'runtime' can be costly (plugins check the
906 schema on every hit, adding potentially several db
907 queries, some quite long), but not everyone knows how to
908 run a script. If you can, set this to 'script' and run
909 scripts/checkschema.php whenever you install or upgrade a
915 By default, StatusNet sites log error messages to the syslog facility.
916 (You can override this using the 'logfile' parameter described above).
918 appname: The name that StatusNet uses to log messages. By default it's
919 "statusnet", but if you have more than one installation on the
920 server, you may want to change the name for each instance so
921 you can track log messages more easily.
922 priority: level to log at. Currently ignored.
923 facility: what syslog facility to used. Defaults to LOG_USER, only
924 reset if you know what syslog is and have a good reason
930 You can configure the software to queue time-consuming tasks, like
931 sending out SMS email or XMPP messages, for off-line processing. See
932 'Queues and daemons' above for how to set this up.
934 enabled: Whether to uses queues. Defaults to false.
935 subsystem: Which kind of queueserver to use. Values include "db" for
936 our hacked-together database queuing (no other server
937 required) and "stomp" for a stomp server.
938 stomp_server: "broker URI" for stomp server. Something like
939 "tcp://hostname:61613". More complicated ones are
940 possible; see your stomp server's documentation for
942 queue_basename: a root name to use for queues (stomp only). Typically
943 something like '/queue/sitename/' makes sense. If running
944 multiple instances on the same server, make sure that
945 either this setting or $config['site']['nickname'] are
946 unique for each site to keep them separate.
948 stomp_username: username for connecting to the stomp server; defaults
950 stomp_password: password for connecting to the stomp server; defaults
953 stomp_persistent: keep items across queue server restart, if enabled.
954 Under ActiveMQ, the server configuration determines if and how
955 persistent storage is actually saved.
957 If using a message queue server other than ActiveMQ, you may
958 need to disable this if it does not support persistence.
960 stomp_transactions: use transactions to aid in error detection.
961 A broken transaction will be seen quickly, allowing a message
962 to be redelivered immediately if a daemon crashes.
964 If using a message queue server other than ActiveMQ, you may
965 need to disable this if it does not support transactions.
967 stomp_acks: send acknowledgements to aid in flow control.
968 An acknowledgement of successful processing tells the server
969 we're ready for more and can help keep things moving smoothly.
971 This should *not* be turned off when running with ActiveMQ, but
972 if using another message queue server that does not support
973 acknowledgements you might need to disable this.
975 softlimit: an absolute or relative "soft memory limit"; daemons will
976 restart themselves gracefully when they find they've hit
977 this amount of memory usage. Defaults to 90% of PHP's global
978 memory_limit setting.
980 inboxes: delivery of messages to receiver's inboxes can be delayed to
981 queue time for best interactive performance on the sender.
982 This may however be annoyingly slow when using the DB queues,
983 so you can set this to false if it's causing trouble.
985 breakout: for stomp, individual queues are by default grouped up for
986 best scalability. If some need to be run by separate daemons,
987 etc they can be manually adjusted here.
989 Default will share all queues for all sites within each group.
990 Specify as <group>/<queue> or <group>/<queue>/<site>,
991 using nickname identifier as site.
993 'main/distrib' separate "distrib" queue covering all sites
994 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
996 max_retries: for stomp, drop messages after N failed attempts to process.
999 dead_letter_dir: for stomp, optional directory to dump data on failed
1000 queue processing events after discarding them.
1002 stomp_no_transactions: for stomp, the server does not support transactions,
1003 so do not try to user them. This is needed for http://www.morbidq.com/.
1005 stomp_no_acks: for stomp, the server does not support acknowledgements.
1006 so do not try to user them. This is needed for http://www.morbidq.com/.
1011 The default license to use for your users notices. The default is the
1012 Creative Commons Attribution 3.0 license, which is probably the right
1013 choice for any public site. Note that some other servers will not
1014 accept notices if you apply a stricter license than this.
1016 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1017 (default copyright), or 'private' (for private and confidential
1019 owner: for 'allrightsreserved' or 'private', an assigned copyright
1020 holder (for example, an employer for a private site). If
1021 not specified, will be attributed to 'contributors'.
1022 url: URL of the license, used for links.
1023 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1024 image: A button shown on each page for the license.
1029 This is for configuring out-going email. We use PEAR's Mail module,
1030 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1032 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1033 'smtp'. Defaults to PEAR's default, 'mail'.
1034 params: if the mail backend requires any parameters, you can provide
1035 them in an associative array.
1040 This is for configuring nicknames in the service.
1042 blacklist: an array of strings for usernames that may not be
1043 registered. A default array exists for strings that are
1044 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1045 but you may want to add others if you have other software
1046 installed in a subdirectory of StatusNet or if you just
1047 don't want certain words used as usernames.
1048 featured: an array of nicknames of 'featured' users of the site.
1049 Can be useful to draw attention to well-known users, or
1050 interesting people, or whatever.
1055 For configuring avatar access.
1057 dir: Directory to look for avatar files and to put them into.
1058 Defaults to avatar subdirectory of install directory; if
1059 you change it, make sure to change path, too.
1060 path: Path to avatars. Defaults to path for avatar subdirectory,
1061 but you can change it if you wish. Note that this will
1062 be included with the avatar server, too.
1063 server: If set, defines another server where avatars are stored in the
1064 root directory. Note that the 'avatar' subdir still has to be
1065 writeable. You'd typically use this to split HTTP requests on
1066 the client to speed up page loading, either with another
1067 virtual server or with an NFS or SAMBA share. Clients
1068 typically only make 2 connections to a single server at a
1069 time <http://ur1.ca/6ih>, so this can parallelize the job.
1071 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1072 to guess based on site-wide SSL settings.
1077 For configuring the public stream.
1079 localonly: If set to true, only messages posted by users of this
1080 service (rather than other services, filtered through OMB)
1081 are shown in the public stream. Default true.
1082 blacklist: An array of IDs of users to hide from the public stream.
1083 Useful if you have someone making excessive Twitterfeed posts
1084 to the site, other kinds of automated posts, testing bots, etc.
1085 autosource: Sources of notices that are from automatic posters, and thus
1086 should be kept off the public timeline. Default empty.
1091 server: Like avatars, you can speed up page loading by pointing the
1092 theme file lookup to another server (virtual or real).
1093 Defaults to NULL, meaning to use the site server.
1094 dir: Directory where theme files are stored. Used to determine
1095 whether to show parts of a theme file. Defaults to the theme
1096 subdirectory of the install directory.
1097 path: Path part of theme URLs, before the theme name. Relative to the
1098 theme server. It may make sense to change this path when upgrading,
1099 (using version numbers as the path) to make sure that all files are
1100 reloaded by caching clients or proxies. Defaults to null,
1101 which means to use the site path + '/theme'.
1102 ssl: Whether to use SSL for theme elements. Default is null, which means
1103 guess based on site SSL settings.
1108 server: You can speed up page loading by pointing the
1109 theme file lookup to another server (virtual or real).
1110 Defaults to NULL, meaning to use the site server.
1111 path: Path part of Javascript URLs. Defaults to null,
1112 which means to use the site path + '/js/'.
1113 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1114 guess based on site SSL settings.
1119 For configuring the XMPP sub-system.
1121 enabled: Whether to accept and send messages by XMPP. Default false.
1122 server: server part of XMPP ID for update user.
1123 port: connection port for clients. Default 5222, which you probably
1124 shouldn't need to change.
1125 user: username for the client connection. Users will receive messages
1126 from 'user'@'server'.
1127 resource: a unique identifier for the connection to the server. This
1128 is actually used as a prefix for each XMPP component in the system.
1129 password: password for the user account.
1130 host: some XMPP domains are served by machines with a different
1131 hostname. (For example, @gmail.com GTalk users connect to
1132 talk.google.com). Set this to the correct hostname if that's the
1133 case with your server.
1134 encryption: Whether to encrypt the connection between StatusNet and the
1135 XMPP server. Defaults to true, but you can get
1136 considerably better performance turning it off if you're
1137 connecting to a server on the same machine or on a
1139 debug: if turned on, this will make the XMPP library blurt out all of
1140 the incoming and outgoing messages as XML stanzas. Use as a
1141 last resort, and never turn it on if you don't have queues
1142 enabled, since it will spit out sensitive data to the browser.
1143 public: an array of JIDs to send _all_ notices to. This is useful for
1144 participating in third-party search and archiving services.
1149 For configuring invites.
1151 enabled: Whether to allow users to send invites. Default true.
1156 Miscellaneous tagging stuff.
1158 dropoff: Decay factor for tag listing, in seconds.
1159 Defaults to exponential decay over ten days; you can twiddle
1160 with it to try and get better results for your site.
1165 Settings for the "popular" section of the site.
1167 dropoff: Decay factor for popularity listing, in seconds.
1168 Defaults to exponential decay over ten days; you can twiddle
1169 with it to try and get better results for your site.
1174 For daemon processes.
1176 piddir: directory that daemon processes should write their PID file
1177 (process ID) to. Defaults to /var/run/, which is where this
1178 stuff should usually go on Unix-ish systems.
1179 user: If set, the daemons will try to change their effective user ID
1180 to this user before running. Probably a good idea, especially if
1181 you start the daemons as root. Note: user name, like 'daemon',
1183 group: If set, the daemons will try to change their effective group ID
1184 to this named group. Again, a name, not a numerical ID.
1189 You can get a significant boost in performance by caching some
1190 database data in memcached <http://www.danga.com/memcached/>.
1192 enabled: Set to true to enable. Default false.
1193 server: a string with the hostname of the memcached server. Can also
1194 be an array of hostnames, if you've got more than one server.
1195 base: memcached uses key-value pairs to store data. We build long,
1196 funny-looking keys to make sure we don't have any conflicts. The
1197 base of the key is usually a simplified version of the site name
1198 (like "Identi.ca" => "identica"), but you can overwrite this if
1199 you need to. You can safely ignore it if you only have one
1200 StatusNet site using your memcached server.
1201 port: Port to connect to; defaults to 11211.
1208 enabled: Whether to enable post-by-email. Defaults to true. You will
1209 also need to set up maildaemon.php.
1214 For SMS integration.
1216 enabled: Whether to enable SMS integration. Defaults to true. Queues
1217 should also be enabled.
1222 A catch-all for integration with other systems.
1224 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1231 enabled: No longer used. If you set this to something other than true,
1232 StatusNet will no longer run.
1237 For notice-posting throttles.
1239 enabled: Whether to throttle posting. Defaults to false.
1240 count: Each user can make this many posts in 'timespan' seconds. So, if count
1241 is 100 and timespan is 3600, then there can be only 100 posts
1242 from a user every hour.
1243 timespan: see 'count'.
1250 biolimit: max character length of bio; 0 means no limit; null means to use
1251 the site text limit default.
1256 Options with new users.
1258 default: nickname of a user account to automatically subscribe new
1259 users to. Typically this would be system account for e.g.
1260 service updates or announcements. Users are able to unsub
1261 if they want. Default is null; no auto subscribe.
1262 welcome: nickname of a user account that sends welcome messages to new
1263 users. Can be the same as 'default' account, although on
1264 busy servers it may be a good idea to keep that one just for
1265 'urgent' messages. Default is null; no message.
1267 If either of these special user accounts are specified, the users should
1268 be created before the configuration is updated.
1273 The software will, by default, send statistical snapshots about the
1274 local installation to a stats server on the status.net Web site. This
1275 data is used by the developers to prioritize development decisions. No
1276 identifying data about users or organizations is collected. The data
1277 is available to the public for review. Participating in this survey
1278 helps StatusNet developers take your needs into account when updating
1281 run: string indicating when to run the statistics. Values can be 'web'
1282 (run occasionally at Web time), 'cron' (run from a cron script),
1283 or 'never' (don't ever run). If you set it to 'cron', remember to
1284 schedule the script to run on a regular basis.
1285 frequency: if run value is 'web', how often to report statistics.
1286 Measured in Web hits; depends on how active your site is.
1287 Default is 10000 -- that is, one report every 10000 Web hits,
1289 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1290 report system, but if they go evil or disappear you may
1291 need to update this to another value. Note: if you
1292 don't want to report stats, it's much better to
1293 set 'run' to 'never' than to set this value to something
1299 The software lets users upload files with their notices. You can configure
1300 the types of accepted files by mime types and a trio of quota options:
1301 per file, per user (total), per user per month.
1303 We suggest the use of the pecl file_info extension to handle mime type
1306 supported: an array of mime types you accept to store and distribute,
1307 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1308 setup your server to properly recognize the types you want to
1310 uploads: false to disable uploading files with notices (true by default).
1311 filecommand: The required MIME_Type library may need to use the 'file'
1312 command. It tries the one in the Web server's path, but if
1313 you're having problems with uploads, try setting this to the
1314 correct value. Note: 'file' must accept '-b' and '-i' options.
1316 For quotas, be sure you've set the upload_max_filesize and post_max_size
1317 in php.ini to be large enough to handle your upload. In httpd.conf
1318 (if you're using apache), check that the LimitRequestBody directive isn't
1319 set too low (it's optional, so it may not be there at all).
1321 file_quota: maximum size for a single file upload in bytes. A user can send
1322 any amount of notices with attachments as long as each attachment
1323 is smaller than file_quota.
1324 user_quota: total size in bytes a user can store on this server. Each user
1325 can store any number of files as long as their total size does
1326 not exceed the user_quota.
1327 monthly_quota: total size permitted in the current month. This is the total
1328 size in bytes that a user can upload each month.
1329 dir: directory accessible to the Web process where uploads should go.
1330 Defaults to the 'file' subdirectory of the install directory, which
1331 should be writeable by the Web user.
1332 server: server name to use when creating URLs for uploaded files.
1333 Defaults to null, meaning to use the default Web server. Using
1334 a virtual server here can speed up Web performance.
1335 path: URL path, relative to the server, to find files. Defaults to
1336 main path + '/file/'.
1337 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1338 guess based on other SSL settings.
1339 filecommand: command to use for determining the type of a file. May be
1340 skipped if fileinfo extension is installed. Defaults to
1346 Options for group functionality.
1348 maxaliases: maximum number of aliases a group can have. Default 3. Set
1349 to 0 or less to prevent aliases in a group.
1350 desclimit: maximum number of characters to allow in group descriptions.
1351 null (default) means to use the site-wide text limits. 0
1357 oEmbed endpoint for multimedia attachments (links in posts).
1359 endpoint: oohembed endpoint using http://oohembed.com/ software.
1364 Some stuff for search.
1366 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1367 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1368 but requires the lame old MyISAM engine for MySQL. The latter
1369 will work with InnoDB but could be miserably slow on large
1370 systems. We'll probably add another type sometime in the future,
1371 with our own indexing system (maybe like MediaWiki's).
1378 handle: boolean. Whether we should register our own PHP session-handling
1379 code (using the database and memcache if enabled). Defaults to false.
1380 Setting this to true makes some sense on large or multi-server
1381 sites, but it probably won't hurt for smaller ones, either.
1382 debug: whether to output debugging info for session storage. Can help
1383 with weird session bugs, sometimes. Default false.
1388 Users can upload backgrounds for their pages; this section defines
1391 server: the server to use for background. Using a separate (even
1392 virtual) server for this can speed up load times. Default is
1393 null; same as site server.
1394 dir: directory to write backgrounds too. Default is '/background/'
1395 subdir of install dir.
1396 path: path to backgrounds. Default is sub-path of install path; note
1397 that you may need to change this if you change site-path too.
1398 ssl: Whether or not to use HTTPS for background files. Defaults to
1399 null, meaning to guess from site-wide SSL settings.
1404 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1405 notify third-party servers of updates.
1407 notify: an array of URLs for ping endpoints. Default is the empty
1408 array (no notification).
1413 Default design (colors and background) for the site. Actual appearance
1414 depends on the theme. Null values mean to use the theme defaults.
1416 backgroundcolor: Hex color of the site background.
1417 contentcolor: Hex color of the content area background.
1418 sidebarcolor: Hex color of the sidebar background.
1419 textcolor: Hex color of all non-link text.
1420 linkcolor: Hex color of all links.
1421 backgroundimage: Image to use for the background.
1422 disposition: Flags for whether or not to tile the background image.
1427 Configuration options specific to notices.
1429 contentlimit: max length of the plain-text content of a notice.
1430 Default is null, meaning to use the site-wide text limit.
1436 Configuration options specific to messages.
1438 contentlimit: max length of the plain-text content of a message.
1439 Default is null, meaning to use the site-wide text limit.
1445 Configuration options for the login command.
1447 disabled: whether to enable this command. If enabled, users who send
1448 the text 'login' to the site through any channel will
1449 receive a link to login to the site automatically in return.
1450 Possibly useful for users who primarily use an XMPP or SMS
1451 interface and can't be bothered to remember their site
1452 password. Note that the security implications of this are
1453 pretty serious and have not been thoroughly tested. You
1454 should enable it only after you've convinced yourself that
1455 it is safe. Default is 'false'.
1460 If an installation has only one user, this can simplify a lot of the
1461 interface. It also makes the user's profile the root URL.
1463 enabled: Whether to run in "single user mode". Default false.
1464 nickname: nickname of the single user.
1469 We put out a default robots.txt file to guide the processing of
1470 Web crawlers. See http://www.robotstxt.org/ for more information
1471 on the format of this file.
1473 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1474 for the robots.txt file. see http://ur1.ca/l5a0
1475 for more information. Default is zero, no explicit delay.
1476 disallow: Array of (virtual) directories to disallow. Default is 'main',
1477 'search', 'message', 'settings', 'admin'. Ignored when site
1478 is private, in which case the entire site ('/') is disallowed.
1483 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1484 powerful plugin architecture. Important events in the code are named,
1485 like 'StartNoticeSave', and other software can register interest
1486 in those events. When the events happen, the other software is called
1487 and has a choice of accepting or rejecting the events.
1489 In the simplest case, you can add a function to config.php and use the
1490 Event::addHandler() function to hook an event:
1492 function AddGoogleLink($action)
1494 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1498 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1500 This adds a menu item to the end of the main navigation menu. You can
1501 see the list of existing events, and parameters that handlers must
1502 implement, in EVENTS.txt.
1504 The Plugin class in lib/plugin.php makes it easier to write more
1505 complex plugins. Sub-classes can just create methods named
1506 'onEventName', where 'EventName' is the name of the event (case
1507 matters!). These methods will be automatically registered as event
1508 handlers by the Plugin constructor (which you must call from your own
1509 class's constructor).
1511 Several example plugins are included in the plugins/ directory. You
1512 can enable a plugin with the following line in config.php:
1514 addPlugin('Example', array('param1' => 'value1',
1515 'param2' => 'value2'));
1517 This will look for and load files named 'ExamplePlugin.php' or
1518 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1519 plugins that ship with StatusNet) or in the local/ directory (for
1520 plugins you write yourself or that you get from somewhere else) or
1523 Plugins are documented in their own directories.
1528 The primary output for StatusNet is syslog, unless you configured a
1529 separate logfile. This is probably the first place to look if you're
1530 getting weird behaviour from StatusNet.
1532 If you're tracking the unstable version of StatusNet in the git
1533 repository (see below), and you get a compilation error ("unexpected
1534 T_STRING") in the browser, check to see that you don't have any
1535 conflicts in your code.
1537 If you upgraded to StatusNet 0.9.2 without reading the "Notice
1538 inboxes" section above, and all your users' 'Personal' tabs are empty,
1539 read the "Notice inboxes" section above.
1544 These are some myths you may see on the Web about StatusNet.
1545 Documentation from the core team about StatusNet has been pretty
1546 sparse, so some backtracking and guesswork resulted in some incorrect
1549 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1550 extremely bad idea. It's a tool built into DB_DataObject that will
1551 emit oodles of print lines directly to the browser of your users.
1552 Among these lines will be your database username and password. Do
1553 not enable this option on a production Web site for any reason.
1555 - "Edit dataobject.ini with the following settings..." dataobject.ini
1556 is a development file for the DB_DataObject framework and is not
1557 used by the running software. It was removed from the StatusNet
1558 distribution because its presence was confusing. Do not bother
1559 configuring dataobject.ini, and do not put your database username
1560 and password into the file on a production Web server; unscrupulous
1561 persons may try to read it to get your passwords.
1566 If you're adventurous or impatient, you may want to install the
1567 development version of StatusNet. To get it, use the git version
1568 control tool <http://git-scm.com/> like so:
1570 git clone git@gitorious.org:statusnet/mainline.git
1572 This is the version of the software that runs on Identi.ca and the
1573 status.net hosted service. Using it is a mixed bag. On the positive
1574 side, it usually includes the latest security and bug fix patches. On
1575 the downside, it may also include changes that require admin
1576 intervention (like running a script or even raw SQL!) that may not be
1577 documented yet. It may be a good idea to test this version before
1578 installing it on your production machines.
1580 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1585 There are several ways to get more information about StatusNet.
1587 * There is a mailing list for StatusNet developers and admins at
1588 http://mail.status.net/mailman/listinfo/statusnet-dev
1589 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1590 * The StatusNet wiki, http://status.net/wiki/
1591 * The StatusNet blog, http://status.net/blog/
1592 * The StatusNet status update, <http://status.status.net/> (!)
1597 * Microblogging messages to http://support.status.net/ are very welcome.
1598 * The microblogging group http://identi.ca/group/statusnet is a good
1599 place to discuss the software.
1600 * StatusNet has a bug tracker for any defects you may find, or ideas for
1601 making things better. http://status.net/bugs
1606 The following is an incomplete list of developers who've worked on
1607 StatusNet. Apologies for any oversight; please let evan@status.net know
1608 if anyone's been overlooked in error.
1610 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1611 * Zach Copley, StatusNet, Inc.
1612 * Earle Martin, StatusNet, Inc.
1613 * Marie-Claude Doyon, designer, StatusNet, Inc.
1614 * Sarven Capadisli, StatusNet, Inc.
1615 * Robin Millette, StatusNet, Inc.
1626 * Tryggvi Björgvinsson
1630 * Ken Sheppardson (Trac server, man-about-town)
1631 * Tiago 'gouki' Faria (i18n manager)
1633 * Leslie Michael Orchard
1637 * Tobias Diekershoff
1649 Thanks also to the developers of our upstream library code and to the
1650 thousands of people who have tried out Identi.ca, installed StatusNet,
1651 told their friends, and built the Open Microblogging network to what