5 StatusNet 0.9.0 ("Stand")
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.
49 This program is free software: you can redistribute it and/or modify
50 it under the terms of the GNU Affero General Public License as
51 published by the Free Software Foundation, either version 3 of the
52 License, or (at your option) any later version.
54 This program is distributed in the hope that it will be useful, but
55 WITHOUT ANY WARRANTY; without even the implied warranty of
56 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
57 Affero General Public License for more details.
59 You should have received a copy of the GNU Affero General Public
60 License along with this program, in the file "COPYING". If not, see
61 <http://www.gnu.org/licenses/>.
63 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
64 *different requirements* from the "regular" GPL. In particular, if
65 you make modifications to the StatusNet source code on your server,
66 you *MUST MAKE AVAILABLE* the modified version of the source code
67 to your users under the same license. This is a legal requirement
68 of using the software, and if you do not wish to share your
69 modifications, *YOU MAY NOT INSTALL STATUSNET*.
71 Additional library software has been made available in the 'extlib'
72 directory. All of it is Free Software and can be distributed under
73 liberal terms, but those terms may differ in detail from the AGPL's
74 particulars. See each package's license file in the extlib directory
80 This is a major feature release since version 0.8.3, released Feb 1
81 2010. It is the final release version of 0.9.0.
83 Notable changes this version:
85 - Support for the new distributed status update standard OStatus
86 <http://ostatus.org>, based on PubSubHubbub, Salmon, Webfinger,
88 - Support for location. Notices are (optionally) marked with lat-long
89 information, and can be shown on a map.
90 - No fixed content size. Notice size is configurable, from 1 to
91 unlimited number of characters. Default is still 140!
92 - An authorization framework, allowing different levels of users.
93 - A Web-based administration panel.
94 - A moderation system that lets site moderators sandbox, silence,
95 or delete uncooperative users.
96 - A flag system that lets users flag profiles for moderator review.
97 - Support for OAuth <http://oauth.net> authentication in the Twitter
99 - A pluggable authentication system.
100 - An authentication plugin for LDAP servers.
101 - Many features that were core in 0.8.x are now plugins, such
102 as OpenID, Twitter integration, Facebook integration
103 - A much-improved offline processing system
104 - In-browser "realtime" updates using a number of realtime
105 servers (Meteor, Orbited, Cometd)
106 - A plugin to provide an interface optimized for mobile browsers
107 - Support for Facebook Connect
108 - Support for logging in with a Twitter account
109 - Vastly improved translation with additional languages and
110 translation in plugins
111 - Support for all-SSL instances
112 - Core support for "repeats" (like Twitter's "retweets")
113 - Pluggable caching system, with plugins for Memcached,
114 APC, XCache, and a disk-based cache
115 - Plugin to support RSSCloud
116 - A framework for adding advertisements to a public site,
117 and plugins for Google AdSense and OpenX server
119 There are also literally thousands of bugs fixed and minor features
120 added. A full changelog is available at http://status.net/wiki/StatusNet_0.9.0.
122 Under the covers, the software has a vastly improved plugin and
123 extension mechanism that makes writing powerful and flexible additions
124 to the core functionality much easier.
129 The following software packages are *required* for this software to
132 - PHP 5.2.3+. It may be possible to run this software on earlier
133 versions of PHP, but many of the functions used are only available
135 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
136 server. It has been primarily tested on 5.x servers, although it may
137 be possible to install on earlier (or later!) versions. The server
138 *must* support the MyISAM storage engine -- the default for most
139 MySQL servers -- *and* the InnoDB storage engine.
140 - A Web server. Preferably, you should have Apache 2.2.x with the
141 mod_rewrite extension installed and enabled.
143 Your PHP installation must include the following PHP extensions:
145 - Curl. This is for fetching files by HTTP.
146 - XMLWriter. This is for formatting XML and HTML output.
147 - MySQL. For accessing the database.
148 - GD. For scaling down avatar images.
149 - mbstring. For handling Unicode (UTF-8) encoded strings.
150 - gettext. For multiple languages. Default on many PHP installs.
152 For some functionality, you will also need the following extensions:
154 - Memcache. A client for the memcached server, which caches database
155 information in volatile memory. This is important for adequate
156 performance on high-traffic sites. You will also need a memcached
157 server to store the data in.
158 - Mailparse. Efficient parsing of email requires this extension.
159 Submission by email or SMS-over-email uses this extension.
160 - Sphinx Search. A client for the sphinx server, an alternative
161 to MySQL or Postgresql fulltext search. You will also need a
162 Sphinx server to serve the search queries.
163 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
164 if you have OStatus configured.
166 You will almost definitely get 2-3 times better performance from your
167 site if you install a PHP bytecode cache/accelerator. Some well-known
168 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
169 is a proprietary accelerator installed on some hosting sites.
174 A number of external PHP libraries are used to provide basic
175 functionality and optional functionality for your system. For your
176 convenience, they are available in the "extlib" directory of this
177 package, and you do not have to download and install them. However,
178 you may want to keep them up-to-date with the latest upstream version,
179 and the URLs are listed here for your convenience.
181 - DB_DataObject http://pear.php.net/package/DB_DataObject
182 - Validate http://pear.php.net/package/Validate
183 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
184 to use the openidenabled.com version since it's more widely
185 implemented, and seems to be better supported.
186 http://openidenabled.com/php-openid/
187 - PEAR DB. Although this is an older data access system (new
188 packages should probably use PHP DBO), the OpenID libraries
189 depend on PEAR DB so we use it here, too. DB_DataObject can
190 also use PEAR MDB2, which may give you better performance
191 but won't work with OpenID.
192 http://pear.php.net/package/DB
193 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
194 - markdown.php from http://michelf.com/projects/php-markdown/
195 - PEAR Mail, for sending out mail notifications
196 http://pear.php.net/package/Mail
197 - PEAR Net_SMTP, if you use the SMTP factory for notifications
198 http://pear.php.net/package/Net_SMTP
199 - PEAR Net_Socket, if you use the SMTP factory for notifications
200 http://pear.php.net/package/Net_Socket
201 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
202 library available for PHP. http://xmpphp.googlecode.com/. Note that
203 as of this writing the version of this library that is available in
204 the extlib directory is *significantly different* from the upstream
205 version (patches have been submitted). Upgrading to the upstream
206 version may render your StatusNet site unable to send or receive XMPP
208 - Facebook library. Used for the Facebook application.
209 - PEAR Services_oEmbed. Used for some multimedia integration.
210 - PEAR HTTP_Request is an oEmbed dependency.
211 - PEAR Validate is an oEmbed dependency.
212 - PEAR Net_URL2 is an oEmbed dependency.
213 - Console_GetOpt for parsing command-line options.
214 - libomb. a library for implementing OpenMicroBlogging 0.1, the
215 predecessor to OStatus.
216 - HTTP_Request2, a library for making HTTP requests.
218 A design goal of StatusNet is that the basic Web functionality should
219 work on even the most restrictive commercial hosting services.
220 However, additional functionality, such as receiving messages by
221 Jabber/GTalk, require that you be able to run long-running processes
222 on your account. In addition, posting by email or from SMS require
223 that you be able to install a mail filter in your mail server.
228 Installing the basic StatusNet Web component is relatively easy,
229 especially if you've previously installed PHP/MySQL packages.
231 1. Unpack the tarball you downloaded on your Web server. Usually a
232 command like this will work:
234 tar zxf statusnet-0.9.0.tar.gz
236 ...which will make a statusnet-0.9.0 subdirectory in your current
237 directory. (If you don't have shell access on your Web server, you
238 may have to unpack the tarball on your local computer and FTP the
239 files to the server.)
241 2. Move the tarball to a directory of your choosing in your Web root
242 directory. Usually something like this will work:
244 mv statusnet-0.9.0 /var/www/statusnet
246 This will make your StatusNet instance available in the statusnet path of
247 your server, like "http://example.net/statusnet". "microblog" or
248 "statusnet" might also be good path names. If you know how to
249 configure virtual hosts on your web server, you can try setting up
250 "http://micro.example.net/" or the like.
252 3. Make your target directory writeable by the Web server.
254 chmod a+w /var/www/statusnet/
256 On some systems, this will probably work:
258 chgrp www-data /var/www/statusnet/
259 chmod g+w /var/www/statusnet/
261 If your Web server runs as another user besides "www-data", try
262 that user's default group instead. As a last resort, you can create
263 a new group like "statusnet" and add the Web server's user to the group.
265 4. You should also take this moment to make your avatar, background, and
266 file subdirectories writeable by the Web server. An insecure way to do
269 chmod a+w /var/www/statusnet/avatar
270 chmod a+w /var/www/statusnet/background
271 chmod a+w /var/www/statusnet/file
273 You can also make the avatar, background, and file directories
274 writeable by the Web server group, as noted above.
276 5. Create a database to hold your microblog data. Something like this
279 mysqladmin -u "username" --password="password" create statusnet
281 Note that StatusNet must have its own database; you can't share the
282 database with another program. You can name it whatever you want,
285 (If you don't have shell access to your server, you may need to use
286 a tool like PHPAdmin to create a database. Check your hosting
287 service's documentation for how to create a new MySQL database.)
289 6. Create a new database account that StatusNet will use to access the
290 database. If you have shell access, this will probably work from the
293 GRANT ALL on statusnet.*
294 TO 'statusnetuser'@'localhost'
295 IDENTIFIED BY 'statusnetpassword';
297 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
298 username and password. You may want to test logging in to MySQL as
301 7. In a browser, navigate to the StatusNet install script; something like:
303 http://yourserver.example.com/statusnet/install.php
305 Enter the database connection information and your site name. The
306 install program will configure your site and install the initial,
307 almost-empty database.
309 8. You should now be able to navigate to your microblog's main directory
310 and see the "Public Timeline", which will be empty. If not, magic
311 has happened! You can now register a new user, post some notices,
312 edit your profile, etc. However, you may want to wait to do that stuff
313 if you think you can set up "fancy URLs" (see below), since some
314 URLs are stored in the database.
319 By default, StatusNet will use URLs that include the main PHP program's
320 name in them. For example, a user's home profile might be
323 http://example.org/statusnet/index.php/statusnet/fred
325 On certain systems that don't support this kind of syntax, they'll
328 http://example.org/statusnet/index.php?p=statusnet/fred
330 It's possible to configure the software so it looks like this instead:
332 http://example.org/statusnet/fred
334 These "fancy URLs" are more readable and memorable for users. To use
335 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
336 mod_rewrite enabled, -OR- know how to configure "url redirection" in
339 1. Copy the htaccess.sample file to .htaccess in your StatusNet
340 directory. Note: if you have control of your server's httpd.conf or
341 similar configuration files, it can greatly improve performance to
342 import the .htaccess file into your conf file instead. If you're
343 not sure how to do it, you may save yourself a lot of headache by
344 just leaving the .htaccess file.
346 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
347 to your StatusNet installation on your server. Typically this will
348 be the path to your StatusNet directory relative to your Web root.
350 3. Add or uncomment or change a line in your config.php file so it says:
352 $config['site']['fancy'] = true;
354 You should now be able to navigate to a "fancy" URL on your server,
357 http://example.net/statusnet/main/register
359 If you changed your HTTP server configuration, you may need to restart
362 If it doesn't work, double-check that AllowOverride for the StatusNet
363 directory is 'All' in your Apache configuration file. This is usually
364 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
365 /etc/apache2/sites-available/default. See the Apache documentation for
366 .htaccess files for more details:
368 http://httpd.apache.org/docs/2.2/howto/htaccess.html
370 Also, check that mod_rewrite is installed and enabled:
372 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
377 To use a Sphinx server to search users and notices, you'll need to
378 enable the SphinxSearch plugin. Add to your config.php:
380 addPlugin('SphinxSearch');
381 $config['sphinx']['server'] = 'searchhost.local';
383 You also need to install, compile and enable the sphinx pecl extension for
384 php on the client side, which itself depends on the sphinx development files.
386 See plugins/SphinxSearch/README for more details and server setup.
391 StatusNet supports a cheap-and-dirty system for sending update messages
392 to mobile phones and for receiving updates from the mobile. Instead of
393 sending through the SMS network itself, which is costly and requires
394 buy-in from the wireless carriers, it simply piggybacks on the email
395 gateways that many carriers provide to their customers. So, SMS
396 configuration is essentially email configuration.
398 Each user sends to a made-up email address, which they keep a secret.
399 Incoming email that is "From" the user's SMS email address, and "To"
400 the users' secret email address on the site's domain, will be
401 converted to a notice and stored in the DB.
403 For this to work, there *must* be a domain or sub-domain for which all
404 (or most) incoming email can pass through the incoming mail filter.
406 1. Run the SQL script carrier.sql in your StatusNet database. This will
409 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
411 This will populate your database with a list of wireless carriers
412 that support email SMS gateways.
414 2. Make sure the maildaemon.php file is executable:
416 chmod +x scripts/maildaemon.php
418 Note that "daemon" is kind of a misnomer here; the script is more
419 of a filter than a daemon.
421 2. Edit /etc/aliases on your mail server and add the following line:
423 *: /path/to/statusnet/scripts/maildaemon.php
425 3. Run whatever code you need to to update your aliases database. For
426 many mail servers (Postfix, Exim, Sendmail), this should work:
430 You may need to restart your mail server for the new database to
433 4. Set the following in your config.php file:
435 $config['mail']['domain'] = 'yourdomain.example.net';
437 At this point, post-by-email and post-by-SMS-gateway should work. Note
438 that if your mail server is on a different computer from your email
439 server, you'll need to have a full installation of StatusNet, a working
440 config.php, and access to the StatusNet database from the mail server.
445 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
446 instant-messenger protocol that drives Jabber and GTalk IM. You can
447 distribute messages via XMPP using the system below; however, you
448 need to run the XMPP incoming daemon to allow incoming messages as
451 1. You may want to strongly consider setting up your own XMPP server.
452 Ejabberd, OpenFire, and JabberD are all Open Source servers.
453 Jabber, Inc. provides a high-performance commercial server.
455 2. You must register a Jabber ID (JID) with your new server. It helps
456 to choose a name like "update@example.com" or "notice" or something
457 similar. Alternately, your "update JID" can be registered on a
458 publicly-available XMPP service, like jabber.org or GTalk.
460 StatusNet will not register the JID with your chosen XMPP server;
461 you need to do this manually, with an XMPP client like Gajim,
462 Telepathy, or Pidgin.im.
464 3. Configure your site's XMPP variables, as described below in the
465 configuration section.
467 On a default installation, your site can broadcast messages using
468 XMPP. Users won't be able to post messages using XMPP unless you've
469 got the XMPP daemon running. See 'Queues and daemons' below for how
470 to set that up. Also, once you have a sizable number of users, sending
471 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
472 can really slow down your site; it may cause posting to timeout.
474 NOTE: stream_select(), a crucial function for network programming, is
475 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
476 work around this bug in StatusNet; current recommendation is to move
477 off of amd64 to another server.
482 You can send *all* messages from your microblogging site to a
483 third-party service using XMPP. This can be useful for providing
484 search, indexing, bridging, or other cool services.
486 To configure a downstream site to receive your public stream, add
487 their "JID" (Jabber ID) to your config.php as follows:
489 $config['xmpp']['public'][] = 'downstream@example.net';
491 (Don't miss those square brackets at the end.) Note that your XMPP
492 broadcasting must be configured as mentioned above. Although you can
493 send out messages at "Web time", high-volume sites should strongly
494 consider setting up queues and daemons.
499 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
500 and XMPP messages, can be 'queued' and done by off-line bots instead.
501 For this to work, you must be able to run long-running offline
502 processes, either on your main Web server or on another server you
503 control. (Your other server will still need all the above
504 prerequisites, with the exception of Apache.) Installing on a separate
505 server is probably a good idea for high-volume sites.
507 1. You'll need the "CLI" (command-line interface) version of PHP
508 installed on whatever server you use.
510 2. If you're using a separate server for queues, install StatusNet
511 somewhere on the server. You don't need to worry about the
512 .htaccess file, but make sure that your config.php file is close
513 to, or identical to, your Web server's version.
515 3. In your config.php files (both the Web server and the queues
516 server!), set the following variable:
518 $config['queue']['enabled'] = true;
520 You may also want to look at the 'daemon' section of this file for
521 more daemon options. Note that if you set the 'user' and/or 'group'
522 options, you'll need to create that user and/or group by hand.
523 They're not created automatically.
525 4. On the queues server, run the command scripts/startdaemons.sh.
527 This will run the queue handlers:
529 * queuedaemon.php - polls for queued items for inbox processing and
530 pushing out to OStatus, SMS, XMPP, etc.
531 * xmppdaemon.php - listens for new XMPP messages from users and stores
532 them as notices in the database; also pulls queued XMPP output from
533 queuedaemon.php to push out to clients.
535 These two daemons will automatically restart in most cases of failure
536 including memory leaks (if a memory_limit is set), but may still die
537 or behave oddly if they lose connections to the XMPP or queue servers.
539 Additional daemons may be also started by this script for certain
540 plugins, such as the Twitter bridge.
542 It may be a good idea to use a daemon-monitoring service, like 'monit',
543 to check their status and keep them running.
545 All the daemons write their process IDs (pids) to /var/run/ by
546 default. This can be useful for starting, stopping, and monitoring the
549 Since version 0.8.0, it's now possible to use a STOMP server instead of
550 our kind of hacky home-grown DB-based queue solution. This is strongly
551 recommended for best response time, especially when using XMPP.
553 See the "queues" config section below for how to configure to use STOMP.
554 As of this writing, the software has been tested with ActiveMQ 5.3.
559 There are two themes shipped with this version of StatusNet: "identica",
560 which is what the Identi.ca site uses, and "default", which is a good
561 basis for other sites.
563 As of right now, your ability to change the theme is site-wide; users
564 can't choose their own theme. Additionally, the only thing you can
565 change in the theme is CSS stylesheets and some image files; you can't
566 change the HTML output, like adding or removing menu items.
568 You can choose a theme using the $config['site']['theme'] element in
569 the config.php file. See below for details.
571 You can add your own theme by making a sub-directory of the 'theme'
572 subdirectory with the name of your theme. Each theme can have the
575 display.css: a CSS2 file for "default" styling for all browsers.
576 ie6.css: a CSS2 file for override styling for fixing up Internet
578 ie7.css: a CSS2 file for override styling for fixing up Internet
580 logo.png: a logo image for the site.
581 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
582 users who don't upload their own.
583 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
584 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
585 listing on profile pages.
587 You may want to start by copying the files from the default theme to
590 NOTE: the HTML generated by StatusNet changed *radically* between
591 version 0.6.x and 0.7.x. Older themes will need signification
592 modification to use the new output format.
597 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
598 Theoretically, you can add your own sub-directory to the locale/
599 subdirectory to add a new language to your system. You'll need to
600 compile the ".po" files into ".mo" files, however.
602 Contributions of translation information to StatusNet are very easy:
603 you can use the Web interface at TranslateWiki.net to add one
604 or a few or lots of new translations -- or even new languages. You can
605 also download more up-to-date .po files there, if you so desire.
607 For info on helping with translations, see http://status.net/wiki/Translations
612 There is no built-in system for doing backups in StatusNet. You can make
613 backups of a working StatusNet system by backing up the database and
614 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
615 and to backup the Web directory, try tar.
620 The administrator can set the "private" flag for a site so that it's
621 not visible to non-logged-in users. This might be useful for
622 workgroups who want to share a microblogging site for project
623 management, but host it on a public server.
625 Note that this is an experimental feature; total privacy is not
626 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
627 can't have some accounts or notices private, and others public.
628 Finally, the interaction of private sites with OStatus is
629 undefined. Remote users won't be able to subscribe to users on a
630 private site, but users of the private site may be able to subscribe
631 to users on a remote site. (Or not... it's not well tested.) The
632 "proper behaviour" hasn't been defined here, so handle with care.
634 Access to file attachments can also be restricted to logged-in users only.
635 1. Add a directory outside the web root where your file uploads will be
636 stored. Usually a command like this will work:
638 mkdir /var/www/statusnet-files
640 2. Make the file uploads directory writeable by the web server. An
641 insecure way to do this is:
643 chmod a+x /var/www/statusnet-files
645 3. Tell StatusNet to use this directory for file uploads. Add a line
646 like this to your config.php:
648 $config['attachments']['dir'] = '/var/www/statusnet-files';
653 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
654 incorrectly-stored international characters ("UTF-8"). For new
655 installations, it will now store non-ASCII characters correctly.
656 However, older installations will have the incorrect storage, and will
657 consequently show up "wrong" in browsers. See below for how to deal
660 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
661 been tracking the "git" version of the software, you will probably
662 want to upgrade and keep your existing data. There is no automated
663 upgrade procedure in StatusNet 0.9.0. Try these step-by-step
664 instructions; read to the end first before trying them.
666 0. Download StatusNet and set up all the prerequisites as if you were
668 1. Make backups of both your database and your Web directory. UNDER NO
669 CIRCUMSTANCES should you try to do an upgrade without a known-good
670 backup. You have been warned.
671 2. Shut down Web access to your site, either by turning off your Web
672 server or by redirecting all pages to a "sorry, under maintenance"
674 3. Shut down XMPP access to your site, typically by shutting down the
675 xmppdaemon.php process and all other daemons that you're running.
676 If you've got "monit" or "cron" automatically restarting your
677 daemons, make sure to turn that off, too.
678 4. Shut down SMS and email access to your site. The easy way to do
679 this is to comment out the line piping incoming email to your
680 maildaemon.php file, and running something like "newaliases".
681 5. Once all writing processes to your site are turned off, make a
682 final backup of the Web directory and database.
683 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
684 7. Unpack your StatusNet 0.9.0 tarball and move it to "statusnet" or
685 wherever your code used to be.
686 8. Copy the config.php file and avatar directory from your old
687 directory to your new directory.
688 9. Copy htaccess.sample to .htaccess in the new directory. Change the
689 RewriteBase to use the correct path.
690 10. Rebuild the database. (You can safely skip this step and go to #12
691 if you're upgrading from another 0.8.x version).
693 NOTE: this step is destructive and cannot be
694 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
695 do it without a known-good backup!
697 If your database is at version 0.7.4, you can run a special upgrade
700 mysql -u<rootuser> -p<rootpassword> <database> db/074to080.sql
702 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
703 BACKUP run the rebuilddb.sh script like this:
705 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
707 Here, rootuser and rootpassword are the username and password for a
708 user who can drop and create databases as well as tables; typically
709 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
710 your database and rebuilds it; if there is an error you have no
711 database. Make sure you have a backup.
712 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
713 which operates slightly differently. Read the documentation in that
714 script before running it.
715 11. Use mysql or psql client to log into your database and make sure that
716 the notice, user, profile, subscription etc. tables are non-empty.
717 12. Turn back on the Web server, and check that things still work.
718 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
719 bots have changed since version 0.5; see above for details.
721 If you're upgrading from very old versions, you may want to look at
722 the fixup_* scripts in the scripts directories. These will store some
723 precooked data in the DB. All upgraders should check out the inboxes
726 NOTE: the database definition file, laconica.ini, has been renamed to
727 statusnet.ini (since this is the recommended database name). If you
728 have a line in your config.php pointing to the old name, you'll need
734 Notice inboxes are now required. If you don't have inboxes enabled,
735 StatusNet will no longer run.
740 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
741 international characters ("UTF-8"). This fix is not
742 backwards-compatible; installations from before 0.7.4 will show
743 non-ASCII characters of old notices incorrectly. This section explains
746 0. You can disable the new behaviour by setting the 'db''utf8' config
747 option to "false". You should only do this until you're ready to
748 convert your DB to the new format.
749 1. When you're ready to convert, you can run the fixup_utf8.php script
750 in the scripts/ subdirectory. If you've had the "new behaviour"
751 enabled (probably a good idea), you can give the ID of the first
752 "new" notice as a parameter, and only notices before that one will
753 be converted. Notices are converted in reverse chronological order,
754 so the most recent (and visible) ones will be converted first. The
755 script should work whether or not you have the 'db''utf8' config
757 2. When you're ready, set $config['db']['utf8'] to true, so that
758 new notices will be stored correctly.
760 Configuration options
761 =====================
763 The main configuration file for StatusNet (excepting configurations for
764 dependency software) is config.php in your StatusNet directory. If you
765 edit any other file in the directory, like lib/common.php (where most
766 of the defaults are defined), you will lose your configuration options
767 in any upgrade, and you will wish that you had been more careful.
769 Starting with version 0.7.1, you can put config files in the
770 /etc/statusnet/ directory on your server, if it exists. Config files
771 will be included in this order:
773 * /etc/statusnet/statusnet.php - server-wide config
774 * /etc/statusnet/<servername>.php - for a virtual host
775 * /etc/statusnet/<servername>_<pathname>.php - for a path
776 * INSTALLDIR/config.php - for a particular implementation
778 Almost all configuration options are made through a two-dimensional
779 associative array, cleverly named $config. A typical configuration
782 $config['section']['option'] = value;
784 For brevity, the following documentation describes each section and
790 This section is a catch-all for site-wide variables.
792 name: the name of your site, like 'YourCompany Microblog'.
793 server: the server part of your site's URLs, like 'example.net'.
794 path: The path part of your site's URLs, like 'statusnet' or ''
796 fancy: whether or not your site uses fancy URLs (see Fancy URLs
797 section above). Default is false.
798 logfile: full path to a file for StatusNet to save logging
799 information to. You may want to use this if you don't have
801 logdebug: whether to log additional debug info like backtraces on
802 hard errors. Default false.
803 locale_path: full path to the directory for locale data. Unless you
804 store all your locale data in one place, you probably
805 don't need to use this.
806 language: default language for your site. Defaults to US English.
807 Note that this is overridden if a user is logged in and has
808 selected a different language. It is also overridden if the
809 user is NOT logged in, but their browser requests a different
810 langauge. Since pretty much everybody's browser requests a
811 language, that means that changing this setting has little or
812 no effect in practice.
813 languages: A list of languages supported on your site. Typically you'd
814 only change this if you wanted to disable support for one
816 "unset($config['site']['languages']['de'])" will disable
818 theme: Theme for your site (see Theme section). Two themes are
819 provided by default: 'default' and 'stoica' (the one used by
820 Identi.ca). It's appreciated if you don't use the 'stoica' theme
821 except as the basis for your own.
822 email: contact email address for your site. By default, it's extracted
823 from your Web server environment; you may want to customize it.
824 broughtbyurl: name of an organization or individual who provides the
825 service. Each page will include a link to this name in the
826 footer. A good way to link to the blog, forum, wiki,
827 corporate portal, or whoever is making the service available.
828 broughtby: text used for the "brought by" link.
829 timezone: default timezone for message display. Users can set their
830 own time zone. Defaults to 'UTC', which is a pretty good default.
831 closed: If set to 'true', will disallow registration on your site.
832 This is a cheap way to restrict accounts to only one
833 individual or group; just register the accounts you want on
834 the service, *then* set this variable to 'true'.
835 inviteonly: If set to 'true', will only allow registration if the user
836 was invited by an existing user.
837 private: If set to 'true', anonymous users will be redirected to the
838 'login' page. Also, API methods that normally require no
839 authentication will require it. Note that this does not turn
840 off registration; use 'closed' or 'inviteonly' for the
842 notice: A plain string that will appear on every page. A good place
843 to put introductory information about your service, or info about
844 upgrades and outages, or other community info. Any HTML will
846 logo: URL of an image file to use as the logo for the site. Overrides
847 the logo in the theme, if any.
848 ssl: Whether to use SSL and https:// URLs for some or all pages.
849 Possible values are 'always' (use it for all pages), 'never'
850 (don't use it for any pages), or 'sometimes' (use it for
851 sensitive pages that include passwords like login and registration,
852 but not for regular pages). Default to 'never'.
853 sslserver: use an alternate server name for SSL URLs, like
854 'secure.example.org'. You should be careful to set cookie
855 parameters correctly so that both the SSL server and the
856 "normal" server can access the session cookie and
857 preferably other cookies as well.
858 shorturllength: Length of URL at which URLs in a message exceeding 140
859 characters will be sent to the user's chosen
861 dupelimit: minimum time allowed for one person to say the same thing
862 twice. Default 60s. Anything lower is considered a user
864 textlimit: default max size for texts in the site. Defaults to 140.
865 0 means no limit. Can be fine-tuned for notices, messages,
866 profile bios and group descriptions.
871 This section is a reference to the configuration options for
872 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
873 set are listed below for clarity.
875 database: a DSN (Data Source Name) for your StatusNet database. This is
876 in the format 'protocol://username:password@hostname/databasename',
877 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
878 really know what you're doing), 'username' is the username,
879 'password' is the password, and etc.
880 ini_yourdbname: if your database is not named 'statusnet', you'll need
881 to set this to point to the location of the
882 statusnet.ini file. Note that the real name of your database
883 should go in there, not literally 'yourdbname'.
884 db_driver: You can try changing this to 'MDB2' to use the other driver
885 type for DB_DataObject, but note that it breaks the OpenID
886 libraries, which only support PEAR::DB.
887 debug: On a database error, you may get a message saying to set this
888 value to 5 to see debug messages in the browser. This breaks
889 just about all pages, and will also expose the username and
891 quote_identifiers: Set this to true if you're using postgresql.
892 type: either 'mysql' or 'postgresql' (used for some bits of
893 database-type-specific SQL in the code). Defaults to mysql.
894 mirror: you can set this to an array of DSNs, like the above
895 'database' value. If it's set, certain read-only actions will
896 use a random value out of this array for the database, rather
897 than the one in 'database' (actually, 'database' is overwritten).
898 You can offload a busy DB server by setting up MySQL replication
899 and adding the slaves to this array. Note that if you want some
900 requests to go to the 'database' (master) server, you'll need
901 to include it in this array, too.
902 utf8: whether to talk to the database in UTF-8 mode. This is the default
903 with new installations, but older sites may want to turn it off
904 until they get their databases fixed up. See "UTF-8 database"
906 schemacheck: when to let plugins check the database schema to add
907 tables or update them. Values can be 'runtime' (default)
908 or 'script'. 'runtime' can be costly (plugins check the
909 schema on every hit, adding potentially several db
910 queries, some quite long), but not everyone knows how to
911 run a script. If you can, set this to 'script' and run
912 scripts/checkschema.php whenever you install or upgrade a
918 By default, StatusNet sites log error messages to the syslog facility.
919 (You can override this using the 'logfile' parameter described above).
921 appname: The name that StatusNet uses to log messages. By default it's
922 "statusnet", but if you have more than one installation on the
923 server, you may want to change the name for each instance so
924 you can track log messages more easily.
925 priority: level to log at. Currently ignored.
926 facility: what syslog facility to used. Defaults to LOG_USER, only
927 reset if you know what syslog is and have a good reason
933 You can configure the software to queue time-consuming tasks, like
934 sending out SMS email or XMPP messages, for off-line processing. See
935 'Queues and daemons' above for how to set this up.
937 enabled: Whether to uses queues. Defaults to false.
938 subsystem: Which kind of queueserver to use. Values include "db" for
939 our hacked-together database queuing (no other server
940 required) and "stomp" for a stomp server.
941 stomp_server: "broker URI" for stomp server. Something like
942 "tcp://hostname:61613". More complicated ones are
943 possible; see your stomp server's documentation for
945 queue_basename: a root name to use for queues (stomp only). Typically
946 something like '/queue/sitename/' makes sense. If running
947 multiple instances on the same server, make sure that
948 either this setting or $config['site']['nickname'] are
949 unique for each site to keep them separate.
951 stomp_username: username for connecting to the stomp server; defaults
953 stomp_password: password for connecting to the stomp server; defaults
956 stomp_persistent: keep items across queue server restart, if enabled.
958 softlimit: an absolute or relative "soft memory limit"; daemons will
959 restart themselves gracefully when they find they've hit
960 this amount of memory usage. Defaults to 90% of PHP's global
961 memory_limit setting.
963 inboxes: delivery of messages to receiver's inboxes can be delayed to
964 queue time for best interactive performance on the sender.
965 This may however be annoyingly slow when using the DB queues,
966 so you can set this to false if it's causing trouble.
968 breakout: for stomp, individual queues are by default grouped up for
969 best scalability. If some need to be run by separate daemons,
970 etc they can be manually adjusted here.
972 Default will share all queues for all sites within each group.
973 Specify as <group>/<queue> or <group>/<queue>/<site>,
974 using nickname identifier as site.
976 'main/distrib' separate "distrib" queue covering all sites
977 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
979 max_retries: for stomp, drop messages after N failed attempts to process.
982 dead_letter_dir: for stomp, optional directory to dump data on failed
983 queue processing events after discarding them.
988 The default license to use for your users notices. The default is the
989 Creative Commons Attribution 3.0 license, which is probably the right
990 choice for any public site. Note that some other servers will not
991 accept notices if you apply a stricter license than this.
993 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
994 (default copyright), or 'private' (for private and confidential
996 owner: for 'allrightsreserved' or 'private', an assigned copyright
997 holder (for example, an employer for a private site). If
998 not specified, will be attributed to 'contributors'.
999 url: URL of the license, used for links.
1000 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1001 image: A button shown on each page for the license.
1006 This is for configuring out-going email. We use PEAR's Mail module,
1007 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1009 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1010 'smtp'. Defaults to PEAR's default, 'mail'.
1011 params: if the mail backend requires any parameters, you can provide
1012 them in an associative array.
1017 This is for configuring nicknames in the service.
1019 blacklist: an array of strings for usernames that may not be
1020 registered. A default array exists for strings that are
1021 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1022 but you may want to add others if you have other software
1023 installed in a subdirectory of StatusNet or if you just
1024 don't want certain words used as usernames.
1025 featured: an array of nicknames of 'featured' users of the site.
1026 Can be useful to draw attention to well-known users, or
1027 interesting people, or whatever.
1032 For configuring avatar access.
1034 dir: Directory to look for avatar files and to put them into.
1035 Defaults to avatar subdirectory of install directory; if
1036 you change it, make sure to change path, too.
1037 path: Path to avatars. Defaults to path for avatar subdirectory,
1038 but you can change it if you wish. Note that this will
1039 be included with the avatar server, too.
1040 server: If set, defines another server where avatars are stored in the
1041 root directory. Note that the 'avatar' subdir still has to be
1042 writeable. You'd typically use this to split HTTP requests on
1043 the client to speed up page loading, either with another
1044 virtual server or with an NFS or SAMBA share. Clients
1045 typically only make 2 connections to a single server at a
1046 time <http://ur1.ca/6ih>, so this can parallelize the job.
1048 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1049 to guess based on site-wide SSL settings.
1054 For configuring the public stream.
1056 localonly: If set to true, only messages posted by users of this
1057 service (rather than other services, filtered through OMB)
1058 are shown in the public stream. Default true.
1059 blacklist: An array of IDs of users to hide from the public stream.
1060 Useful if you have someone making excessive Twitterfeed posts
1061 to the site, other kinds of automated posts, testing bots, etc.
1062 autosource: Sources of notices that are from automatic posters, and thus
1063 should be kept off the public timeline. Default empty.
1068 server: Like avatars, you can speed up page loading by pointing the
1069 theme file lookup to another server (virtual or real).
1070 Defaults to NULL, meaning to use the site server.
1071 dir: Directory where theme files are stored. Used to determine
1072 whether to show parts of a theme file. Defaults to the theme
1073 subdirectory of the install directory.
1074 path: Path part of theme URLs, before the theme name. Relative to the
1075 theme server. It may make sense to change this path when upgrading,
1076 (using version numbers as the path) to make sure that all files are
1077 reloaded by caching clients or proxies. Defaults to null,
1078 which means to use the site path + '/theme'.
1079 ssl: Whether to use SSL for theme elements. Default is null, which means
1080 guess based on site SSL settings.
1085 server: You can speed up page loading by pointing the
1086 theme file lookup to another server (virtual or real).
1087 Defaults to NULL, meaning to use the site server.
1088 path: Path part of Javascript URLs. Defaults to null,
1089 which means to use the site path + '/js/'.
1090 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1091 guess based on site SSL settings.
1096 For configuring the XMPP sub-system.
1098 enabled: Whether to accept and send messages by XMPP. Default false.
1099 server: server part of XMPP ID for update user.
1100 port: connection port for clients. Default 5222, which you probably
1101 shouldn't need to change.
1102 user: username for the client connection. Users will receive messages
1103 from 'user'@'server'.
1104 resource: a unique identifier for the connection to the server. This
1105 is actually used as a prefix for each XMPP component in the system.
1106 password: password for the user account.
1107 host: some XMPP domains are served by machines with a different
1108 hostname. (For example, @gmail.com GTalk users connect to
1109 talk.google.com). Set this to the correct hostname if that's the
1110 case with your server.
1111 encryption: Whether to encrypt the connection between StatusNet and the
1112 XMPP server. Defaults to true, but you can get
1113 considerably better performance turning it off if you're
1114 connecting to a server on the same machine or on a
1116 debug: if turned on, this will make the XMPP library blurt out all of
1117 the incoming and outgoing messages as XML stanzas. Use as a
1118 last resort, and never turn it on if you don't have queues
1119 enabled, since it will spit out sensitive data to the browser.
1120 public: an array of JIDs to send _all_ notices to. This is useful for
1121 participating in third-party search and archiving services.
1126 For configuring invites.
1128 enabled: Whether to allow users to send invites. Default true.
1133 Miscellaneous tagging stuff.
1135 dropoff: Decay factor for tag listing, in seconds.
1136 Defaults to exponential decay over ten days; you can twiddle
1137 with it to try and get better results for your site.
1142 Settings for the "popular" section of the site.
1144 dropoff: Decay factor for popularity listing, in seconds.
1145 Defaults to exponential decay over ten days; you can twiddle
1146 with it to try and get better results for your site.
1151 For daemon processes.
1153 piddir: directory that daemon processes should write their PID file
1154 (process ID) to. Defaults to /var/run/, which is where this
1155 stuff should usually go on Unix-ish systems.
1156 user: If set, the daemons will try to change their effective user ID
1157 to this user before running. Probably a good idea, especially if
1158 you start the daemons as root. Note: user name, like 'daemon',
1160 group: If set, the daemons will try to change their effective group ID
1161 to this named group. Again, a name, not a numerical ID.
1166 You can get a significant boost in performance by caching some
1167 database data in memcached <http://www.danga.com/memcached/>.
1169 enabled: Set to true to enable. Default false.
1170 server: a string with the hostname of the memcached server. Can also
1171 be an array of hostnames, if you've got more than one server.
1172 base: memcached uses key-value pairs to store data. We build long,
1173 funny-looking keys to make sure we don't have any conflicts. The
1174 base of the key is usually a simplified version of the site name
1175 (like "Identi.ca" => "identica"), but you can overwrite this if
1176 you need to. You can safely ignore it if you only have one
1177 StatusNet site using your memcached server.
1178 port: Port to connect to; defaults to 11211.
1185 enabled: Whether to enable post-by-email. Defaults to true. You will
1186 also need to set up maildaemon.php.
1191 For SMS integration.
1193 enabled: Whether to enable SMS integration. Defaults to true. Queues
1194 should also be enabled.
1199 A catch-all for integration with other systems.
1201 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1208 enabled: No longer used. If you set this to something other than true,
1209 StatusNet will no longer run.
1214 For notice-posting throttles.
1216 enabled: Whether to throttle posting. Defaults to false.
1217 count: Each user can make this many posts in 'timespan' seconds. So, if count
1218 is 100 and timespan is 3600, then there can be only 100 posts
1219 from a user every hour.
1220 timespan: see 'count'.
1227 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1228 The site will reject any notices by these users -- they will
1229 not be accepted at all. (Compare with blacklisted users above,
1230 whose posts just won't show up in the public stream.)
1231 biolimit: max character length of bio; 0 means no limit; null means to use
1232 the site text limit default.
1237 Options with new users.
1239 default: nickname of a user account to automatically subscribe new
1240 users to. Typically this would be system account for e.g.
1241 service updates or announcements. Users are able to unsub
1242 if they want. Default is null; no auto subscribe.
1243 welcome: nickname of a user account that sends welcome messages to new
1244 users. Can be the same as 'default' account, although on
1245 busy servers it may be a good idea to keep that one just for
1246 'urgent' messages. Default is null; no message.
1248 If either of these special user accounts are specified, the users should
1249 be created before the configuration is updated.
1254 The software will, by default, send statistical snapshots about the
1255 local installation to a stats server on the status.net Web site. This
1256 data is used by the developers to prioritize development decisions. No
1257 identifying data about users or organizations is collected. The data
1258 is available to the public for review. Participating in this survey
1259 helps StatusNet developers take your needs into account when updating
1262 run: string indicating when to run the statistics. Values can be 'web'
1263 (run occasionally at Web time), 'cron' (run from a cron script),
1264 or 'never' (don't ever run). If you set it to 'cron', remember to
1265 schedule the script to run on a regular basis.
1266 frequency: if run value is 'web', how often to report statistics.
1267 Measured in Web hits; depends on how active your site is.
1268 Default is 10000 -- that is, one report every 10000 Web hits,
1270 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1271 report system, but if they go evil or disappear you may
1272 need to update this to another value. Note: if you
1273 don't want to report stats, it's much better to
1274 set 'run' to 'never' than to set this value to something
1280 The software lets users upload files with their notices. You can configure
1281 the types of accepted files by mime types and a trio of quota options:
1282 per file, per user (total), per user per month.
1284 We suggest the use of the pecl file_info extension to handle mime type
1287 supported: an array of mime types you accept to store and distribute,
1288 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1289 setup your server to properly recognize the types you want to
1291 uploads: false to disable uploading files with notices (true by default).
1292 filecommand: The required MIME_Type library may need to use the 'file'
1293 command. It tries the one in the Web server's path, but if
1294 you're having problems with uploads, try setting this to the
1295 correct value. Note: 'file' must accept '-b' and '-i' options.
1297 For quotas, be sure you've set the upload_max_filesize and post_max_size
1298 in php.ini to be large enough to handle your upload. In httpd.conf
1299 (if you're using apache), check that the LimitRequestBody directive isn't
1300 set too low (it's optional, so it may not be there at all).
1302 file_quota: maximum size for a single file upload in bytes. A user can send
1303 any amount of notices with attachments as long as each attachment
1304 is smaller than file_quota.
1305 user_quota: total size in bytes a user can store on this server. Each user
1306 can store any number of files as long as their total size does
1307 not exceed the user_quota.
1308 monthly_quota: total size permitted in the current month. This is the total
1309 size in bytes that a user can upload each month.
1310 dir: directory accessible to the Web process where uploads should go.
1311 Defaults to the 'file' subdirectory of the install directory, which
1312 should be writeable by the Web user.
1313 server: server name to use when creating URLs for uploaded files.
1314 Defaults to null, meaning to use the default Web server. Using
1315 a virtual server here can speed up Web performance.
1316 path: URL path, relative to the server, to find files. Defaults to
1317 main path + '/file/'.
1318 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1319 guess based on other SSL settings.
1320 filecommand: command to use for determining the type of a file. May be
1321 skipped if fileinfo extension is installed. Defaults to
1327 Options for group functionality.
1329 maxaliases: maximum number of aliases a group can have. Default 3. Set
1330 to 0 or less to prevent aliases in a group.
1331 desclimit: maximum number of characters to allow in group descriptions.
1332 null (default) means to use the site-wide text limits. 0
1338 oEmbed endpoint for multimedia attachments (links in posts).
1340 endpoint: oohembed endpoint using http://oohembed.com/ software.
1345 Some stuff for search.
1347 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1348 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1349 but requires the lame old MyISAM engine for MySQL. The latter
1350 will work with InnoDB but could be miserably slow on large
1351 systems. We'll probably add another type sometime in the future,
1352 with our own indexing system (maybe like MediaWiki's).
1359 handle: boolean. Whether we should register our own PHP session-handling
1360 code (using the database and memcache if enabled). Defaults to false.
1361 Setting this to true makes some sense on large or multi-server
1362 sites, but it probably won't hurt for smaller ones, either.
1363 debug: whether to output debugging info for session storage. Can help
1364 with weird session bugs, sometimes. Default false.
1369 Users can upload backgrounds for their pages; this section defines
1372 server: the server to use for background. Using a separate (even
1373 virtual) server for this can speed up load times. Default is
1374 null; same as site server.
1375 dir: directory to write backgrounds too. Default is '/background/'
1376 subdir of install dir.
1377 path: path to backgrounds. Default is sub-path of install path; note
1378 that you may need to change this if you change site-path too.
1379 ssl: Whether or not to use HTTPS for background files. Defaults to
1380 null, meaning to guess from site-wide SSL settings.
1385 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1386 notify third-party servers of updates.
1388 notify: an array of URLs for ping endpoints. Default is the empty
1389 array (no notification).
1394 Default design (colors and background) for the site. Actual appearance
1395 depends on the theme. Null values mean to use the theme defaults.
1397 backgroundcolor: Hex color of the site background.
1398 contentcolor: Hex color of the content area background.
1399 sidebarcolor: Hex color of the sidebar background.
1400 textcolor: Hex color of all non-link text.
1401 linkcolor: Hex color of all links.
1402 backgroundimage: Image to use for the background.
1403 disposition: Flags for whether or not to tile the background image.
1408 Configuration options specific to notices.
1410 contentlimit: max length of the plain-text content of a notice.
1411 Default is null, meaning to use the site-wide text limit.
1417 Configuration options specific to messages.
1419 contentlimit: max length of the plain-text content of a message.
1420 Default is null, meaning to use the site-wide text limit.
1426 Configuration options for the login command.
1428 disabled: whether to enable this command. If enabled, users who send
1429 the text 'login' to the site through any channel will
1430 receive a link to login to the site automatically in return.
1431 Possibly useful for users who primarily use an XMPP or SMS
1432 interface and can't be bothered to remember their site
1433 password. Note that the security implications of this are
1434 pretty serious and have not been thoroughly tested. You
1435 should enable it only after you've convinced yourself that
1436 it is safe. Default is 'false'.
1441 If an installation has only one user, this can simplify a lot of the
1442 interface. It also makes the user's profile the root URL.
1444 enabled: Whether to run in "single user mode". Default false.
1445 nickname: nickname of the single user.
1450 We put out a default robots.txt file to guide the processing of
1451 Web crawlers. See http://www.robotstxt.org/ for more information
1452 on the format of this file.
1454 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1455 for the robots.txt file. see http://ur1.ca/l5a0
1456 for more information. Default is zero, no explicit delay.
1457 disallow: Array of (virtual) directories to disallow. Default is 'main',
1458 'search', 'message', 'settings', 'admin'. Ignored when site
1459 is private, in which case the entire site ('/') is disallowed.
1464 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1465 powerful plugin architecture. Important events in the code are named,
1466 like 'StartNoticeSave', and other software can register interest
1467 in those events. When the events happen, the other software is called
1468 and has a choice of accepting or rejecting the events.
1470 In the simplest case, you can add a function to config.php and use the
1471 Event::addHandler() function to hook an event:
1473 function AddGoogleLink($action)
1475 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1479 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1481 This adds a menu item to the end of the main navigation menu. You can
1482 see the list of existing events, and parameters that handlers must
1483 implement, in EVENTS.txt.
1485 The Plugin class in lib/plugin.php makes it easier to write more
1486 complex plugins. Sub-classes can just create methods named
1487 'onEventName', where 'EventName' is the name of the event (case
1488 matters!). These methods will be automatically registered as event
1489 handlers by the Plugin constructor (which you must call from your own
1490 class's constructor).
1492 Several example plugins are included in the plugins/ directory. You
1493 can enable a plugin with the following line in config.php:
1495 addPlugin('Example', array('param1' => 'value1',
1496 'param2' => 'value2'));
1498 This will look for and load files named 'ExamplePlugin.php' or
1499 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1500 plugins that ship with StatusNet) or in the local/ directory (for
1501 plugins you write yourself or that you get from somewhere else) or
1504 Plugins are documented in their own directories.
1509 The primary output for StatusNet is syslog, unless you configured a
1510 separate logfile. This is probably the first place to look if you're
1511 getting weird behaviour from StatusNet.
1513 If you're tracking the unstable version of StatusNet in the git
1514 repository (see below), and you get a compilation error ("unexpected
1515 T_STRING") in the browser, check to see that you don't have any
1516 conflicts in your code.
1518 If you upgraded to StatusNet 0.9.0 without reading the "Notice
1519 inboxes" section above, and all your users' 'Personal' tabs are empty,
1520 read the "Notice inboxes" section above.
1525 These are some myths you may see on the Web about StatusNet.
1526 Documentation from the core team about StatusNet has been pretty
1527 sparse, so some backtracking and guesswork resulted in some incorrect
1530 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1531 extremely bad idea. It's a tool built into DB_DataObject that will
1532 emit oodles of print lines directly to the browser of your users.
1533 Among these lines will be your database username and password. Do
1534 not enable this option on a production Web site for any reason.
1536 - "Edit dataobject.ini with the following settings..." dataobject.ini
1537 is a development file for the DB_DataObject framework and is not
1538 used by the running software. It was removed from the StatusNet
1539 distribution because its presence was confusing. Do not bother
1540 configuring dataobject.ini, and do not put your database username
1541 and password into the file on a production Web server; unscrupulous
1542 persons may try to read it to get your passwords.
1547 If you're adventurous or impatient, you may want to install the
1548 development version of StatusNet. To get it, use the git version
1549 control tool <http://git-scm.com/> like so:
1551 git clone git@gitorious.org:statusnet/mainline.git
1553 This is the version of the software that runs on Identi.ca and the
1554 status.net hosted service. Using it is a mixed bag. On the positive
1555 side, it usually includes the latest security and bug fix patches. On
1556 the downside, it may also include changes that require admin
1557 intervention (like running a script or even raw SQL!) that may not be
1558 documented yet. It may be a good idea to test this version before
1559 installing it on your production machines.
1561 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1566 There are several ways to get more information about StatusNet.
1568 * There is a mailing list for StatusNet developers and admins at
1569 http://mail.status.net/mailman/listinfo/statusnet-dev
1570 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1571 * The StatusNet wiki, http://status.net/wiki/
1572 * The StatusNet blog, http://status.net/blog/
1573 * The StatusNet status update, <http://status.status.net/> (!)
1578 * Microblogging messages to http://support.status.net/ are very welcome.
1579 * The microblogging group http://identi.ca/group/statusnet is a good
1580 place to discuss the software.
1581 * StatusNet's Trac server has a bug tracker for any defects you may find,
1582 or ideas for making things better. http://status.net/trac/
1587 The following is an incomplete list of developers who've worked on
1588 StatusNet. Apologies for any oversight; please let evan@status.net know
1589 if anyone's been overlooked in error.
1591 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1592 * Zach Copley, StatusNet, Inc.
1593 * Earle Martin, StatusNet, Inc.
1594 * Marie-Claude Doyon, designer, StatusNet, Inc.
1595 * Sarven Capadisli, StatusNet, Inc.
1596 * Robin Millette, StatusNet, Inc.
1607 * Tryggvi Björgvinsson
1611 * Ken Sheppardson (Trac server, man-about-town)
1612 * Tiago 'gouki' Faria (i18n manager)
1614 * Leslie Michael Orchard
1618 * Tobias Diekershoff
1630 Thanks also to the developers of our upstream library code and to the
1631 thousands of people who have tried out Identi.ca, installed StatusNet,
1632 told their friends, and built the Open Microblogging network to what