8 This is the README file for StatusNet, the Open Source microblogging
9 platform. It includes installation instructions, descriptions of
10 options you can set, warnings, tips, and general info for
11 administrators. Information on using StatusNet can be found in the
12 "doc" subdirectory or in the "help" section on-line.
17 StatusNet is a Free and Open Source microblogging platform. It helps
18 people in a community, company or group to exchange short (140
19 characters, by default) messages over the Web. Users can choose which
20 people to "follow" and receive only their friends' or colleagues'
21 status messages. It provides a similar service to sites like Twitter,
22 Google Buzz, or Yammer.
24 With a little work, status messages can be sent to mobile phones,
25 instant messenger programs (GTalk/Jabber), and specially-designed
26 desktop clients that support the Twitter API.
28 StatusNet supports an open standard called OStatus
29 <http://ostatus.org/> that lets users in different networks follow
30 each other. It enables a distributed social network spread all across
33 StatusNet was originally developed for the Open Software Service,
34 Identi.ca <http://identi.ca/>. It is shared with you in hope that you
35 too make an Open Software Service available to your users. To learn
36 more, please see the Open Software Service Definition 1.1:
38 http://www.opendefinition.org/ossd
40 StatusNet, Inc. <http://status.net/> also offers this software as a
41 Web service, requiring no installation on your part. The software run
42 on status.net is identical to the software available for download, so
43 you can move back and forth between a hosted version or a version
44 installed on your own servers.
46 A commercial software subscription is available from StatusNet Inc. It
47 includes 24-hour technical support and developer support. More
48 information at http://status.net/contact or email sales@status.net.
53 This program is free software: you can redistribute it and/or modify
54 it under the terms of the GNU Affero General Public License as
55 published by the Free Software Foundation, either version 3 of the
56 License, or (at your option) any later version.
58 This program is distributed in the hope that it will be useful, but
59 WITHOUT ANY WARRANTY; without even the implied warranty of
60 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
61 Affero General Public License for more details.
63 You should have received a copy of the GNU Affero General Public
64 License along with this program, in the file "COPYING". If not, see
65 <http://www.gnu.org/licenses/>.
67 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
68 *different requirements* from the "regular" GPL. In particular, if
69 you make modifications to the StatusNet source code on your server,
70 you *MUST MAKE AVAILABLE* the modified version of the source code
71 to your users under the same license. This is a legal requirement
72 of using the software, and if you do not wish to share your
73 modifications, *YOU MAY NOT INSTALL STATUSNET*.
75 Additional library software has been made available in the 'extlib'
76 directory. All of it is Free Software and can be distributed under
77 liberal terms, but those terms may differ in detail from the AGPL's
78 particulars. See each package's license file in the extlib directory
84 This is a security, bug and feature release since version 0.9.3 released on
87 For best compatibility with client software and site federation, and a lot of
88 bug fixes, it is highly recommended that all public sites upgrade to the new
91 Changes from 0.9.4beta1:
92 - fix for daemon config switching on multi-site setup
94 Notable changes this version:
96 - OpenID and OAuth libraries patched for potential timing attack
97 - OStatus feed i/o updated for Activity Streams
98 - Correctness fixes on XRD, other discovery bits
99 - Support for contacting SNI-based SSL virtual hosts when SSL
100 certificate verification is enabled (requires PHP 5.3.2+ or
101 enabling CURL backend with $config['http']['curl'] = true)
102 - Experimental SubMirror plugin
103 - Multi-site status_network table mode has been tweaked to support
105 - Many updates to user interface translation from TranslateWiki
106 - Many other bugfixes
108 A full changelog is available at http://status.net/wiki/StatusNet_0.9.4.
113 The following software packages are *required* for this software to
116 - PHP 5.2.3+. It may be possible to run this software on earlier
117 versions of PHP, but many of the functions used are only available
118 in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
119 daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
120 release, but problems with some plugins are possible.
121 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
122 server. It has been primarily tested on 5.x servers, although it may
123 be possible to install on earlier (or later!) versions. The server
124 *must* support the MyISAM storage engine -- the default for most
125 MySQL servers -- *and* the InnoDB storage engine.
126 - A Web server. Preferably, you should have Apache 2.2.x with the
127 mod_rewrite extension installed and enabled.
129 Your PHP installation must include the following PHP extensions:
131 - Curl. This is for fetching files by HTTP.
132 - XMLWriter. This is for formatting XML and HTML output.
133 - MySQL. For accessing the database.
134 - GD. For scaling down avatar images.
135 - mbstring. For handling Unicode (UTF-8) encoded strings.
137 For some functionality, you will also need the following extensions:
139 - Memcache. A client for the memcached server, which caches database
140 information in volatile memory. This is important for adequate
141 performance on high-traffic sites. You will also need a memcached
142 server to store the data in.
143 - Mailparse. Efficient parsing of email requires this extension.
144 Submission by email or SMS-over-email uses this extension.
145 - Sphinx Search. A client for the sphinx server, an alternative
146 to MySQL or Postgresql fulltext search. You will also need a
147 Sphinx server to serve the search queries.
148 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
149 if you have OStatus configured.
150 - gettext. For multiple languages. Default on many PHP installs;
151 will be emulated if not present.
153 You will almost definitely get 2-3 times better performance from your
154 site if you install a PHP bytecode cache/accelerator. Some well-known
155 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
156 is a proprietary accelerator installed on some hosting sites.
161 A number of external PHP libraries are used to provide basic
162 functionality and optional functionality for your system. For your
163 convenience, they are available in the "extlib" directory of this
164 package, and you do not have to download and install them. However,
165 you may want to keep them up-to-date with the latest upstream version,
166 and the URLs are listed here for your convenience.
168 - DB_DataObject http://pear.php.net/package/DB_DataObject
169 - Validate http://pear.php.net/package/Validate
170 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
171 to use the openidenabled.com version since it's more widely
172 implemented, and seems to be better supported.
173 http://openidenabled.com/php-openid/
174 - PEAR DB. Although this is an older data access system (new
175 packages should probably use PHP DBO), the OpenID libraries
176 depend on PEAR DB so we use it here, too. DB_DataObject can
177 also use PEAR MDB2, which may give you better performance
178 but won't work with OpenID.
179 http://pear.php.net/package/DB
180 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
181 - markdown.php from http://michelf.com/projects/php-markdown/
182 - PEAR Mail, for sending out mail notifications
183 http://pear.php.net/package/Mail
184 - PEAR Net_SMTP, if you use the SMTP factory for notifications
185 http://pear.php.net/package/Net_SMTP
186 - PEAR Net_Socket, if you use the SMTP factory for notifications
187 http://pear.php.net/package/Net_Socket
188 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
189 library available for PHP. http://xmpphp.googlecode.com/. Note that
190 as of this writing the version of this library that is available in
191 the extlib directory is *significantly different* from the upstream
192 version (patches have been submitted). Upgrading to the upstream
193 version may render your StatusNet site unable to send or receive XMPP
195 - Facebook library. Used for the Facebook application.
196 - PEAR Services_oEmbed. Used for some multimedia integration.
197 - PEAR HTTP_Request is an oEmbed dependency.
198 - PEAR Validate is an oEmbed dependency.
199 - PEAR Net_URL2 is an oEmbed dependency.
200 - Console_GetOpt for parsing command-line options.
201 - libomb. a library for implementing OpenMicroBlogging 0.1, the
202 predecessor to OStatus.
203 - HTTP_Request2, a library for making HTTP requests.
205 A design goal of StatusNet is that the basic Web functionality should
206 work on even the most restrictive commercial hosting services.
207 However, additional functionality, such as receiving messages by
208 Jabber/GTalk, require that you be able to run long-running processes
209 on your account. In addition, posting by email or from SMS require
210 that you be able to install a mail filter in your mail server.
215 Installing the basic StatusNet Web component is relatively easy,
216 especially if you've previously installed PHP/MySQL packages.
218 1. Unpack the tarball you downloaded on your Web server. Usually a
219 command like this will work:
221 tar zxf statusnet-0.9.4.tar.gz
223 ...which will make a statusnet-0.9.2 subdirectory in your current
224 directory. (If you don't have shell access on your Web server, you
225 may have to unpack the tarball on your local computer and FTP the
226 files to the server.)
228 2. Move the tarball to a directory of your choosing in your Web root
229 directory. Usually something like this will work:
231 mv statusnet-0.9.4 /var/www/statusnet
233 This will make your StatusNet instance available in the statusnet path of
234 your server, like "http://example.net/statusnet". "microblog" or
235 "statusnet" might also be good path names. If you know how to
236 configure virtual hosts on your web server, you can try setting up
237 "http://micro.example.net/" or the like.
239 3. Make your target directory writeable by the Web server.
241 chmod a+w /var/www/statusnet/
243 On some systems, this will probably work:
245 chgrp www-data /var/www/statusnet/
246 chmod g+w /var/www/statusnet/
248 If your Web server runs as another user besides "www-data", try
249 that user's default group instead. As a last resort, you can create
250 a new group like "statusnet" and add the Web server's user to the group.
252 4. You should also take this moment to make your avatar, background, and
253 file subdirectories writeable by the Web server. An insecure way to do
256 chmod a+w /var/www/statusnet/avatar
257 chmod a+w /var/www/statusnet/background
258 chmod a+w /var/www/statusnet/file
260 You can also make the avatar, background, and file directories
261 writeable by the Web server group, as noted above.
263 5. Create a database to hold your microblog data. Something like this
266 mysqladmin -u "username" --password="password" create statusnet
268 Note that StatusNet must have its own database; you can't share the
269 database with another program. You can name it whatever you want,
272 (If you don't have shell access to your server, you may need to use
273 a tool like PHPAdmin to create a database. Check your hosting
274 service's documentation for how to create a new MySQL database.)
276 6. Create a new database account that StatusNet will use to access the
277 database. If you have shell access, this will probably work from the
280 GRANT ALL on statusnet.*
281 TO 'statusnetuser'@'localhost'
282 IDENTIFIED BY 'statusnetpassword';
284 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
285 username and password. You may want to test logging in to MySQL as
288 7. In a browser, navigate to the StatusNet install script; something like:
290 http://yourserver.example.com/statusnet/install.php
292 Enter the database connection information and your site name. The
293 install program will configure your site and install the initial,
294 almost-empty database.
296 8. You should now be able to navigate to your microblog's main directory
297 and see the "Public Timeline", which will be empty. If not, magic
298 has happened! You can now register a new user, post some notices,
299 edit your profile, etc. However, you may want to wait to do that stuff
300 if you think you can set up "fancy URLs" (see below), since some
301 URLs are stored in the database.
306 By default, StatusNet will use URLs that include the main PHP program's
307 name in them. For example, a user's home profile might be
310 http://example.org/statusnet/index.php/statusnet/fred
312 On certain systems that don't support this kind of syntax, they'll
315 http://example.org/statusnet/index.php?p=statusnet/fred
317 It's possible to configure the software so it looks like this instead:
319 http://example.org/statusnet/fred
321 These "fancy URLs" are more readable and memorable for users. To use
322 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
323 mod_rewrite enabled, -OR- know how to configure "url redirection" in
326 1. Copy the htaccess.sample file to .htaccess in your StatusNet
327 directory. Note: if you have control of your server's httpd.conf or
328 similar configuration files, it can greatly improve performance to
329 import the .htaccess file into your conf file instead. If you're
330 not sure how to do it, you may save yourself a lot of headache by
331 just leaving the .htaccess file.
333 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
334 to your StatusNet installation on your server. Typically this will
335 be the path to your StatusNet directory relative to your Web root.
337 3. Add or uncomment or change a line in your config.php file so it says:
339 $config['site']['fancy'] = true;
341 You should now be able to navigate to a "fancy" URL on your server,
344 http://example.net/statusnet/main/register
346 If you changed your HTTP server configuration, you may need to restart
349 If it doesn't work, double-check that AllowOverride for the StatusNet
350 directory is 'All' in your Apache configuration file. This is usually
351 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
352 /etc/apache2/sites-available/default. See the Apache documentation for
353 .htaccess files for more details:
355 http://httpd.apache.org/docs/2.2/howto/htaccess.html
357 Also, check that mod_rewrite is installed and enabled:
359 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
364 To use a Sphinx server to search users and notices, you'll need to
365 enable the SphinxSearch plugin. Add to your config.php:
367 addPlugin('SphinxSearch');
368 $config['sphinx']['server'] = 'searchhost.local';
370 You also need to install, compile and enable the sphinx pecl extension for
371 php on the client side, which itself depends on the sphinx development files.
373 See plugins/SphinxSearch/README for more details and server setup.
378 StatusNet supports a cheap-and-dirty system for sending update messages
379 to mobile phones and for receiving updates from the mobile. Instead of
380 sending through the SMS network itself, which is costly and requires
381 buy-in from the wireless carriers, it simply piggybacks on the email
382 gateways that many carriers provide to their customers. So, SMS
383 configuration is essentially email configuration.
385 Each user sends to a made-up email address, which they keep a secret.
386 Incoming email that is "From" the user's SMS email address, and "To"
387 the users' secret email address on the site's domain, will be
388 converted to a notice and stored in the DB.
390 For this to work, there *must* be a domain or sub-domain for which all
391 (or most) incoming email can pass through the incoming mail filter.
393 1. Run the SQL script carrier.sql in your StatusNet database. This will
396 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
398 This will populate your database with a list of wireless carriers
399 that support email SMS gateways.
401 2. Make sure the maildaemon.php file is executable:
403 chmod +x scripts/maildaemon.php
405 Note that "daemon" is kind of a misnomer here; the script is more
406 of a filter than a daemon.
408 2. Edit /etc/aliases on your mail server and add the following line:
410 *: /path/to/statusnet/scripts/maildaemon.php
412 3. Run whatever code you need to to update your aliases database. For
413 many mail servers (Postfix, Exim, Sendmail), this should work:
417 You may need to restart your mail server for the new database to
420 4. Set the following in your config.php file:
422 $config['mail']['domain'] = 'yourdomain.example.net';
424 At this point, post-by-email and post-by-SMS-gateway should work. Note
425 that if your mail server is on a different computer from your email
426 server, you'll need to have a full installation of StatusNet, a working
427 config.php, and access to the StatusNet database from the mail server.
432 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
433 instant-messenger protocol that drives Jabber and GTalk IM. You can
434 distribute messages via XMPP using the system below; however, you
435 need to run the XMPP incoming daemon to allow incoming messages as
438 1. You may want to strongly consider setting up your own XMPP server.
439 Ejabberd, OpenFire, and JabberD are all Open Source servers.
440 Jabber, Inc. provides a high-performance commercial server.
442 2. You must register a Jabber ID (JID) with your new server. It helps
443 to choose a name like "update@example.com" or "notice" or something
444 similar. Alternately, your "update JID" can be registered on a
445 publicly-available XMPP service, like jabber.org or GTalk.
447 StatusNet will not register the JID with your chosen XMPP server;
448 you need to do this manually, with an XMPP client like Gajim,
449 Telepathy, or Pidgin.im.
451 3. Configure your site's XMPP variables, as described below in the
452 configuration section.
454 On a default installation, your site can broadcast messages using
455 XMPP. Users won't be able to post messages using XMPP unless you've
456 got the XMPP daemon running. See 'Queues and daemons' below for how
457 to set that up. Also, once you have a sizable number of users, sending
458 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
459 can really slow down your site; it may cause posting to timeout.
461 NOTE: stream_select(), a crucial function for network programming, is
462 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
463 work around this bug in StatusNet; current recommendation is to move
464 off of amd64 to another server.
469 You can send *all* messages from your microblogging site to a
470 third-party service using XMPP. This can be useful for providing
471 search, indexing, bridging, or other cool services.
473 To configure a downstream site to receive your public stream, add
474 their "JID" (Jabber ID) to your config.php as follows:
476 $config['xmpp']['public'][] = 'downstream@example.net';
478 (Don't miss those square brackets at the end.) Note that your XMPP
479 broadcasting must be configured as mentioned above. Although you can
480 send out messages at "Web time", high-volume sites should strongly
481 consider setting up queues and daemons.
486 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
487 and XMPP messages, can be 'queued' and done by off-line bots instead.
488 For this to work, you must be able to run long-running offline
489 processes, either on your main Web server or on another server you
490 control. (Your other server will still need all the above
491 prerequisites, with the exception of Apache.) Installing on a separate
492 server is probably a good idea for high-volume sites.
494 1. You'll need the "CLI" (command-line interface) version of PHP
495 installed on whatever server you use.
497 2. If you're using a separate server for queues, install StatusNet
498 somewhere on the server. You don't need to worry about the
499 .htaccess file, but make sure that your config.php file is close
500 to, or identical to, your Web server's version.
502 3. In your config.php files (both the Web server and the queues
503 server!), set the following variable:
505 $config['queue']['enabled'] = true;
507 You may also want to look at the 'daemon' section of this file for
508 more daemon options. Note that if you set the 'user' and/or 'group'
509 options, you'll need to create that user and/or group by hand.
510 They're not created automatically.
512 4. On the queues server, run the command scripts/startdaemons.sh.
514 This will run the queue handlers:
516 * queuedaemon.php - polls for queued items for inbox processing and
517 pushing out to OStatus, SMS, XMPP, etc.
518 * xmppdaemon.php - listens for new XMPP messages from users and stores
519 them as notices in the database; also pulls queued XMPP output from
520 queuedaemon.php to push out to clients.
522 These two daemons will automatically restart in most cases of failure
523 including memory leaks (if a memory_limit is set), but may still die
524 or behave oddly if they lose connections to the XMPP or queue servers.
526 Additional daemons may be also started by this script for certain
527 plugins, such as the Twitter bridge.
529 It may be a good idea to use a daemon-monitoring service, like 'monit',
530 to check their status and keep them running.
532 All the daemons write their process IDs (pids) to /var/run/ by
533 default. This can be useful for starting, stopping, and monitoring the
536 Since version 0.8.0, it's now possible to use a STOMP server instead of
537 our kind of hacky home-grown DB-based queue solution. This is strongly
538 recommended for best response time, especially when using XMPP.
540 See the "queues" config section below for how to configure to use STOMP.
541 As of this writing, the software has been tested with ActiveMQ 5.3.
546 There are two themes shipped with this version of StatusNet: "identica",
547 which is what the Identi.ca site uses, and "default", which is a good
548 basis for other sites.
550 As of right now, your ability to change the theme is site-wide; users
551 can't choose their own theme. Additionally, the only thing you can
552 change in the theme is CSS stylesheets and some image files; you can't
553 change the HTML output, like adding or removing menu items.
555 You can choose a theme using the $config['site']['theme'] element in
556 the config.php file. See below for details.
558 You can add your own theme by making a sub-directory of the 'theme'
559 subdirectory with the name of your theme. Each theme can have the
562 display.css: a CSS2 file for "default" styling for all browsers.
563 ie6.css: a CSS2 file for override styling for fixing up Internet
565 ie7.css: a CSS2 file for override styling for fixing up Internet
567 logo.png: a logo image for the site.
568 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
569 users who don't upload their own.
570 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
571 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
572 listing on profile pages.
574 You may want to start by copying the files from the default theme to
577 NOTE: the HTML generated by StatusNet changed *radically* between
578 version 0.6.x and 0.7.x. Older themes will need signification
579 modification to use the new output format.
584 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
585 Theoretically, you can add your own sub-directory to the locale/
586 subdirectory to add a new language to your system. You'll need to
587 compile the ".po" files into ".mo" files, however.
589 Contributions of translation information to StatusNet are very easy:
590 you can use the Web interface at TranslateWiki.net to add one
591 or a few or lots of new translations -- or even new languages. You can
592 also download more up-to-date .po files there, if you so desire.
594 For info on helping with translations, see http://status.net/wiki/Translations
599 There is no built-in system for doing backups in StatusNet. You can make
600 backups of a working StatusNet system by backing up the database and
601 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
602 and to backup the Web directory, try tar.
607 The administrator can set the "private" flag for a site so that it's
608 not visible to non-logged-in users. This might be useful for
609 workgroups who want to share a microblogging site for project
610 management, but host it on a public server.
612 Total privacy is not guaranteed or ensured. Also, privacy is
613 all-or-nothing for a site; you can't have some accounts or notices
614 private, and others public. The interaction of private sites
615 with OStatus is undefined.
617 Access to file attachments can also be restricted to logged-in users only.
618 1. Add a directory outside the web root where your file uploads will be
619 stored. Usually a command like this will work:
621 mkdir /var/www/statusnet-files
623 2. Make the file uploads directory writeable by the web server. An
624 insecure way to do this is:
626 chmod a+x /var/www/statusnet-files
628 3. Tell StatusNet to use this directory for file uploads. Add a line
629 like this to your config.php:
631 $config['attachments']['dir'] = '/var/www/statusnet-files';
636 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
637 incorrectly-stored international characters ("UTF-8"). For new
638 installations, it will now store non-ASCII characters correctly.
639 However, older installations will have the incorrect storage, and will
640 consequently show up "wrong" in browsers. See below for how to deal
643 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
644 been tracking the "git" version of the software, you will probably
645 want to upgrade and keep your existing data. There is no automated
646 upgrade procedure in StatusNet 0.9.2. Try these step-by-step
647 instructions; read to the end first before trying them.
649 0. Download StatusNet and set up all the prerequisites as if you were
651 1. Make backups of both your database and your Web directory. UNDER NO
652 CIRCUMSTANCES should you try to do an upgrade without a known-good
653 backup. You have been warned.
654 2. Shut down Web access to your site, either by turning off your Web
655 server or by redirecting all pages to a "sorry, under maintenance"
657 3. Shut down XMPP access to your site, typically by shutting down the
658 xmppdaemon.php process and all other daemons that you're running.
659 If you've got "monit" or "cron" automatically restarting your
660 daemons, make sure to turn that off, too.
661 4. Shut down SMS and email access to your site. The easy way to do
662 this is to comment out the line piping incoming email to your
663 maildaemon.php file, and running something like "newaliases".
664 5. Once all writing processes to your site are turned off, make a
665 final backup of the Web directory and database.
666 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
667 7. Unpack your StatusNet 0.9.2 tarball and move it to "statusnet" or
668 wherever your code used to be.
669 8. Copy the config.php file and avatar directory from your old
670 directory to your new directory.
671 9. Copy htaccess.sample to .htaccess in the new directory. Change the
672 RewriteBase to use the correct path.
673 10. Rebuild the database. (You can safely skip this step and go to #12
674 if you're upgrading from another 0.9.x version).
676 NOTE: this step is destructive and cannot be
677 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
678 do it without a known-good backup!
680 If your database is at version 0.8.0 or above, you can run a
681 special upgrade script:
683 mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
685 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
686 BACKUP run the rebuilddb.sh script like this:
688 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
690 Here, rootuser and rootpassword are the username and password for a
691 user who can drop and create databases as well as tables; typically
692 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
693 your database and rebuilds it; if there is an error you have no
694 database. Make sure you have a backup.
695 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
696 which operates slightly differently. Read the documentation in that
697 script before running it.
698 11. Use mysql or psql client to log into your database and make sure that
699 the notice, user, profile, subscription etc. tables are non-empty.
700 12. Turn back on the Web server, and check that things still work.
701 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
702 bots have changed since version 0.5; see above for details.
704 If you're upgrading from very old versions, you may want to look at
705 the fixup_* scripts in the scripts directories. These will store some
706 precooked data in the DB. All upgraders should check out the inboxes
709 NOTE: the database definition file, laconica.ini, has been renamed to
710 statusnet.ini (since this is the recommended database name). If you
711 have a line in your config.php pointing to the old name, you'll need
717 Notice inboxes are now required. If you don't have inboxes enabled,
718 StatusNet will no longer run.
723 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
724 international characters ("UTF-8"). This fix is not
725 backwards-compatible; installations from before 0.7.4 will show
726 non-ASCII characters of old notices incorrectly. This section explains
729 0. You can disable the new behaviour by setting the 'db''utf8' config
730 option to "false". You should only do this until you're ready to
731 convert your DB to the new format.
732 1. When you're ready to convert, you can run the fixup_utf8.php script
733 in the scripts/ subdirectory. If you've had the "new behaviour"
734 enabled (probably a good idea), you can give the ID of the first
735 "new" notice as a parameter, and only notices before that one will
736 be converted. Notices are converted in reverse chronological order,
737 so the most recent (and visible) ones will be converted first. The
738 script should work whether or not you have the 'db''utf8' config
740 2. When you're ready, set $config['db']['utf8'] to true, so that
741 new notices will be stored correctly.
743 Configuration options
744 =====================
746 The main configuration file for StatusNet (excepting configurations for
747 dependency software) is config.php in your StatusNet directory. If you
748 edit any other file in the directory, like lib/default.php (where most
749 of the defaults are defined), you will lose your configuration options
750 in any upgrade, and you will wish that you had been more careful.
752 Starting with version 0.9.0, a Web based configuration panel has been
753 added to StatusNet. The preferred method for changing config options is
756 A command-line script, setconfig.php, can be used to set individual
757 configuration options. It's in the scripts/ directory.
759 Starting with version 0.7.1, you can put config files in the
760 /etc/statusnet/ directory on your server, if it exists. Config files
761 will be included in this order:
763 * /etc/statusnet/statusnet.php - server-wide config
764 * /etc/statusnet/<servername>.php - for a virtual host
765 * /etc/statusnet/<servername>_<pathname>.php - for a path
766 * INSTALLDIR/config.php - for a particular implementation
768 Almost all configuration options are made through a two-dimensional
769 associative array, cleverly named $config. A typical configuration
772 $config['section']['option'] = value;
774 For brevity, the following documentation describes each section and
780 This section is a catch-all for site-wide variables.
782 name: the name of your site, like 'YourCompany Microblog'.
783 server: the server part of your site's URLs, like 'example.net'.
784 path: The path part of your site's URLs, like 'statusnet' or ''
786 fancy: whether or not your site uses fancy URLs (see Fancy URLs
787 section above). Default is false.
788 logfile: full path to a file for StatusNet to save logging
789 information to. You may want to use this if you don't have
791 logdebug: whether to log additional debug info like backtraces on
792 hard errors. Default false.
793 locale_path: full path to the directory for locale data. Unless you
794 store all your locale data in one place, you probably
795 don't need to use this.
796 language: default language for your site. Defaults to US English.
797 Note that this is overridden if a user is logged in and has
798 selected a different language. It is also overridden if the
799 user is NOT logged in, but their browser requests a different
800 langauge. Since pretty much everybody's browser requests a
801 language, that means that changing this setting has little or
802 no effect in practice.
803 languages: A list of languages supported on your site. Typically you'd
804 only change this if you wanted to disable support for one
806 "unset($config['site']['languages']['de'])" will disable
808 theme: Theme for your site (see Theme section). Two themes are
809 provided by default: 'default' and 'stoica' (the one used by
810 Identi.ca). It's appreciated if you don't use the 'stoica' theme
811 except as the basis for your own.
812 email: contact email address for your site. By default, it's extracted
813 from your Web server environment; you may want to customize it.
814 broughtbyurl: name of an organization or individual who provides the
815 service. Each page will include a link to this name in the
816 footer. A good way to link to the blog, forum, wiki,
817 corporate portal, or whoever is making the service available.
818 broughtby: text used for the "brought by" link.
819 timezone: default timezone for message display. Users can set their
820 own time zone. Defaults to 'UTC', which is a pretty good default.
821 closed: If set to 'true', will disallow registration on your site.
822 This is a cheap way to restrict accounts to only one
823 individual or group; just register the accounts you want on
824 the service, *then* set this variable to 'true'.
825 inviteonly: If set to 'true', will only allow registration if the user
826 was invited by an existing user.
827 private: If set to 'true', anonymous users will be redirected to the
828 'login' page. Also, API methods that normally require no
829 authentication will require it. Note that this does not turn
830 off registration; use 'closed' or 'inviteonly' for the
832 notice: A plain string that will appear on every page. A good place
833 to put introductory information about your service, or info about
834 upgrades and outages, or other community info. Any HTML will
836 logo: URL of an image file to use as the logo for the site. Overrides
837 the logo in the theme, if any.
838 ssl: Whether to use SSL and https:// URLs for some or all pages.
839 Possible values are 'always' (use it for all pages), 'never'
840 (don't use it for any pages), or 'sometimes' (use it for
841 sensitive pages that include passwords like login and registration,
842 but not for regular pages). Default to 'never'.
843 sslserver: use an alternate server name for SSL URLs, like
844 'secure.example.org'. You should be careful to set cookie
845 parameters correctly so that both the SSL server and the
846 "normal" server can access the session cookie and
847 preferably other cookies as well.
848 shorturllength: Length of URL at which URLs in a message exceeding 140
849 characters will be sent to the user's chosen
851 dupelimit: minimum time allowed for one person to say the same thing
852 twice. Default 60s. Anything lower is considered a user
854 textlimit: default max size for texts in the site. Defaults to 140.
855 0 means no limit. Can be fine-tuned for notices, messages,
856 profile bios and group descriptions.
861 This section is a reference to the configuration options for
862 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
863 set are listed below for clarity.
865 database: a DSN (Data Source Name) for your StatusNet database. This is
866 in the format 'protocol://username:password@hostname/databasename',
867 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
868 really know what you're doing), 'username' is the username,
869 'password' is the password, and etc.
870 ini_yourdbname: if your database is not named 'statusnet', you'll need
871 to set this to point to the location of the
872 statusnet.ini file. Note that the real name of your database
873 should go in there, not literally 'yourdbname'.
874 db_driver: You can try changing this to 'MDB2' to use the other driver
875 type for DB_DataObject, but note that it breaks the OpenID
876 libraries, which only support PEAR::DB.
877 debug: On a database error, you may get a message saying to set this
878 value to 5 to see debug messages in the browser. This breaks
879 just about all pages, and will also expose the username and
881 quote_identifiers: Set this to true if you're using postgresql.
882 type: either 'mysql' or 'postgresql' (used for some bits of
883 database-type-specific SQL in the code). Defaults to mysql.
884 mirror: you can set this to an array of DSNs, like the above
885 'database' value. If it's set, certain read-only actions will
886 use a random value out of this array for the database, rather
887 than the one in 'database' (actually, 'database' is overwritten).
888 You can offload a busy DB server by setting up MySQL replication
889 and adding the slaves to this array. Note that if you want some
890 requests to go to the 'database' (master) server, you'll need
891 to include it in this array, too.
892 utf8: whether to talk to the database in UTF-8 mode. This is the default
893 with new installations, but older sites may want to turn it off
894 until they get their databases fixed up. See "UTF-8 database"
896 schemacheck: when to let plugins check the database schema to add
897 tables or update them. Values can be 'runtime' (default)
898 or 'script'. 'runtime' can be costly (plugins check the
899 schema on every hit, adding potentially several db
900 queries, some quite long), but not everyone knows how to
901 run a script. If you can, set this to 'script' and run
902 scripts/checkschema.php whenever you install or upgrade a
908 By default, StatusNet sites log error messages to the syslog facility.
909 (You can override this using the 'logfile' parameter described above).
911 appname: The name that StatusNet uses to log messages. By default it's
912 "statusnet", but if you have more than one installation on the
913 server, you may want to change the name for each instance so
914 you can track log messages more easily.
915 priority: level to log at. Currently ignored.
916 facility: what syslog facility to used. Defaults to LOG_USER, only
917 reset if you know what syslog is and have a good reason
923 You can configure the software to queue time-consuming tasks, like
924 sending out SMS email or XMPP messages, for off-line processing. See
925 'Queues and daemons' above for how to set this up.
927 enabled: Whether to uses queues. Defaults to false.
928 subsystem: Which kind of queueserver to use. Values include "db" for
929 our hacked-together database queuing (no other server
930 required) and "stomp" for a stomp server.
931 stomp_server: "broker URI" for stomp server. Something like
932 "tcp://hostname:61613". More complicated ones are
933 possible; see your stomp server's documentation for
935 queue_basename: a root name to use for queues (stomp only). Typically
936 something like '/queue/sitename/' makes sense. If running
937 multiple instances on the same server, make sure that
938 either this setting or $config['site']['nickname'] are
939 unique for each site to keep them separate.
941 stomp_username: username for connecting to the stomp server; defaults
943 stomp_password: password for connecting to the stomp server; defaults
946 stomp_persistent: keep items across queue server restart, if enabled.
947 Under ActiveMQ, the server configuration determines if and how
948 persistent storage is actually saved.
950 If using a message queue server other than ActiveMQ, you may
951 need to disable this if it does not support persistence.
953 stomp_transactions: use transactions to aid in error detection.
954 A broken transaction will be seen quickly, allowing a message
955 to be redelivered immediately if a daemon crashes.
957 If using a message queue server other than ActiveMQ, you may
958 need to disable this if it does not support transactions.
960 stomp_acks: send acknowledgements to aid in flow control.
961 An acknowledgement of successful processing tells the server
962 we're ready for more and can help keep things moving smoothly.
964 This should *not* be turned off when running with ActiveMQ, but
965 if using another message queue server that does not support
966 acknowledgements you might need to disable this.
968 softlimit: an absolute or relative "soft memory limit"; daemons will
969 restart themselves gracefully when they find they've hit
970 this amount of memory usage. Defaults to 90% of PHP's global
971 memory_limit setting.
973 inboxes: delivery of messages to receiver's inboxes can be delayed to
974 queue time for best interactive performance on the sender.
975 This may however be annoyingly slow when using the DB queues,
976 so you can set this to false if it's causing trouble.
978 breakout: for stomp, individual queues are by default grouped up for
979 best scalability. If some need to be run by separate daemons,
980 etc they can be manually adjusted here.
982 Default will share all queues for all sites within each group.
983 Specify as <group>/<queue> or <group>/<queue>/<site>,
984 using nickname identifier as site.
986 'main/distrib' separate "distrib" queue covering all sites
987 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
989 max_retries: for stomp, drop messages after N failed attempts to process.
992 dead_letter_dir: for stomp, optional directory to dump data on failed
993 queue processing events after discarding them.
995 stomp_no_transactions: for stomp, the server does not support transactions,
996 so do not try to user them. This is needed for http://www.morbidq.com/.
998 stomp_no_acks: for stomp, the server does not support acknowledgements.
999 so do not try to user them. This is needed for http://www.morbidq.com/.
1004 The default license to use for your users notices. The default is the
1005 Creative Commons Attribution 3.0 license, which is probably the right
1006 choice for any public site. Note that some other servers will not
1007 accept notices if you apply a stricter license than this.
1009 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1010 (default copyright), or 'private' (for private and confidential
1012 owner: for 'allrightsreserved' or 'private', an assigned copyright
1013 holder (for example, an employer for a private site). If
1014 not specified, will be attributed to 'contributors'.
1015 url: URL of the license, used for links.
1016 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1017 image: A button shown on each page for the license.
1022 This is for configuring out-going email. We use PEAR's Mail module,
1023 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1025 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1026 'smtp'. Defaults to PEAR's default, 'mail'.
1027 params: if the mail backend requires any parameters, you can provide
1028 them in an associative array.
1033 This is for configuring nicknames in the service.
1035 blacklist: an array of strings for usernames that may not be
1036 registered. A default array exists for strings that are
1037 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1038 but you may want to add others if you have other software
1039 installed in a subdirectory of StatusNet or if you just
1040 don't want certain words used as usernames.
1041 featured: an array of nicknames of 'featured' users of the site.
1042 Can be useful to draw attention to well-known users, or
1043 interesting people, or whatever.
1048 For configuring avatar access.
1050 dir: Directory to look for avatar files and to put them into.
1051 Defaults to avatar subdirectory of install directory; if
1052 you change it, make sure to change path, too.
1053 path: Path to avatars. Defaults to path for avatar subdirectory,
1054 but you can change it if you wish. Note that this will
1055 be included with the avatar server, too.
1056 server: If set, defines another server where avatars are stored in the
1057 root directory. Note that the 'avatar' subdir still has to be
1058 writeable. You'd typically use this to split HTTP requests on
1059 the client to speed up page loading, either with another
1060 virtual server or with an NFS or SAMBA share. Clients
1061 typically only make 2 connections to a single server at a
1062 time <http://ur1.ca/6ih>, so this can parallelize the job.
1064 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1065 to guess based on site-wide SSL settings.
1070 For configuring the public stream.
1072 localonly: If set to true, only messages posted by users of this
1073 service (rather than other services, filtered through OMB)
1074 are shown in the public stream. Default true.
1075 blacklist: An array of IDs of users to hide from the public stream.
1076 Useful if you have someone making excessive Twitterfeed posts
1077 to the site, other kinds of automated posts, testing bots, etc.
1078 autosource: Sources of notices that are from automatic posters, and thus
1079 should be kept off the public timeline. Default empty.
1084 server: Like avatars, you can speed up page loading by pointing the
1085 theme file lookup to another server (virtual or real).
1086 Defaults to NULL, meaning to use the site server.
1087 dir: Directory where theme files are stored. Used to determine
1088 whether to show parts of a theme file. Defaults to the theme
1089 subdirectory of the install directory.
1090 path: Path part of theme URLs, before the theme name. Relative to the
1091 theme server. It may make sense to change this path when upgrading,
1092 (using version numbers as the path) to make sure that all files are
1093 reloaded by caching clients or proxies. Defaults to null,
1094 which means to use the site path + '/theme'.
1095 ssl: Whether to use SSL for theme elements. Default is null, which means
1096 guess based on site SSL settings.
1101 server: You can speed up page loading by pointing the
1102 theme file lookup to another server (virtual or real).
1103 Defaults to NULL, meaning to use the site server.
1104 path: Path part of Javascript URLs. Defaults to null,
1105 which means to use the site path + '/js/'.
1106 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1107 guess based on site SSL settings.
1112 For configuring the XMPP sub-system.
1114 enabled: Whether to accept and send messages by XMPP. Default false.
1115 server: server part of XMPP ID for update user.
1116 port: connection port for clients. Default 5222, which you probably
1117 shouldn't need to change.
1118 user: username for the client connection. Users will receive messages
1119 from 'user'@'server'.
1120 resource: a unique identifier for the connection to the server. This
1121 is actually used as a prefix for each XMPP component in the system.
1122 password: password for the user account.
1123 host: some XMPP domains are served by machines with a different
1124 hostname. (For example, @gmail.com GTalk users connect to
1125 talk.google.com). Set this to the correct hostname if that's the
1126 case with your server.
1127 encryption: Whether to encrypt the connection between StatusNet and the
1128 XMPP server. Defaults to true, but you can get
1129 considerably better performance turning it off if you're
1130 connecting to a server on the same machine or on a
1132 debug: if turned on, this will make the XMPP library blurt out all of
1133 the incoming and outgoing messages as XML stanzas. Use as a
1134 last resort, and never turn it on if you don't have queues
1135 enabled, since it will spit out sensitive data to the browser.
1136 public: an array of JIDs to send _all_ notices to. This is useful for
1137 participating in third-party search and archiving services.
1142 For configuring invites.
1144 enabled: Whether to allow users to send invites. Default true.
1149 Miscellaneous tagging stuff.
1151 dropoff: Decay factor for tag listing, in seconds.
1152 Defaults to exponential decay over ten days; you can twiddle
1153 with it to try and get better results for your site.
1158 Settings for the "popular" section of the site.
1160 dropoff: Decay factor for popularity listing, in seconds.
1161 Defaults to exponential decay over ten days; you can twiddle
1162 with it to try and get better results for your site.
1167 For daemon processes.
1169 piddir: directory that daemon processes should write their PID file
1170 (process ID) to. Defaults to /var/run/, which is where this
1171 stuff should usually go on Unix-ish systems.
1172 user: If set, the daemons will try to change their effective user ID
1173 to this user before running. Probably a good idea, especially if
1174 you start the daemons as root. Note: user name, like 'daemon',
1176 group: If set, the daemons will try to change their effective group ID
1177 to this named group. Again, a name, not a numerical ID.
1182 You can get a significant boost in performance by caching some
1183 database data in memcached <http://www.danga.com/memcached/>.
1185 enabled: Set to true to enable. Default false.
1186 server: a string with the hostname of the memcached server. Can also
1187 be an array of hostnames, if you've got more than one server.
1188 base: memcached uses key-value pairs to store data. We build long,
1189 funny-looking keys to make sure we don't have any conflicts. The
1190 base of the key is usually a simplified version of the site name
1191 (like "Identi.ca" => "identica"), but you can overwrite this if
1192 you need to. You can safely ignore it if you only have one
1193 StatusNet site using your memcached server.
1194 port: Port to connect to; defaults to 11211.
1201 enabled: Whether to enable post-by-email. Defaults to true. You will
1202 also need to set up maildaemon.php.
1207 For SMS integration.
1209 enabled: Whether to enable SMS integration. Defaults to true. Queues
1210 should also be enabled.
1215 A catch-all for integration with other systems.
1217 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1224 enabled: No longer used. If you set this to something other than true,
1225 StatusNet will no longer run.
1230 For notice-posting throttles.
1232 enabled: Whether to throttle posting. Defaults to false.
1233 count: Each user can make this many posts in 'timespan' seconds. So, if count
1234 is 100 and timespan is 3600, then there can be only 100 posts
1235 from a user every hour.
1236 timespan: see 'count'.
1243 biolimit: max character length of bio; 0 means no limit; null means to use
1244 the site text limit default.
1249 Options with new users.
1251 default: nickname of a user account to automatically subscribe new
1252 users to. Typically this would be system account for e.g.
1253 service updates or announcements. Users are able to unsub
1254 if they want. Default is null; no auto subscribe.
1255 welcome: nickname of a user account that sends welcome messages to new
1256 users. Can be the same as 'default' account, although on
1257 busy servers it may be a good idea to keep that one just for
1258 'urgent' messages. Default is null; no message.
1260 If either of these special user accounts are specified, the users should
1261 be created before the configuration is updated.
1266 The software will, by default, send statistical snapshots about the
1267 local installation to a stats server on the status.net Web site. This
1268 data is used by the developers to prioritize development decisions. No
1269 identifying data about users or organizations is collected. The data
1270 is available to the public for review. Participating in this survey
1271 helps StatusNet developers take your needs into account when updating
1274 run: string indicating when to run the statistics. Values can be 'web'
1275 (run occasionally at Web time), 'cron' (run from a cron script),
1276 or 'never' (don't ever run). If you set it to 'cron', remember to
1277 schedule the script to run on a regular basis.
1278 frequency: if run value is 'web', how often to report statistics.
1279 Measured in Web hits; depends on how active your site is.
1280 Default is 10000 -- that is, one report every 10000 Web hits,
1282 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1283 report system, but if they go evil or disappear you may
1284 need to update this to another value. Note: if you
1285 don't want to report stats, it's much better to
1286 set 'run' to 'never' than to set this value to something
1292 The software lets users upload files with their notices. You can configure
1293 the types of accepted files by mime types and a trio of quota options:
1294 per file, per user (total), per user per month.
1296 We suggest the use of the pecl file_info extension to handle mime type
1299 supported: an array of mime types you accept to store and distribute,
1300 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1301 setup your server to properly recognize the types you want to
1303 uploads: false to disable uploading files with notices (true by default).
1304 filecommand: The required MIME_Type library may need to use the 'file'
1305 command. It tries the one in the Web server's path, but if
1306 you're having problems with uploads, try setting this to the
1307 correct value. Note: 'file' must accept '-b' and '-i' options.
1309 For quotas, be sure you've set the upload_max_filesize and post_max_size
1310 in php.ini to be large enough to handle your upload. In httpd.conf
1311 (if you're using apache), check that the LimitRequestBody directive isn't
1312 set too low (it's optional, so it may not be there at all).
1314 file_quota: maximum size for a single file upload in bytes. A user can send
1315 any amount of notices with attachments as long as each attachment
1316 is smaller than file_quota.
1317 user_quota: total size in bytes a user can store on this server. Each user
1318 can store any number of files as long as their total size does
1319 not exceed the user_quota.
1320 monthly_quota: total size permitted in the current month. This is the total
1321 size in bytes that a user can upload each month.
1322 dir: directory accessible to the Web process where uploads should go.
1323 Defaults to the 'file' subdirectory of the install directory, which
1324 should be writeable by the Web user.
1325 server: server name to use when creating URLs for uploaded files.
1326 Defaults to null, meaning to use the default Web server. Using
1327 a virtual server here can speed up Web performance.
1328 path: URL path, relative to the server, to find files. Defaults to
1329 main path + '/file/'.
1330 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1331 guess based on other SSL settings.
1332 filecommand: command to use for determining the type of a file. May be
1333 skipped if fileinfo extension is installed. Defaults to
1339 Options for group functionality.
1341 maxaliases: maximum number of aliases a group can have. Default 3. Set
1342 to 0 or less to prevent aliases in a group.
1343 desclimit: maximum number of characters to allow in group descriptions.
1344 null (default) means to use the site-wide text limits. 0
1350 oEmbed endpoint for multimedia attachments (links in posts).
1352 endpoint: oohembed endpoint using http://oohembed.com/ software.
1357 Some stuff for search.
1359 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1360 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1361 but requires the lame old MyISAM engine for MySQL. The latter
1362 will work with InnoDB but could be miserably slow on large
1363 systems. We'll probably add another type sometime in the future,
1364 with our own indexing system (maybe like MediaWiki's).
1371 handle: boolean. Whether we should register our own PHP session-handling
1372 code (using the database and memcache if enabled). Defaults to false.
1373 Setting this to true makes some sense on large or multi-server
1374 sites, but it probably won't hurt for smaller ones, either.
1375 debug: whether to output debugging info for session storage. Can help
1376 with weird session bugs, sometimes. Default false.
1381 Users can upload backgrounds for their pages; this section defines
1384 server: the server to use for background. Using a separate (even
1385 virtual) server for this can speed up load times. Default is
1386 null; same as site server.
1387 dir: directory to write backgrounds too. Default is '/background/'
1388 subdir of install dir.
1389 path: path to backgrounds. Default is sub-path of install path; note
1390 that you may need to change this if you change site-path too.
1391 ssl: Whether or not to use HTTPS for background files. Defaults to
1392 null, meaning to guess from site-wide SSL settings.
1397 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1398 notify third-party servers of updates.
1400 notify: an array of URLs for ping endpoints. Default is the empty
1401 array (no notification).
1406 Default design (colors and background) for the site. Actual appearance
1407 depends on the theme. Null values mean to use the theme defaults.
1409 backgroundcolor: Hex color of the site background.
1410 contentcolor: Hex color of the content area background.
1411 sidebarcolor: Hex color of the sidebar background.
1412 textcolor: Hex color of all non-link text.
1413 linkcolor: Hex color of all links.
1414 backgroundimage: Image to use for the background.
1415 disposition: Flags for whether or not to tile the background image.
1420 Configuration options specific to notices.
1422 contentlimit: max length of the plain-text content of a notice.
1423 Default is null, meaning to use the site-wide text limit.
1429 Configuration options specific to messages.
1431 contentlimit: max length of the plain-text content of a message.
1432 Default is null, meaning to use the site-wide text limit.
1438 Configuration options for the login command.
1440 disabled: whether to enable this command. If enabled, users who send
1441 the text 'login' to the site through any channel will
1442 receive a link to login to the site automatically in return.
1443 Possibly useful for users who primarily use an XMPP or SMS
1444 interface and can't be bothered to remember their site
1445 password. Note that the security implications of this are
1446 pretty serious and have not been thoroughly tested. You
1447 should enable it only after you've convinced yourself that
1448 it is safe. Default is 'false'.
1453 If an installation has only one user, this can simplify a lot of the
1454 interface. It also makes the user's profile the root URL.
1456 enabled: Whether to run in "single user mode". Default false.
1457 nickname: nickname of the single user.
1462 We put out a default robots.txt file to guide the processing of
1463 Web crawlers. See http://www.robotstxt.org/ for more information
1464 on the format of this file.
1466 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1467 for the robots.txt file. see http://ur1.ca/l5a0
1468 for more information. Default is zero, no explicit delay.
1469 disallow: Array of (virtual) directories to disallow. Default is 'main',
1470 'search', 'message', 'settings', 'admin'. Ignored when site
1471 is private, in which case the entire site ('/') is disallowed.
1476 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1477 powerful plugin architecture. Important events in the code are named,
1478 like 'StartNoticeSave', and other software can register interest
1479 in those events. When the events happen, the other software is called
1480 and has a choice of accepting or rejecting the events.
1482 In the simplest case, you can add a function to config.php and use the
1483 Event::addHandler() function to hook an event:
1485 function AddGoogleLink($action)
1487 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1491 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1493 This adds a menu item to the end of the main navigation menu. You can
1494 see the list of existing events, and parameters that handlers must
1495 implement, in EVENTS.txt.
1497 The Plugin class in lib/plugin.php makes it easier to write more
1498 complex plugins. Sub-classes can just create methods named
1499 'onEventName', where 'EventName' is the name of the event (case
1500 matters!). These methods will be automatically registered as event
1501 handlers by the Plugin constructor (which you must call from your own
1502 class's constructor).
1504 Several example plugins are included in the plugins/ directory. You
1505 can enable a plugin with the following line in config.php:
1507 addPlugin('Example', array('param1' => 'value1',
1508 'param2' => 'value2'));
1510 This will look for and load files named 'ExamplePlugin.php' or
1511 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1512 plugins that ship with StatusNet) or in the local/ directory (for
1513 plugins you write yourself or that you get from somewhere else) or
1516 Plugins are documented in their own directories.
1521 The primary output for StatusNet is syslog, unless you configured a
1522 separate logfile. This is probably the first place to look if you're
1523 getting weird behaviour from StatusNet.
1525 If you're tracking the unstable version of StatusNet in the git
1526 repository (see below), and you get a compilation error ("unexpected
1527 T_STRING") in the browser, check to see that you don't have any
1528 conflicts in your code.
1530 If you upgraded to StatusNet 0.9.2 without reading the "Notice
1531 inboxes" section above, and all your users' 'Personal' tabs are empty,
1532 read the "Notice inboxes" section above.
1537 These are some myths you may see on the Web about StatusNet.
1538 Documentation from the core team about StatusNet has been pretty
1539 sparse, so some backtracking and guesswork resulted in some incorrect
1542 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1543 extremely bad idea. It's a tool built into DB_DataObject that will
1544 emit oodles of print lines directly to the browser of your users.
1545 Among these lines will be your database username and password. Do
1546 not enable this option on a production Web site for any reason.
1548 - "Edit dataobject.ini with the following settings..." dataobject.ini
1549 is a development file for the DB_DataObject framework and is not
1550 used by the running software. It was removed from the StatusNet
1551 distribution because its presence was confusing. Do not bother
1552 configuring dataobject.ini, and do not put your database username
1553 and password into the file on a production Web server; unscrupulous
1554 persons may try to read it to get your passwords.
1559 If you're adventurous or impatient, you may want to install the
1560 development version of StatusNet. To get it, use the git version
1561 control tool <http://git-scm.com/> like so:
1563 git clone git@gitorious.org:statusnet/mainline.git
1565 This is the version of the software that runs on Identi.ca and the
1566 status.net hosted service. Using it is a mixed bag. On the positive
1567 side, it usually includes the latest security and bug fix patches. On
1568 the downside, it may also include changes that require admin
1569 intervention (like running a script or even raw SQL!) that may not be
1570 documented yet. It may be a good idea to test this version before
1571 installing it on your production machines.
1573 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1578 There are several ways to get more information about StatusNet.
1580 * There is a mailing list for StatusNet developers and admins at
1581 http://mail.status.net/mailman/listinfo/statusnet-dev
1582 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1583 * The StatusNet wiki, http://status.net/wiki/
1584 * The StatusNet blog, http://status.net/blog/
1585 * The StatusNet status update, <http://status.status.net/> (!)
1590 * Microblogging messages to http://support.status.net/ are very welcome.
1591 * The microblogging group http://identi.ca/group/statusnet is a good
1592 place to discuss the software.
1593 * StatusNet has a bug tracker for any defects you may find, or ideas for
1594 making things better. http://status.net/bugs
1599 The following is an incomplete list of developers who've worked on
1600 StatusNet. Apologies for any oversight; please let evan@status.net know
1601 if anyone's been overlooked in error.
1603 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1604 * Zach Copley, StatusNet, Inc.
1605 * Earle Martin, StatusNet, Inc.
1606 * Marie-Claude Doyon, designer, StatusNet, Inc.
1607 * Sarven Capadisli, StatusNet, Inc.
1608 * Robin Millette, StatusNet, Inc.
1619 * Tryggvi Björgvinsson
1623 * Ken Sheppardson (Trac server, man-about-town)
1624 * Tiago 'gouki' Faria (i18n manager)
1626 * Leslie Michael Orchard
1630 * Tobias Diekershoff
1642 Thanks also to the developers of our upstream library code and to the
1643 thousands of people who have tried out Identi.ca, installed StatusNet,
1644 told their friends, and built the Open Microblogging network to what