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 Documentation in the /doc-src/ directory is 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 CSS and images in the /theme/ directory are available under the
80 Creative Commons Attribution 3.0 Unported license, with attribution to
81 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
83 Our understanding and intention is that if you add your own theme that
84 uses only CSS and images, those files are not subject to the copyleft
85 requirements of the Affero General Public License 3.0. See
86 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
87 legal advice; consult your lawyer.
89 Additional library software has been made available in the 'extlib'
90 directory. All of it is Free Software and can be distributed under
91 liberal terms, but those terms may differ in detail from the AGPL's
92 particulars. See each package's license file in the extlib directory
98 This is a security, bug and feature release since version 0.9.3 released on
101 For best compatibility with client software and site federation, and a lot of
102 bug fixes, it is highly recommended that all public sites upgrade to the new
105 Notable changes this version:
107 - OpenID and OAuth libraries patched for potential timing attack
108 - OStatus feed i/o updated for Activity Streams
109 - Correctness fixes on XRD, other discovery bits
110 - Support for contacting SNI-based SSL virtual hosts when SSL
111 certificate verification is enabled (requires PHP 5.3.2+ or
112 enabling CURL backend with $config['http']['curl'] = true)
113 - Experimental SubMirror plugin
114 - Multi-site status_network table mode has been tweaked to support
116 - Many updates to user interface translation from TranslateWiki
117 - Many other bugfixes
119 A full changelog is available at http://status.net/wiki/StatusNet_0.9.4.
124 The following software packages are *required* for this software to
127 - PHP 5.2.3+. It may be possible to run this software on earlier
128 versions of PHP, but many of the functions used are only available
129 in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
130 daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
131 release, but problems with some plugins are possible.
132 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
133 server. It has been primarily tested on 5.x servers, although it may
134 be possible to install on earlier (or later!) versions. The server
135 *must* support the MyISAM storage engine -- the default for most
136 MySQL servers -- *and* the InnoDB storage engine.
137 - A Web server. Preferably, you should have Apache 2.2.x with the
138 mod_rewrite extension installed and enabled.
140 Your PHP installation must include the following PHP extensions:
142 - Curl. This is for fetching files by HTTP.
143 - XMLWriter. This is for formatting XML and HTML output.
144 - MySQL. For accessing the database.
145 - GD. For scaling down avatar images.
146 - mbstring. For handling Unicode (UTF-8) encoded strings.
148 For some functionality, you will also need the following extensions:
150 - Memcache. A client for the memcached server, which caches database
151 information in volatile memory. This is important for adequate
152 performance on high-traffic sites. You will also need a memcached
153 server to store the data in.
154 - Mailparse. Efficient parsing of email requires this extension.
155 Submission by email or SMS-over-email uses this extension.
156 - Sphinx Search. A client for the sphinx server, an alternative
157 to MySQL or Postgresql fulltext search. You will also need a
158 Sphinx server to serve the search queries.
159 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
160 if you have OStatus configured.
161 - gettext. For multiple languages. Default on many PHP installs;
162 will be emulated if not present.
164 You will almost definitely get 2-3 times better performance from your
165 site if you install a PHP bytecode cache/accelerator. Some well-known
166 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
167 is a proprietary accelerator installed on some hosting sites.
172 A number of external PHP libraries are used to provide basic
173 functionality and optional functionality for your system. For your
174 convenience, they are available in the "extlib" directory of this
175 package, and you do not have to download and install them. However,
176 you may want to keep them up-to-date with the latest upstream version,
177 and the URLs are listed here for your convenience.
179 - DB_DataObject http://pear.php.net/package/DB_DataObject
180 - Validate http://pear.php.net/package/Validate
181 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
182 to use the openidenabled.com version since it's more widely
183 implemented, and seems to be better supported.
184 http://openidenabled.com/php-openid/
185 - PEAR DB. Although this is an older data access system (new
186 packages should probably use PHP DBO), the OpenID libraries
187 depend on PEAR DB so we use it here, too. DB_DataObject can
188 also use PEAR MDB2, which may give you better performance
189 but won't work with OpenID.
190 http://pear.php.net/package/DB
191 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
192 - markdown.php from http://michelf.com/projects/php-markdown/
193 - PEAR Mail, for sending out mail notifications
194 http://pear.php.net/package/Mail
195 - PEAR Net_SMTP, if you use the SMTP factory for notifications
196 http://pear.php.net/package/Net_SMTP
197 - PEAR Net_Socket, if you use the SMTP factory for notifications
198 http://pear.php.net/package/Net_Socket
199 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
200 library available for PHP. http://xmpphp.googlecode.com/. Note that
201 as of this writing the version of this library that is available in
202 the extlib directory is *significantly different* from the upstream
203 version (patches have been submitted). Upgrading to the upstream
204 version may render your StatusNet site unable to send or receive XMPP
206 - Facebook library. Used for the Facebook application.
207 - PEAR Services_oEmbed. Used for some multimedia integration.
208 - PEAR HTTP_Request is an oEmbed dependency.
209 - PEAR Validate is an oEmbed dependency.
210 - PEAR Net_URL2 is an oEmbed dependency.
211 - Console_GetOpt for parsing command-line options.
212 - libomb. a library for implementing OpenMicroBlogging 0.1, the
213 predecessor to OStatus.
214 - HTTP_Request2, a library for making HTTP requests.
216 A design goal of StatusNet is that the basic Web functionality should
217 work on even the most restrictive commercial hosting services.
218 However, additional functionality, such as receiving messages by
219 Jabber/GTalk, require that you be able to run long-running processes
220 on your account. In addition, posting by email or from SMS require
221 that you be able to install a mail filter in your mail server.
226 Installing the basic StatusNet Web component is relatively easy,
227 especially if you've previously installed PHP/MySQL packages.
229 1. Unpack the tarball you downloaded on your Web server. Usually a
230 command like this will work:
232 tar zxf statusnet-0.9.4.tar.gz
234 ...which will make a statusnet-0.9.2 subdirectory in your current
235 directory. (If you don't have shell access on your Web server, you
236 may have to unpack the tarball on your local computer and FTP the
237 files to the server.)
239 2. Move the tarball to a directory of your choosing in your Web root
240 directory. Usually something like this will work:
242 mv statusnet-0.9.4 /var/www/statusnet
244 This will make your StatusNet instance available in the statusnet path of
245 your server, like "http://example.net/statusnet". "microblog" or
246 "statusnet" might also be good path names. If you know how to
247 configure virtual hosts on your web server, you can try setting up
248 "http://micro.example.net/" or the like.
250 3. Make your target directory writeable by the Web server.
252 chmod a+w /var/www/statusnet/
254 On some systems, this will probably work:
256 chgrp www-data /var/www/statusnet/
257 chmod g+w /var/www/statusnet/
259 If your Web server runs as another user besides "www-data", try
260 that user's default group instead. As a last resort, you can create
261 a new group like "statusnet" and add the Web server's user to the group.
263 4. You should also take this moment to make your avatar, background, and
264 file subdirectories writeable by the Web server. An insecure way to do
267 chmod a+w /var/www/statusnet/avatar
268 chmod a+w /var/www/statusnet/background
269 chmod a+w /var/www/statusnet/file
271 You can also make the avatar, background, and file directories
272 writeable by the Web server group, as noted above.
274 5. Create a database to hold your microblog data. Something like this
277 mysqladmin -u "username" --password="password" create statusnet
279 Note that StatusNet must have its own database; you can't share the
280 database with another program. You can name it whatever you want,
283 (If you don't have shell access to your server, you may need to use
284 a tool like PHPAdmin to create a database. Check your hosting
285 service's documentation for how to create a new MySQL database.)
287 6. Create a new database account that StatusNet will use to access the
288 database. If you have shell access, this will probably work from the
291 GRANT ALL on statusnet.*
292 TO 'statusnetuser'@'localhost'
293 IDENTIFIED BY 'statusnetpassword';
295 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
296 username and password. You may want to test logging in to MySQL as
299 7. In a browser, navigate to the StatusNet install script; something like:
301 http://yourserver.example.com/statusnet/install.php
303 Enter the database connection information and your site name. The
304 install program will configure your site and install the initial,
305 almost-empty database.
307 8. You should now be able to navigate to your microblog's main directory
308 and see the "Public Timeline", which will be empty. If not, magic
309 has happened! You can now register a new user, post some notices,
310 edit your profile, etc. However, you may want to wait to do that stuff
311 if you think you can set up "fancy URLs" (see below), since some
312 URLs are stored in the database.
317 By default, StatusNet will use URLs that include the main PHP program's
318 name in them. For example, a user's home profile might be
321 http://example.org/statusnet/index.php/statusnet/fred
323 On certain systems that don't support this kind of syntax, they'll
326 http://example.org/statusnet/index.php?p=statusnet/fred
328 It's possible to configure the software so it looks like this instead:
330 http://example.org/statusnet/fred
332 These "fancy URLs" are more readable and memorable for users. To use
333 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
334 mod_rewrite enabled, -OR- know how to configure "url redirection" in
337 1. Copy the htaccess.sample file to .htaccess in your StatusNet
338 directory. Note: if you have control of your server's httpd.conf or
339 similar configuration files, it can greatly improve performance to
340 import the .htaccess file into your conf file instead. If you're
341 not sure how to do it, you may save yourself a lot of headache by
342 just leaving the .htaccess file.
344 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
345 to your StatusNet installation on your server. Typically this will
346 be the path to your StatusNet directory relative to your Web root.
348 3. Add or uncomment or change a line in your config.php file so it says:
350 $config['site']['fancy'] = true;
352 You should now be able to navigate to a "fancy" URL on your server,
355 http://example.net/statusnet/main/register
357 If you changed your HTTP server configuration, you may need to restart
360 If it doesn't work, double-check that AllowOverride for the StatusNet
361 directory is 'All' in your Apache configuration file. This is usually
362 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
363 /etc/apache2/sites-available/default. See the Apache documentation for
364 .htaccess files for more details:
366 http://httpd.apache.org/docs/2.2/howto/htaccess.html
368 Also, check that mod_rewrite is installed and enabled:
370 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
375 To use a Sphinx server to search users and notices, you'll need to
376 enable the SphinxSearch plugin. Add to your config.php:
378 addPlugin('SphinxSearch');
379 $config['sphinx']['server'] = 'searchhost.local';
381 You also need to install, compile and enable the sphinx pecl extension for
382 php on the client side, which itself depends on the sphinx development files.
384 See plugins/SphinxSearch/README for more details and server setup.
389 StatusNet supports a cheap-and-dirty system for sending update messages
390 to mobile phones and for receiving updates from the mobile. Instead of
391 sending through the SMS network itself, which is costly and requires
392 buy-in from the wireless carriers, it simply piggybacks on the email
393 gateways that many carriers provide to their customers. So, SMS
394 configuration is essentially email configuration.
396 Each user sends to a made-up email address, which they keep a secret.
397 Incoming email that is "From" the user's SMS email address, and "To"
398 the users' secret email address on the site's domain, will be
399 converted to a notice and stored in the DB.
401 For this to work, there *must* be a domain or sub-domain for which all
402 (or most) incoming email can pass through the incoming mail filter.
404 1. Run the SQL script carrier.sql in your StatusNet database. This will
407 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
409 This will populate your database with a list of wireless carriers
410 that support email SMS gateways.
412 2. Make sure the maildaemon.php file is executable:
414 chmod +x scripts/maildaemon.php
416 Note that "daemon" is kind of a misnomer here; the script is more
417 of a filter than a daemon.
419 2. Edit /etc/aliases on your mail server and add the following line:
421 *: /path/to/statusnet/scripts/maildaemon.php
423 3. Run whatever code you need to to update your aliases database. For
424 many mail servers (Postfix, Exim, Sendmail), this should work:
428 You may need to restart your mail server for the new database to
431 4. Set the following in your config.php file:
433 $config['mail']['domain'] = 'yourdomain.example.net';
435 At this point, post-by-email and post-by-SMS-gateway should work. Note
436 that if your mail server is on a different computer from your email
437 server, you'll need to have a full installation of StatusNet, a working
438 config.php, and access to the StatusNet database from the mail server.
443 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
444 instant-messenger protocol that drives Jabber and GTalk IM. You can
445 distribute messages via XMPP using the system below; however, you
446 need to run the XMPP incoming daemon to allow incoming messages as
449 1. You may want to strongly consider setting up your own XMPP server.
450 Ejabberd, OpenFire, and JabberD are all Open Source servers.
451 Jabber, Inc. provides a high-performance commercial server.
453 2. You must register a Jabber ID (JID) with your new server. It helps
454 to choose a name like "update@example.com" or "notice" or something
455 similar. Alternately, your "update JID" can be registered on a
456 publicly-available XMPP service, like jabber.org or GTalk.
458 StatusNet will not register the JID with your chosen XMPP server;
459 you need to do this manually, with an XMPP client like Gajim,
460 Telepathy, or Pidgin.im.
462 3. Configure your site's XMPP variables, as described below in the
463 configuration section.
465 On a default installation, your site can broadcast messages using
466 XMPP. Users won't be able to post messages using XMPP unless you've
467 got the XMPP daemon running. See 'Queues and daemons' below for how
468 to set that up. Also, once you have a sizable number of users, sending
469 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
470 can really slow down your site; it may cause posting to timeout.
472 NOTE: stream_select(), a crucial function for network programming, is
473 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
474 work around this bug in StatusNet; current recommendation is to move
475 off of amd64 to another server.
480 You can send *all* messages from your microblogging site to a
481 third-party service using XMPP. This can be useful for providing
482 search, indexing, bridging, or other cool services.
484 To configure a downstream site to receive your public stream, add
485 their "JID" (Jabber ID) to your config.php as follows:
487 $config['xmpp']['public'][] = 'downstream@example.net';
489 (Don't miss those square brackets at the end.) Note that your XMPP
490 broadcasting must be configured as mentioned above. Although you can
491 send out messages at "Web time", high-volume sites should strongly
492 consider setting up queues and daemons.
497 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
498 and XMPP messages, can be 'queued' and done by off-line bots instead.
499 For this to work, you must be able to run long-running offline
500 processes, either on your main Web server or on another server you
501 control. (Your other server will still need all the above
502 prerequisites, with the exception of Apache.) Installing on a separate
503 server is probably a good idea for high-volume sites.
505 1. You'll need the "CLI" (command-line interface) version of PHP
506 installed on whatever server you use.
508 2. If you're using a separate server for queues, install StatusNet
509 somewhere on the server. You don't need to worry about the
510 .htaccess file, but make sure that your config.php file is close
511 to, or identical to, your Web server's version.
513 3. In your config.php files (both the Web server and the queues
514 server!), set the following variable:
516 $config['queue']['enabled'] = true;
518 You may also want to look at the 'daemon' section of this file for
519 more daemon options. Note that if you set the 'user' and/or 'group'
520 options, you'll need to create that user and/or group by hand.
521 They're not created automatically.
523 4. On the queues server, run the command scripts/startdaemons.sh.
525 This will run the queue handlers:
527 * queuedaemon.php - polls for queued items for inbox processing and
528 pushing out to OStatus, SMS, XMPP, etc.
529 * xmppdaemon.php - listens for new XMPP messages from users and stores
530 them as notices in the database; also pulls queued XMPP output from
531 queuedaemon.php to push out to clients.
533 These two daemons will automatically restart in most cases of failure
534 including memory leaks (if a memory_limit is set), but may still die
535 or behave oddly if they lose connections to the XMPP or queue servers.
537 Additional daemons may be also started by this script for certain
538 plugins, such as the Twitter bridge.
540 It may be a good idea to use a daemon-monitoring service, like 'monit',
541 to check their status and keep them running.
543 All the daemons write their process IDs (pids) to /var/run/ by
544 default. This can be useful for starting, stopping, and monitoring the
547 Since version 0.8.0, it's now possible to use a STOMP server instead of
548 our kind of hacky home-grown DB-based queue solution. This is strongly
549 recommended for best response time, especially when using XMPP.
551 See the "queues" config section below for how to configure to use STOMP.
552 As of this writing, the software has been tested with ActiveMQ 5.3.
557 There are two themes shipped with this version of StatusNet: "identica",
558 which is what the Identi.ca site uses, and "default", which is a good
559 basis for other sites.
561 As of right now, your ability to change the theme is site-wide; users
562 can't choose their own theme. Additionally, the only thing you can
563 change in the theme is CSS stylesheets and some image files; you can't
564 change the HTML output, like adding or removing menu items.
566 You can choose a theme using the $config['site']['theme'] element in
567 the config.php file. See below for details.
569 You can add your own theme by making a sub-directory of the 'theme'
570 subdirectory with the name of your theme. Each theme can have the
573 display.css: a CSS2 file for "default" styling for all browsers.
574 ie6.css: a CSS2 file for override styling for fixing up Internet
576 ie7.css: a CSS2 file for override styling for fixing up Internet
578 logo.png: a logo image for the site.
579 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
580 users who don't upload their own.
581 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
582 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
583 listing on profile pages.
585 You may want to start by copying the files from the default theme to
588 NOTE: the HTML generated by StatusNet changed *radically* between
589 version 0.6.x and 0.7.x. Older themes will need signification
590 modification to use the new output format.
595 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
596 Theoretically, you can add your own sub-directory to the locale/
597 subdirectory to add a new language to your system. You'll need to
598 compile the ".po" files into ".mo" files, however.
600 Contributions of translation information to StatusNet are very easy:
601 you can use the Web interface at TranslateWiki.net to add one
602 or a few or lots of new translations -- or even new languages. You can
603 also download more up-to-date .po files there, if you so desire.
605 For info on helping with translations, see http://status.net/wiki/Translations
610 There is no built-in system for doing backups in StatusNet. You can make
611 backups of a working StatusNet system by backing up the database and
612 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
613 and to backup the Web directory, try tar.
618 The administrator can set the "private" flag for a site so that it's
619 not visible to non-logged-in users. This might be useful for
620 workgroups who want to share a microblogging site for project
621 management, but host it on a public server.
623 Total privacy is not guaranteed or ensured. Also, privacy is
624 all-or-nothing for a site; you can't have some accounts or notices
625 private, and others public. The interaction of private sites
626 with OStatus is undefined.
628 Access to file attachments can also be restricted to logged-in users only.
629 1. Add a directory outside the web root where your file uploads will be
630 stored. Usually a command like this will work:
632 mkdir /var/www/statusnet-files
634 2. Make the file uploads directory writeable by the web server. An
635 insecure way to do this is:
637 chmod a+x /var/www/statusnet-files
639 3. Tell StatusNet to use this directory for file uploads. Add a line
640 like this to your config.php:
642 $config['attachments']['dir'] = '/var/www/statusnet-files';
647 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
648 incorrectly-stored international characters ("UTF-8"). For new
649 installations, it will now store non-ASCII characters correctly.
650 However, older installations will have the incorrect storage, and will
651 consequently show up "wrong" in browsers. See below for how to deal
654 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
655 been tracking the "git" version of the software, you will probably
656 want to upgrade and keep your existing data. There is no automated
657 upgrade procedure in StatusNet 0.9.2. Try these step-by-step
658 instructions; read to the end first before trying them.
660 0. Download StatusNet and set up all the prerequisites as if you were
662 1. Make backups of both your database and your Web directory. UNDER NO
663 CIRCUMSTANCES should you try to do an upgrade without a known-good
664 backup. You have been warned.
665 2. Shut down Web access to your site, either by turning off your Web
666 server or by redirecting all pages to a "sorry, under maintenance"
668 3. Shut down XMPP access to your site, typically by shutting down the
669 xmppdaemon.php process and all other daemons that you're running.
670 If you've got "monit" or "cron" automatically restarting your
671 daemons, make sure to turn that off, too.
672 4. Shut down SMS and email access to your site. The easy way to do
673 this is to comment out the line piping incoming email to your
674 maildaemon.php file, and running something like "newaliases".
675 5. Once all writing processes to your site are turned off, make a
676 final backup of the Web directory and database.
677 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
678 7. Unpack your StatusNet 0.9.2 tarball and move it to "statusnet" or
679 wherever your code used to be.
680 8. Copy the config.php file and avatar directory from your old
681 directory to your new directory.
682 9. Copy htaccess.sample to .htaccess in the new directory. Change the
683 RewriteBase to use the correct path.
684 10. Rebuild the database. (You can safely skip this step and go to #12
685 if you're upgrading from another 0.9.x version).
687 NOTE: this step is destructive and cannot be
688 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
689 do it without a known-good backup!
691 If your database is at version 0.8.0 or above, you can run a
692 special upgrade script:
694 mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
696 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
697 BACKUP run the rebuilddb.sh script like this:
699 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
701 Here, rootuser and rootpassword are the username and password for a
702 user who can drop and create databases as well as tables; typically
703 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
704 your database and rebuilds it; if there is an error you have no
705 database. Make sure you have a backup.
706 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
707 which operates slightly differently. Read the documentation in that
708 script before running it.
709 11. Use mysql or psql client to log into your database and make sure that
710 the notice, user, profile, subscription etc. tables are non-empty.
711 12. Turn back on the Web server, and check that things still work.
712 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
713 bots have changed since version 0.5; see above for details.
715 If you're upgrading from very old versions, you may want to look at
716 the fixup_* scripts in the scripts directories. These will store some
717 precooked data in the DB. All upgraders should check out the inboxes
720 NOTE: the database definition file, laconica.ini, has been renamed to
721 statusnet.ini (since this is the recommended database name). If you
722 have a line in your config.php pointing to the old name, you'll need
728 Notice inboxes are now required. If you don't have inboxes enabled,
729 StatusNet will no longer run.
734 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
735 international characters ("UTF-8"). This fix is not
736 backwards-compatible; installations from before 0.7.4 will show
737 non-ASCII characters of old notices incorrectly. This section explains
740 0. You can disable the new behaviour by setting the 'db''utf8' config
741 option to "false". You should only do this until you're ready to
742 convert your DB to the new format.
743 1. When you're ready to convert, you can run the fixup_utf8.php script
744 in the scripts/ subdirectory. If you've had the "new behaviour"
745 enabled (probably a good idea), you can give the ID of the first
746 "new" notice as a parameter, and only notices before that one will
747 be converted. Notices are converted in reverse chronological order,
748 so the most recent (and visible) ones will be converted first. The
749 script should work whether or not you have the 'db''utf8' config
751 2. When you're ready, set $config['db']['utf8'] to true, so that
752 new notices will be stored correctly.
754 Configuration options
755 =====================
757 The main configuration file for StatusNet (excepting configurations for
758 dependency software) is config.php in your StatusNet directory. If you
759 edit any other file in the directory, like lib/default.php (where most
760 of the defaults are defined), you will lose your configuration options
761 in any upgrade, and you will wish that you had been more careful.
763 Starting with version 0.9.0, a Web based configuration panel has been
764 added to StatusNet. The preferred method for changing config options is
767 A command-line script, setconfig.php, can be used to set individual
768 configuration options. It's in the scripts/ directory.
770 Starting with version 0.7.1, you can put config files in the
771 /etc/statusnet/ directory on your server, if it exists. Config files
772 will be included in this order:
774 * /etc/statusnet/statusnet.php - server-wide config
775 * /etc/statusnet/<servername>.php - for a virtual host
776 * /etc/statusnet/<servername>_<pathname>.php - for a path
777 * INSTALLDIR/config.php - for a particular implementation
779 Almost all configuration options are made through a two-dimensional
780 associative array, cleverly named $config. A typical configuration
783 $config['section']['option'] = value;
785 For brevity, the following documentation describes each section and
791 This section is a catch-all for site-wide variables.
793 name: the name of your site, like 'YourCompany Microblog'.
794 server: the server part of your site's URLs, like 'example.net'.
795 path: The path part of your site's URLs, like 'statusnet' or ''
797 fancy: whether or not your site uses fancy URLs (see Fancy URLs
798 section above). Default is false.
799 logfile: full path to a file for StatusNet to save logging
800 information to. You may want to use this if you don't have
802 logdebug: whether to log additional debug info like backtraces on
803 hard errors. Default false.
804 locale_path: full path to the directory for locale data. Unless you
805 store all your locale data in one place, you probably
806 don't need to use this.
807 language: default language for your site. Defaults to US English.
808 Note that this is overridden if a user is logged in and has
809 selected a different language. It is also overridden if the
810 user is NOT logged in, but their browser requests a different
811 langauge. Since pretty much everybody's browser requests a
812 language, that means that changing this setting has little or
813 no effect in practice.
814 languages: A list of languages supported on your site. Typically you'd
815 only change this if you wanted to disable support for one
817 "unset($config['site']['languages']['de'])" will disable
819 theme: Theme for your site (see Theme section). Two themes are
820 provided by default: 'default' and 'stoica' (the one used by
821 Identi.ca). It's appreciated if you don't use the 'stoica' theme
822 except as the basis for your own.
823 email: contact email address for your site. By default, it's extracted
824 from your Web server environment; you may want to customize it.
825 broughtbyurl: name of an organization or individual who provides the
826 service. Each page will include a link to this name in the
827 footer. A good way to link to the blog, forum, wiki,
828 corporate portal, or whoever is making the service available.
829 broughtby: text used for the "brought by" link.
830 timezone: default timezone for message display. Users can set their
831 own time zone. Defaults to 'UTC', which is a pretty good default.
832 closed: If set to 'true', will disallow registration on your site.
833 This is a cheap way to restrict accounts to only one
834 individual or group; just register the accounts you want on
835 the service, *then* set this variable to 'true'.
836 inviteonly: If set to 'true', will only allow registration if the user
837 was invited by an existing user.
838 private: If set to 'true', anonymous users will be redirected to the
839 'login' page. Also, API methods that normally require no
840 authentication will require it. Note that this does not turn
841 off registration; use 'closed' or 'inviteonly' for the
843 notice: A plain string that will appear on every page. A good place
844 to put introductory information about your service, or info about
845 upgrades and outages, or other community info. Any HTML will
847 logo: URL of an image file to use as the logo for the site. Overrides
848 the logo in the theme, if any.
849 ssl: Whether to use SSL and https:// URLs for some or all pages.
850 Possible values are 'always' (use it for all pages), 'never'
851 (don't use it for any pages), or 'sometimes' (use it for
852 sensitive pages that include passwords like login and registration,
853 but not for regular pages). Default to 'never'.
854 sslserver: use an alternate server name for SSL URLs, like
855 'secure.example.org'. You should be careful to set cookie
856 parameters correctly so that both the SSL server and the
857 "normal" server can access the session cookie and
858 preferably other cookies as well.
859 shorturllength: Length of URL at which URLs in a message exceeding 140
860 characters will be sent to the user's chosen
862 dupelimit: minimum time allowed for one person to say the same thing
863 twice. Default 60s. Anything lower is considered a user
865 textlimit: default max size for texts in the site. Defaults to 140.
866 0 means no limit. Can be fine-tuned for notices, messages,
867 profile bios and group descriptions.
872 This section is a reference to the configuration options for
873 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
874 set are listed below for clarity.
876 database: a DSN (Data Source Name) for your StatusNet database. This is
877 in the format 'protocol://username:password@hostname/databasename',
878 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
879 really know what you're doing), 'username' is the username,
880 'password' is the password, and etc.
881 ini_yourdbname: if your database is not named 'statusnet', you'll need
882 to set this to point to the location of the
883 statusnet.ini file. Note that the real name of your database
884 should go in there, not literally 'yourdbname'.
885 db_driver: You can try changing this to 'MDB2' to use the other driver
886 type for DB_DataObject, but note that it breaks the OpenID
887 libraries, which only support PEAR::DB.
888 debug: On a database error, you may get a message saying to set this
889 value to 5 to see debug messages in the browser. This breaks
890 just about all pages, and will also expose the username and
892 quote_identifiers: Set this to true if you're using postgresql.
893 type: either 'mysql' or 'postgresql' (used for some bits of
894 database-type-specific SQL in the code). Defaults to mysql.
895 mirror: you can set this to an array of DSNs, like the above
896 'database' value. If it's set, certain read-only actions will
897 use a random value out of this array for the database, rather
898 than the one in 'database' (actually, 'database' is overwritten).
899 You can offload a busy DB server by setting up MySQL replication
900 and adding the slaves to this array. Note that if you want some
901 requests to go to the 'database' (master) server, you'll need
902 to include it in this array, too.
903 utf8: whether to talk to the database in UTF-8 mode. This is the default
904 with new installations, but older sites may want to turn it off
905 until they get their databases fixed up. See "UTF-8 database"
907 schemacheck: when to let plugins check the database schema to add
908 tables or update them. Values can be 'runtime' (default)
909 or 'script'. 'runtime' can be costly (plugins check the
910 schema on every hit, adding potentially several db
911 queries, some quite long), but not everyone knows how to
912 run a script. If you can, set this to 'script' and run
913 scripts/checkschema.php whenever you install or upgrade a
919 By default, StatusNet sites log error messages to the syslog facility.
920 (You can override this using the 'logfile' parameter described above).
922 appname: The name that StatusNet uses to log messages. By default it's
923 "statusnet", but if you have more than one installation on the
924 server, you may want to change the name for each instance so
925 you can track log messages more easily.
926 priority: level to log at. Currently ignored.
927 facility: what syslog facility to used. Defaults to LOG_USER, only
928 reset if you know what syslog is and have a good reason
934 You can configure the software to queue time-consuming tasks, like
935 sending out SMS email or XMPP messages, for off-line processing. See
936 'Queues and daemons' above for how to set this up.
938 enabled: Whether to uses queues. Defaults to false.
939 subsystem: Which kind of queueserver to use. Values include "db" for
940 our hacked-together database queuing (no other server
941 required) and "stomp" for a stomp server.
942 stomp_server: "broker URI" for stomp server. Something like
943 "tcp://hostname:61613". More complicated ones are
944 possible; see your stomp server's documentation for
946 queue_basename: a root name to use for queues (stomp only). Typically
947 something like '/queue/sitename/' makes sense. If running
948 multiple instances on the same server, make sure that
949 either this setting or $config['site']['nickname'] are
950 unique for each site to keep them separate.
952 stomp_username: username for connecting to the stomp server; defaults
954 stomp_password: password for connecting to the stomp server; defaults
957 stomp_persistent: keep items across queue server restart, if enabled.
958 Under ActiveMQ, the server configuration determines if and how
959 persistent storage is actually saved.
961 If using a message queue server other than ActiveMQ, you may
962 need to disable this if it does not support persistence.
964 stomp_transactions: use transactions to aid in error detection.
965 A broken transaction will be seen quickly, allowing a message
966 to be redelivered immediately if a daemon crashes.
968 If using a message queue server other than ActiveMQ, you may
969 need to disable this if it does not support transactions.
971 stomp_acks: send acknowledgements to aid in flow control.
972 An acknowledgement of successful processing tells the server
973 we're ready for more and can help keep things moving smoothly.
975 This should *not* be turned off when running with ActiveMQ, but
976 if using another message queue server that does not support
977 acknowledgements you might need to disable this.
979 softlimit: an absolute or relative "soft memory limit"; daemons will
980 restart themselves gracefully when they find they've hit
981 this amount of memory usage. Defaults to 90% of PHP's global
982 memory_limit setting.
984 inboxes: delivery of messages to receiver's inboxes can be delayed to
985 queue time for best interactive performance on the sender.
986 This may however be annoyingly slow when using the DB queues,
987 so you can set this to false if it's causing trouble.
989 breakout: for stomp, individual queues are by default grouped up for
990 best scalability. If some need to be run by separate daemons,
991 etc they can be manually adjusted here.
993 Default will share all queues for all sites within each group.
994 Specify as <group>/<queue> or <group>/<queue>/<site>,
995 using nickname identifier as site.
997 'main/distrib' separate "distrib" queue covering all sites
998 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1000 max_retries: for stomp, drop messages after N failed attempts to process.
1003 dead_letter_dir: for stomp, optional directory to dump data on failed
1004 queue processing events after discarding them.
1006 stomp_no_transactions: for stomp, the server does not support transactions,
1007 so do not try to user them. This is needed for http://www.morbidq.com/.
1009 stomp_no_acks: for stomp, the server does not support acknowledgements.
1010 so do not try to user them. This is needed for http://www.morbidq.com/.
1015 The default license to use for your users notices. The default is the
1016 Creative Commons Attribution 3.0 license, which is probably the right
1017 choice for any public site. Note that some other servers will not
1018 accept notices if you apply a stricter license than this.
1020 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1021 (default copyright), or 'private' (for private and confidential
1023 owner: for 'allrightsreserved' or 'private', an assigned copyright
1024 holder (for example, an employer for a private site). If
1025 not specified, will be attributed to 'contributors'.
1026 url: URL of the license, used for links.
1027 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1028 image: A button shown on each page for the license.
1033 This is for configuring out-going email. We use PEAR's Mail module,
1034 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1036 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1037 'smtp'. Defaults to PEAR's default, 'mail'.
1038 params: if the mail backend requires any parameters, you can provide
1039 them in an associative array.
1044 This is for configuring nicknames in the service.
1046 blacklist: an array of strings for usernames that may not be
1047 registered. A default array exists for strings that are
1048 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1049 but you may want to add others if you have other software
1050 installed in a subdirectory of StatusNet or if you just
1051 don't want certain words used as usernames.
1052 featured: an array of nicknames of 'featured' users of the site.
1053 Can be useful to draw attention to well-known users, or
1054 interesting people, or whatever.
1059 For configuring avatar access.
1061 dir: Directory to look for avatar files and to put them into.
1062 Defaults to avatar subdirectory of install directory; if
1063 you change it, make sure to change path, too.
1064 path: Path to avatars. Defaults to path for avatar subdirectory,
1065 but you can change it if you wish. Note that this will
1066 be included with the avatar server, too.
1067 server: If set, defines another server where avatars are stored in the
1068 root directory. Note that the 'avatar' subdir still has to be
1069 writeable. You'd typically use this to split HTTP requests on
1070 the client to speed up page loading, either with another
1071 virtual server or with an NFS or SAMBA share. Clients
1072 typically only make 2 connections to a single server at a
1073 time <http://ur1.ca/6ih>, so this can parallelize the job.
1075 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1076 to guess based on site-wide SSL settings.
1081 For configuring the public stream.
1083 localonly: If set to true, only messages posted by users of this
1084 service (rather than other services, filtered through OMB)
1085 are shown in the public stream. Default true.
1086 blacklist: An array of IDs of users to hide from the public stream.
1087 Useful if you have someone making excessive Twitterfeed posts
1088 to the site, other kinds of automated posts, testing bots, etc.
1089 autosource: Sources of notices that are from automatic posters, and thus
1090 should be kept off the public timeline. Default empty.
1095 server: Like avatars, you can speed up page loading by pointing the
1096 theme file lookup to another server (virtual or real).
1097 Defaults to NULL, meaning to use the site server.
1098 dir: Directory where theme files are stored. Used to determine
1099 whether to show parts of a theme file. Defaults to the theme
1100 subdirectory of the install directory.
1101 path: Path part of theme URLs, before the theme name. Relative to the
1102 theme server. It may make sense to change this path when upgrading,
1103 (using version numbers as the path) to make sure that all files are
1104 reloaded by caching clients or proxies. Defaults to null,
1105 which means to use the site path + '/theme'.
1106 ssl: Whether to use SSL for theme elements. Default is null, which means
1107 guess based on site SSL settings.
1112 server: You can speed up page loading by pointing the
1113 theme file lookup to another server (virtual or real).
1114 Defaults to NULL, meaning to use the site server.
1115 path: Path part of Javascript URLs. Defaults to null,
1116 which means to use the site path + '/js/'.
1117 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1118 guess based on site SSL settings.
1123 For configuring the XMPP sub-system.
1125 enabled: Whether to accept and send messages by XMPP. Default false.
1126 server: server part of XMPP ID for update user.
1127 port: connection port for clients. Default 5222, which you probably
1128 shouldn't need to change.
1129 user: username for the client connection. Users will receive messages
1130 from 'user'@'server'.
1131 resource: a unique identifier for the connection to the server. This
1132 is actually used as a prefix for each XMPP component in the system.
1133 password: password for the user account.
1134 host: some XMPP domains are served by machines with a different
1135 hostname. (For example, @gmail.com GTalk users connect to
1136 talk.google.com). Set this to the correct hostname if that's the
1137 case with your server.
1138 encryption: Whether to encrypt the connection between StatusNet and the
1139 XMPP server. Defaults to true, but you can get
1140 considerably better performance turning it off if you're
1141 connecting to a server on the same machine or on a
1143 debug: if turned on, this will make the XMPP library blurt out all of
1144 the incoming and outgoing messages as XML stanzas. Use as a
1145 last resort, and never turn it on if you don't have queues
1146 enabled, since it will spit out sensitive data to the browser.
1147 public: an array of JIDs to send _all_ notices to. This is useful for
1148 participating in third-party search and archiving services.
1153 For configuring invites.
1155 enabled: Whether to allow users to send invites. Default true.
1160 Miscellaneous tagging stuff.
1162 dropoff: Decay factor for tag listing, in seconds.
1163 Defaults to exponential decay over ten days; you can twiddle
1164 with it to try and get better results for your site.
1169 Settings for the "popular" section of the site.
1171 dropoff: Decay factor for popularity listing, in seconds.
1172 Defaults to exponential decay over ten days; you can twiddle
1173 with it to try and get better results for your site.
1178 For daemon processes.
1180 piddir: directory that daemon processes should write their PID file
1181 (process ID) to. Defaults to /var/run/, which is where this
1182 stuff should usually go on Unix-ish systems.
1183 user: If set, the daemons will try to change their effective user ID
1184 to this user before running. Probably a good idea, especially if
1185 you start the daemons as root. Note: user name, like 'daemon',
1187 group: If set, the daemons will try to change their effective group ID
1188 to this named group. Again, a name, not a numerical ID.
1193 You can get a significant boost in performance by caching some
1194 database data in memcached <http://www.danga.com/memcached/>.
1196 enabled: Set to true to enable. Default false.
1197 server: a string with the hostname of the memcached server. Can also
1198 be an array of hostnames, if you've got more than one server.
1199 base: memcached uses key-value pairs to store data. We build long,
1200 funny-looking keys to make sure we don't have any conflicts. The
1201 base of the key is usually a simplified version of the site name
1202 (like "Identi.ca" => "identica"), but you can overwrite this if
1203 you need to. You can safely ignore it if you only have one
1204 StatusNet site using your memcached server.
1205 port: Port to connect to; defaults to 11211.
1212 enabled: Whether to enable post-by-email. Defaults to true. You will
1213 also need to set up maildaemon.php.
1218 For SMS integration.
1220 enabled: Whether to enable SMS integration. Defaults to true. Queues
1221 should also be enabled.
1226 A catch-all for integration with other systems.
1228 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1235 enabled: No longer used. If you set this to something other than true,
1236 StatusNet will no longer run.
1241 For notice-posting throttles.
1243 enabled: Whether to throttle posting. Defaults to false.
1244 count: Each user can make this many posts in 'timespan' seconds. So, if count
1245 is 100 and timespan is 3600, then there can be only 100 posts
1246 from a user every hour.
1247 timespan: see 'count'.
1254 biolimit: max character length of bio; 0 means no limit; null means to use
1255 the site text limit default.
1260 Options with new users.
1262 default: nickname of a user account to automatically subscribe new
1263 users to. Typically this would be system account for e.g.
1264 service updates or announcements. Users are able to unsub
1265 if they want. Default is null; no auto subscribe.
1266 welcome: nickname of a user account that sends welcome messages to new
1267 users. Can be the same as 'default' account, although on
1268 busy servers it may be a good idea to keep that one just for
1269 'urgent' messages. Default is null; no message.
1271 If either of these special user accounts are specified, the users should
1272 be created before the configuration is updated.
1277 The software will, by default, send statistical snapshots about the
1278 local installation to a stats server on the status.net Web site. This
1279 data is used by the developers to prioritize development decisions. No
1280 identifying data about users or organizations is collected. The data
1281 is available to the public for review. Participating in this survey
1282 helps StatusNet developers take your needs into account when updating
1285 run: string indicating when to run the statistics. Values can be 'web'
1286 (run occasionally at Web time), 'cron' (run from a cron script),
1287 or 'never' (don't ever run). If you set it to 'cron', remember to
1288 schedule the script to run on a regular basis.
1289 frequency: if run value is 'web', how often to report statistics.
1290 Measured in Web hits; depends on how active your site is.
1291 Default is 10000 -- that is, one report every 10000 Web hits,
1293 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1294 report system, but if they go evil or disappear you may
1295 need to update this to another value. Note: if you
1296 don't want to report stats, it's much better to
1297 set 'run' to 'never' than to set this value to something
1303 The software lets users upload files with their notices. You can configure
1304 the types of accepted files by mime types and a trio of quota options:
1305 per file, per user (total), per user per month.
1307 We suggest the use of the pecl file_info extension to handle mime type
1310 supported: an array of mime types you accept to store and distribute,
1311 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1312 setup your server to properly recognize the types you want to
1314 uploads: false to disable uploading files with notices (true by default).
1315 filecommand: The required MIME_Type library may need to use the 'file'
1316 command. It tries the one in the Web server's path, but if
1317 you're having problems with uploads, try setting this to the
1318 correct value. Note: 'file' must accept '-b' and '-i' options.
1320 For quotas, be sure you've set the upload_max_filesize and post_max_size
1321 in php.ini to be large enough to handle your upload. In httpd.conf
1322 (if you're using apache), check that the LimitRequestBody directive isn't
1323 set too low (it's optional, so it may not be there at all).
1325 file_quota: maximum size for a single file upload in bytes. A user can send
1326 any amount of notices with attachments as long as each attachment
1327 is smaller than file_quota.
1328 user_quota: total size in bytes a user can store on this server. Each user
1329 can store any number of files as long as their total size does
1330 not exceed the user_quota.
1331 monthly_quota: total size permitted in the current month. This is the total
1332 size in bytes that a user can upload each month.
1333 dir: directory accessible to the Web process where uploads should go.
1334 Defaults to the 'file' subdirectory of the install directory, which
1335 should be writeable by the Web user.
1336 server: server name to use when creating URLs for uploaded files.
1337 Defaults to null, meaning to use the default Web server. Using
1338 a virtual server here can speed up Web performance.
1339 path: URL path, relative to the server, to find files. Defaults to
1340 main path + '/file/'.
1341 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1342 guess based on other SSL settings.
1343 filecommand: command to use for determining the type of a file. May be
1344 skipped if fileinfo extension is installed. Defaults to
1350 Options for group functionality.
1352 maxaliases: maximum number of aliases a group can have. Default 3. Set
1353 to 0 or less to prevent aliases in a group.
1354 desclimit: maximum number of characters to allow in group descriptions.
1355 null (default) means to use the site-wide text limits. 0
1361 oEmbed endpoint for multimedia attachments (links in posts).
1363 endpoint: oohembed endpoint using http://oohembed.com/ software.
1368 Some stuff for search.
1370 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1371 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1372 but requires the lame old MyISAM engine for MySQL. The latter
1373 will work with InnoDB but could be miserably slow on large
1374 systems. We'll probably add another type sometime in the future,
1375 with our own indexing system (maybe like MediaWiki's).
1382 handle: boolean. Whether we should register our own PHP session-handling
1383 code (using the database and memcache if enabled). Defaults to false.
1384 Setting this to true makes some sense on large or multi-server
1385 sites, but it probably won't hurt for smaller ones, either.
1386 debug: whether to output debugging info for session storage. Can help
1387 with weird session bugs, sometimes. Default false.
1392 Users can upload backgrounds for their pages; this section defines
1395 server: the server to use for background. Using a separate (even
1396 virtual) server for this can speed up load times. Default is
1397 null; same as site server.
1398 dir: directory to write backgrounds too. Default is '/background/'
1399 subdir of install dir.
1400 path: path to backgrounds. Default is sub-path of install path; note
1401 that you may need to change this if you change site-path too.
1402 ssl: Whether or not to use HTTPS for background files. Defaults to
1403 null, meaning to guess from site-wide SSL settings.
1408 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1409 notify third-party servers of updates.
1411 notify: an array of URLs for ping endpoints. Default is the empty
1412 array (no notification).
1417 Default design (colors and background) for the site. Actual appearance
1418 depends on the theme. Null values mean to use the theme defaults.
1420 backgroundcolor: Hex color of the site background.
1421 contentcolor: Hex color of the content area background.
1422 sidebarcolor: Hex color of the sidebar background.
1423 textcolor: Hex color of all non-link text.
1424 linkcolor: Hex color of all links.
1425 backgroundimage: Image to use for the background.
1426 disposition: Flags for whether or not to tile the background image.
1431 Configuration options specific to notices.
1433 contentlimit: max length of the plain-text content of a notice.
1434 Default is null, meaning to use the site-wide text limit.
1440 Configuration options specific to messages.
1442 contentlimit: max length of the plain-text content of a message.
1443 Default is null, meaning to use the site-wide text limit.
1449 Configuration options for the login command.
1451 disabled: whether to enable this command. If enabled, users who send
1452 the text 'login' to the site through any channel will
1453 receive a link to login to the site automatically in return.
1454 Possibly useful for users who primarily use an XMPP or SMS
1455 interface and can't be bothered to remember their site
1456 password. Note that the security implications of this are
1457 pretty serious and have not been thoroughly tested. You
1458 should enable it only after you've convinced yourself that
1459 it is safe. Default is 'false'.
1464 If an installation has only one user, this can simplify a lot of the
1465 interface. It also makes the user's profile the root URL.
1467 enabled: Whether to run in "single user mode". Default false.
1468 nickname: nickname of the single user.
1473 We put out a default robots.txt file to guide the processing of
1474 Web crawlers. See http://www.robotstxt.org/ for more information
1475 on the format of this file.
1477 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1478 for the robots.txt file. see http://ur1.ca/l5a0
1479 for more information. Default is zero, no explicit delay.
1480 disallow: Array of (virtual) directories to disallow. Default is 'main',
1481 'search', 'message', 'settings', 'admin'. Ignored when site
1482 is private, in which case the entire site ('/') is disallowed.
1487 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1488 powerful plugin architecture. Important events in the code are named,
1489 like 'StartNoticeSave', and other software can register interest
1490 in those events. When the events happen, the other software is called
1491 and has a choice of accepting or rejecting the events.
1493 In the simplest case, you can add a function to config.php and use the
1494 Event::addHandler() function to hook an event:
1496 function AddGoogleLink($action)
1498 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1502 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1504 This adds a menu item to the end of the main navigation menu. You can
1505 see the list of existing events, and parameters that handlers must
1506 implement, in EVENTS.txt.
1508 The Plugin class in lib/plugin.php makes it easier to write more
1509 complex plugins. Sub-classes can just create methods named
1510 'onEventName', where 'EventName' is the name of the event (case
1511 matters!). These methods will be automatically registered as event
1512 handlers by the Plugin constructor (which you must call from your own
1513 class's constructor).
1515 Several example plugins are included in the plugins/ directory. You
1516 can enable a plugin with the following line in config.php:
1518 addPlugin('Example', array('param1' => 'value1',
1519 'param2' => 'value2'));
1521 This will look for and load files named 'ExamplePlugin.php' or
1522 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1523 plugins that ship with StatusNet) or in the local/ directory (for
1524 plugins you write yourself or that you get from somewhere else) or
1527 Plugins are documented in their own directories.
1532 The primary output for StatusNet is syslog, unless you configured a
1533 separate logfile. This is probably the first place to look if you're
1534 getting weird behaviour from StatusNet.
1536 If you're tracking the unstable version of StatusNet in the git
1537 repository (see below), and you get a compilation error ("unexpected
1538 T_STRING") in the browser, check to see that you don't have any
1539 conflicts in your code.
1541 If you upgraded to StatusNet 0.9.2 without reading the "Notice
1542 inboxes" section above, and all your users' 'Personal' tabs are empty,
1543 read the "Notice inboxes" section above.
1548 These are some myths you may see on the Web about StatusNet.
1549 Documentation from the core team about StatusNet has been pretty
1550 sparse, so some backtracking and guesswork resulted in some incorrect
1553 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1554 extremely bad idea. It's a tool built into DB_DataObject that will
1555 emit oodles of print lines directly to the browser of your users.
1556 Among these lines will be your database username and password. Do
1557 not enable this option on a production Web site for any reason.
1559 - "Edit dataobject.ini with the following settings..." dataobject.ini
1560 is a development file for the DB_DataObject framework and is not
1561 used by the running software. It was removed from the StatusNet
1562 distribution because its presence was confusing. Do not bother
1563 configuring dataobject.ini, and do not put your database username
1564 and password into the file on a production Web server; unscrupulous
1565 persons may try to read it to get your passwords.
1570 If you're adventurous or impatient, you may want to install the
1571 development version of StatusNet. To get it, use the git version
1572 control tool <http://git-scm.com/> like so:
1574 git clone git@gitorious.org:statusnet/mainline.git
1576 This is the version of the software that runs on Identi.ca and the
1577 status.net hosted service. Using it is a mixed bag. On the positive
1578 side, it usually includes the latest security and bug fix patches. On
1579 the downside, it may also include changes that require admin
1580 intervention (like running a script or even raw SQL!) that may not be
1581 documented yet. It may be a good idea to test this version before
1582 installing it on your production machines.
1584 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1589 There are several ways to get more information about StatusNet.
1591 * There is a mailing list for StatusNet developers and admins at
1592 http://mail.status.net/mailman/listinfo/statusnet-dev
1593 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1594 * The StatusNet wiki, http://status.net/wiki/
1595 * The StatusNet blog, http://status.net/blog/
1596 * The StatusNet status update, <http://status.status.net/> (!)
1601 * Microblogging messages to http://support.status.net/ are very welcome.
1602 * The microblogging group http://identi.ca/group/statusnet is a good
1603 place to discuss the software.
1604 * StatusNet has a bug tracker for any defects you may find, or ideas for
1605 making things better. http://status.net/bugs
1610 The following is an incomplete list of developers who've worked on
1611 StatusNet. Apologies for any oversight; please let evan@status.net know
1612 if anyone's been overlooked in error.
1614 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1615 * Zach Copley, StatusNet, Inc.
1616 * Earle Martin, StatusNet, Inc.
1617 * Marie-Claude Doyon, designer, StatusNet, Inc.
1618 * Sarven Capadisli, StatusNet, Inc.
1619 * Robin Millette, StatusNet, Inc.
1630 * Tryggvi Björgvinsson
1634 * Ken Sheppardson (Trac server, man-about-town)
1635 * Tiago 'gouki' Faria (i18n manager)
1637 * Leslie Michael Orchard
1641 * Tobias Diekershoff
1653 Thanks also to the developers of our upstream library code and to the
1654 thousands of people who have tried out Identi.ca, installed StatusNet,
1655 told their friends, and built the Open Microblogging network to what