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. See
42 <http://status.net/signup> for details. The software run
43 on status.net is identical to the software available for download, so
44 you can move back and forth between a hosted version or a version
45 installed on your own servers.
47 A commercial software subscription is available from StatusNet Inc. It
48 includes 24-hour technical support and developer support. More
49 information at http://status.net/contact or email sales@status.net.
54 This program is free software: you can redistribute it and/or modify
55 it under the terms of the GNU Affero General Public License as
56 published by the Free Software Foundation, either version 3 of the
57 License, or (at your option) any later version.
59 This program is distributed in the hope that it will be useful, but
60 WITHOUT ANY WARRANTY; without even the implied warranty of
61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
62 Affero General Public License for more details.
64 You should have received a copy of the GNU Affero General Public
65 License along with this program, in the file "COPYING". If not, see
66 <http://www.gnu.org/licenses/>.
68 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
69 *different requirements* from the "regular" GPL. In particular, if
70 you make modifications to the StatusNet source code on your server,
71 you *MUST MAKE AVAILABLE* the modified version of the source code
72 to your users under the same license. This is a legal requirement
73 of using the software, and if you do not wish to share your
74 modifications, *YOU MAY NOT INSTALL STATUSNET*.
76 Documentation in the /doc-src/ directory is available under the
77 Creative Commons Attribution 3.0 Unported license, with attribution to
78 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
80 CSS and images in the /theme/ directory are available under the
81 Creative Commons Attribution 3.0 Unported license, with attribution to
82 "StatusNet". See http://creativecommons.org/licenses/by/3.0/ for details.
84 Our understanding and intention is that if you add your own theme that
85 uses only CSS and images, those files are not subject to the copyleft
86 requirements of the Affero General Public License 3.0. See
87 http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
88 legal advice; consult your lawyer.
90 Additional library software has been made available in the 'extlib'
91 directory. All of it is Free Software and can be distributed under
92 liberal terms, but those terms may differ in detail from the AGPL's
93 particulars. See each package's license file in the extlib directory
99 This is a security release since version 0.9.7 released on 11 March
100 2011. It fixes security bug #3260. All sites running version 0.9.7 or
101 below are recommended to upgrade to 0.9.9 immediately.
103 Notable changes this version:
105 - Fix bug #3260, a cross-site scripting (XSS) bug that allows an
106 attacker to inject JavaScript into a page with a carefully structured URL.
107 - Updated code for Google Analytics to reflect new API.
108 - Various fixes for Bookmark plugin.
109 - Updates to reCAPTCHA plugin based on changes to API.
110 - New plugin to move the site notice to the sidebar.
111 - Add rss.me to notice source list.
112 - Updates to data backup/restore.
113 - Correct use of "likes" in Facebook plugin.
114 - Ignore failures in Twitter plugin.
116 A full changelog is available at http://status.net/wiki/StatusNet_0.9.9.
118 NOTE: The short-lived StatusNet 0.9.8 ("Letter Never Sent") did not
119 adequately fix bug #3260 as originally thought; thus this new release.
124 The following software packages are *required* for this software to
127 - PHP 5.2.3+. It may be possible to run this software on earlier
128 versions of PHP, but many of the functions used are only available
129 in PHP 5.2 or above. 5.2.6 or later is needed for XMPP background
130 daemons on 64-bit platforms. PHP 5.3.x should work correctly in this
131 release, but problems with some plugins are possible.
132 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
133 server. It has been primarily tested on 5.x servers, although it may
134 be possible to install on earlier (or later!) versions. The server
135 *must* support the MyISAM storage engine -- the default for most
136 MySQL servers -- *and* the InnoDB storage engine.
137 - A Web server. Preferably, you should have Apache 2.2.x with the
138 mod_rewrite extension installed and enabled.
140 Your PHP installation must include the following PHP extensions:
142 - Curl. This is for fetching files by HTTP.
143 - XMLWriter. This is for formatting XML and HTML output.
144 - MySQL. For accessing the database.
145 - GD. For scaling down avatar images.
146 - mbstring. For handling Unicode (UTF-8) encoded strings.
148 For some functionality, you will also need the following extensions:
150 - Memcache. A client for the memcached server, which caches database
151 information in volatile memory. This is important for adequate
152 performance on high-traffic sites. You will also need a memcached
153 server to store the data in.
154 - Mailparse. Efficient parsing of email requires this extension.
155 Submission by email or SMS-over-email uses this extension.
156 - Sphinx Search. A client for the sphinx server, an alternative
157 to MySQL or Postgresql fulltext search. You will also need a
158 Sphinx server to serve the search queries.
159 - bcmath or gmp. For Salmon signatures (part of OStatus). Needed
160 if you have OStatus configured.
161 - gettext. For multiple languages. Default on many PHP installs;
162 will be emulated if not present.
164 You will almost definitely get 2-3 times better performance from your
165 site if you install a PHP bytecode cache/accelerator. Some well-known
166 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
167 is a proprietary accelerator installed on some hosting sites.
172 A number of external PHP libraries are used to provide basic
173 functionality and optional functionality for your system. For your
174 convenience, they are available in the "extlib" directory of this
175 package, and you do not have to download and install them. However,
176 you may want to keep them up-to-date with the latest upstream version,
177 and the URLs are listed here for your convenience.
179 - DB_DataObject http://pear.php.net/package/DB_DataObject
180 - Validate http://pear.php.net/package/Validate
181 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
182 to use the openidenabled.com version since it's more widely
183 implemented, and seems to be better supported.
184 http://openidenabled.com/php-openid/
185 - PEAR DB. Although this is an older data access system (new
186 packages should probably use PHP DBO), the OpenID libraries
187 depend on PEAR DB so we use it here, too. DB_DataObject can
188 also use PEAR MDB2, which may give you better performance
189 but won't work with OpenID.
190 http://pear.php.net/package/DB
191 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
192 - markdown.php from http://michelf.com/projects/php-markdown/
193 - PEAR Mail, for sending out mail notifications
194 http://pear.php.net/package/Mail
195 - PEAR Net_SMTP, if you use the SMTP factory for notifications
196 http://pear.php.net/package/Net_SMTP
197 - PEAR Net_Socket, if you use the SMTP factory for notifications
198 http://pear.php.net/package/Net_Socket
199 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
200 library available for PHP. http://xmpphp.googlecode.com/. Note that
201 as of this writing the version of this library that is available in
202 the extlib directory is *significantly different* from the upstream
203 version (patches have been submitted). Upgrading to the upstream
204 version may render your StatusNet site unable to send or receive XMPP
206 - Facebook library. Used for the Facebook application.
207 - PEAR Validate is used for URL and email validation.
208 - Console_GetOpt for parsing command-line options.
209 - libomb. a library for implementing OpenMicroBlogging 0.1, the
210 predecessor to OStatus.
211 - HTTP_Request2, a library for making HTTP requests.
212 - PEAR Net_URL2 is an HTTP_Request2 dependency.
214 A design goal of StatusNet is that the basic Web functionality should
215 work on even the most restrictive commercial hosting services.
216 However, additional functionality, such as receiving messages by
217 Jabber/GTalk, require that you be able to run long-running processes
218 on your account. In addition, posting by email or from SMS require
219 that you be able to install a mail filter in your mail server.
224 Installing the basic StatusNet Web component is relatively easy,
225 especially if you've previously installed PHP/MySQL packages.
227 1. Unpack the tarball you downloaded on your Web server. Usually a
228 command like this will work:
230 tar zxf statusnet-0.9.9.tar.gz
232 ...which will make a statusnet-0.9.9 subdirectory in your current
233 directory. (If you don't have shell access on your Web server, you
234 may have to unpack the tarball on your local computer and FTP the
235 files to the server.)
237 2. Move the tarball to a directory of your choosing in your Web root
238 directory. Usually something like this will work:
240 mv statusnet-0.9.9 /var/www/statusnet
242 This will make your StatusNet instance available in the statusnet path of
243 your server, like "http://example.net/statusnet". "microblog" or
244 "statusnet" might also be good path names. If you know how to
245 configure virtual hosts on your web server, you can try setting up
246 "http://micro.example.net/" or the like.
248 3. Make your target directory writeable by the Web server.
250 chmod a+w /var/www/statusnet/
252 On some systems, this will probably work:
254 chgrp www-data /var/www/statusnet/
255 chmod g+w /var/www/statusnet/
257 If your Web server runs as another user besides "www-data", try
258 that user's default group instead. As a last resort, you can create
259 a new group like "statusnet" and add the Web server's user to the group.
261 4. You should also take this moment to make your avatar, background, and
262 file subdirectories writeable by the Web server. An insecure way to do
265 chmod a+w /var/www/statusnet/avatar
266 chmod a+w /var/www/statusnet/background
267 chmod a+w /var/www/statusnet/file
269 You can also make the avatar, background, and file directories
270 writeable by the Web server group, as noted above.
272 5. Create a database to hold your microblog data. Something like this
275 mysqladmin -u "username" --password="password" create statusnet
277 Note that StatusNet must have its own database; you can't share the
278 database with another program. You can name it whatever you want,
281 (If you don't have shell access to your server, you may need to use
282 a tool like PHPAdmin to create a database. Check your hosting
283 service's documentation for how to create a new MySQL database.)
285 6. Create a new database account that StatusNet will use to access the
286 database. If you have shell access, this will probably work from the
289 GRANT ALL on statusnet.*
290 TO 'statusnetuser'@'localhost'
291 IDENTIFIED BY 'statusnetpassword';
293 You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
294 username and password. You may want to test logging in to MySQL as
297 7. In a browser, navigate to the StatusNet install script; something like:
299 http://yourserver.example.com/statusnet/install.php
301 Enter the database connection information and your site name. The
302 install program will configure your site and install the initial,
303 almost-empty database.
305 8. You should now be able to navigate to your microblog's main directory
306 and see the "Public Timeline", which will be empty. If not, magic
307 has happened! You can now register a new user, post some notices,
308 edit your profile, etc. However, you may want to wait to do that stuff
309 if you think you can set up "fancy URLs" (see below), since some
310 URLs are stored in the database.
315 By default, StatusNet will use URLs that include the main PHP program's
316 name in them. For example, a user's home profile might be
319 http://example.org/statusnet/index.php/statusnet/fred
321 On certain systems that don't support this kind of syntax, they'll
324 http://example.org/statusnet/index.php?p=statusnet/fred
326 It's possible to configure the software so it looks like this instead:
328 http://example.org/statusnet/fred
330 These "fancy URLs" are more readable and memorable for users. To use
331 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
332 mod_rewrite enabled, -OR- know how to configure "url redirection" in
335 1. Copy the htaccess.sample file to .htaccess in your StatusNet
336 directory. Note: if you have control of your server's httpd.conf or
337 similar configuration files, it can greatly improve performance to
338 import the .htaccess file into your conf file instead. If you're
339 not sure how to do it, you may save yourself a lot of headache by
340 just leaving the .htaccess file.
342 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
343 to your StatusNet installation on your server. Typically this will
344 be the path to your StatusNet directory relative to your Web root.
346 3. Add or uncomment or change a line in your config.php file so it says:
348 $config['site']['fancy'] = true;
350 You should now be able to navigate to a "fancy" URL on your server,
353 http://example.net/statusnet/main/register
355 If you changed your HTTP server configuration, you may need to restart
358 If it doesn't work, double-check that AllowOverride for the StatusNet
359 directory is 'All' in your Apache configuration file. This is usually
360 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
361 /etc/apache2/sites-available/default. See the Apache documentation for
362 .htaccess files for more details:
364 http://httpd.apache.org/docs/2.2/howto/htaccess.html
366 Also, check that mod_rewrite is installed and enabled:
368 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
373 To use a Sphinx server to search users and notices, you'll need to
374 enable the SphinxSearch plugin. Add to your config.php:
376 addPlugin('SphinxSearch');
377 $config['sphinx']['server'] = 'searchhost.local';
379 You also need to install, compile and enable the sphinx pecl extension for
380 php on the client side, which itself depends on the sphinx development files.
382 See plugins/SphinxSearch/README for more details and server setup.
387 StatusNet supports a cheap-and-dirty system for sending update messages
388 to mobile phones and for receiving updates from the mobile. Instead of
389 sending through the SMS network itself, which is costly and requires
390 buy-in from the wireless carriers, it simply piggybacks on the email
391 gateways that many carriers provide to their customers. So, SMS
392 configuration is essentially email configuration.
394 Each user sends to a made-up email address, which they keep a secret.
395 Incoming email that is "From" the user's SMS email address, and "To"
396 the users' secret email address on the site's domain, will be
397 converted to a notice and stored in the DB.
399 For this to work, there *must* be a domain or sub-domain for which all
400 (or most) incoming email can pass through the incoming mail filter.
402 1. Run the SQL script carrier.sql in your StatusNet database. This will
405 mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
407 This will populate your database with a list of wireless carriers
408 that support email SMS gateways.
410 2. Make sure the maildaemon.php file is executable:
412 chmod +x scripts/maildaemon.php
414 Note that "daemon" is kind of a misnomer here; the script is more
415 of a filter than a daemon.
417 2. Edit /etc/aliases on your mail server and add the following line:
419 *: /path/to/statusnet/scripts/maildaemon.php
421 3. Run whatever code you need to to update your aliases database. For
422 many mail servers (Postfix, Exim, Sendmail), this should work:
426 You may need to restart your mail server for the new database to
429 4. Set the following in your config.php file:
431 $config['mail']['domain'] = 'yourdomain.example.net';
433 At this point, post-by-email and post-by-SMS-gateway should work. Note
434 that if your mail server is on a different computer from your email
435 server, you'll need to have a full installation of StatusNet, a working
436 config.php, and access to the StatusNet database from the mail server.
441 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
442 instant-messenger protocol that drives Jabber and GTalk IM. You can
443 distribute messages via XMPP using the system below; however, you
444 need to run the XMPP incoming daemon to allow incoming messages as
447 1. You may want to strongly consider setting up your own XMPP server.
448 Ejabberd, OpenFire, and JabberD are all Open Source servers.
449 Jabber, Inc. provides a high-performance commercial server.
451 2. You must register a Jabber ID (JID) with your new server. It helps
452 to choose a name like "update@example.com" or "notice" or something
453 similar. Alternately, your "update JID" can be registered on a
454 publicly-available XMPP service, like jabber.org or GTalk.
456 StatusNet will not register the JID with your chosen XMPP server;
457 you need to do this manually, with an XMPP client like Gajim,
458 Telepathy, or Pidgin.im.
460 3. Configure your site's XMPP variables, as described below in the
461 configuration section.
463 On a default installation, your site can broadcast messages using
464 XMPP. Users won't be able to post messages using XMPP unless you've
465 got the XMPP daemon running. See 'Queues and daemons' below for how
466 to set that up. Also, once you have a sizable number of users, sending
467 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
468 can really slow down your site; it may cause posting to timeout.
470 NOTE: stream_select(), a crucial function for network programming, is
471 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
472 work around this bug in StatusNet; current recommendation is to move
473 off of amd64 to another server.
478 You can send *all* messages from your microblogging site to a
479 third-party service using XMPP. This can be useful for providing
480 search, indexing, bridging, or other cool services.
482 To configure a downstream site to receive your public stream, add
483 their "JID" (Jabber ID) to your config.php as follows:
485 $config['xmpp']['public'][] = 'downstream@example.net';
487 (Don't miss those square brackets at the end.) Note that your XMPP
488 broadcasting must be configured as mentioned above. Although you can
489 send out messages at "Web time", high-volume sites should strongly
490 consider setting up queues and daemons.
495 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
496 and XMPP messages, can be 'queued' and done by off-line bots instead.
497 For this to work, you must be able to run long-running offline
498 processes, either on your main Web server or on another server you
499 control. (Your other server will still need all the above
500 prerequisites, with the exception of Apache.) Installing on a separate
501 server is probably a good idea for high-volume sites.
503 1. You'll need the "CLI" (command-line interface) version of PHP
504 installed on whatever server you use.
506 2. If you're using a separate server for queues, install StatusNet
507 somewhere on the server. You don't need to worry about the
508 .htaccess file, but make sure that your config.php file is close
509 to, or identical to, your Web server's version.
511 3. In your config.php files (both the Web server and the queues
512 server!), set the following variable:
514 $config['queue']['enabled'] = true;
516 You may also want to look at the 'daemon' section of this file for
517 more daemon options. Note that if you set the 'user' and/or 'group'
518 options, you'll need to create that user and/or group by hand.
519 They're not created automatically.
521 4. On the queues server, run the command scripts/startdaemons.sh.
523 This will run the queue handlers:
525 * queuedaemon.php - polls for queued items for inbox processing and
526 pushing out to OStatus, SMS, XMPP, etc.
527 * xmppdaemon.php - listens for new XMPP messages from users and stores
528 them as notices in the database; also pulls queued XMPP output from
529 queuedaemon.php to push out to clients.
531 These two daemons will automatically restart in most cases of failure
532 including memory leaks (if a memory_limit is set), but may still die
533 or behave oddly if they lose connections to the XMPP or queue servers.
535 Additional daemons may be also started by this script for certain
536 plugins, such as the Twitter bridge.
538 It may be a good idea to use a daemon-monitoring service, like 'monit',
539 to check their status and keep them running.
541 All the daemons write their process IDs (pids) to /var/run/ by
542 default. This can be useful for starting, stopping, and monitoring the
545 Since version 0.8.0, it's now possible to use a STOMP server instead of
546 our kind of hacky home-grown DB-based queue solution. This is strongly
547 recommended for best response time, especially when using XMPP.
549 See the "queues" config section below for how to configure to use STOMP.
550 As of this writing, the software has been tested with ActiveMQ 5.3.
555 There are two themes shipped with this version of StatusNet: "identica",
556 which is what the Identi.ca site uses, and "default", which is a good
557 basis for other sites.
559 As of right now, your ability to change the theme is site-wide; users
560 can't choose their own theme. Additionally, the only thing you can
561 change in the theme is CSS stylesheets and some image files; you can't
562 change the HTML output, like adding or removing menu items.
564 You can choose a theme using the $config['site']['theme'] element in
565 the config.php file. See below for details.
567 You can add your own theme by making a sub-directory of the 'theme'
568 subdirectory with the name of your theme. Each theme can have the
571 display.css: a CSS2 file for "default" styling for all browsers.
572 ie6.css: a CSS2 file for override styling for fixing up Internet
574 ie7.css: a CSS2 file for override styling for fixing up Internet
576 logo.png: a logo image for the site.
577 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
578 users who don't upload their own.
579 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
580 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
581 listing on profile pages.
583 You may want to start by copying the files from the default theme to
586 NOTE: the HTML generated by StatusNet changed *radically* between
587 version 0.6.x and 0.7.x. Older themes will need signification
588 modification to use the new output format.
593 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
594 Theoretically, you can add your own sub-directory to the locale/
595 subdirectory to add a new language to your system. You'll need to
596 compile the ".po" files into ".mo" files, however.
598 Contributions of translation information to StatusNet are very easy:
599 you can use the Web interface at translatewiki.net to add one
600 or a few or lots of new translations -- or even new languages. You can
601 also download more up-to-date .po files there, if you so desire.
603 For info on helping with translations, see http://status.net/wiki/Translations
608 There is no built-in system for doing backups in StatusNet. You can make
609 backups of a working StatusNet system by backing up the database and
610 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
611 and to backup the Web directory, try tar.
616 The administrator can set the "private" flag for a site so that it's
617 not visible to non-logged-in users. This might be useful for
618 workgroups who want to share a microblogging site for project
619 management, but host it on a public server.
621 Total privacy is not guaranteed or ensured. Also, privacy is
622 all-or-nothing for a site; you can't have some accounts or notices
623 private, and others public. The interaction of private sites
624 with OStatus is undefined.
626 Access to file attachments can also be restricted to logged-in users only.
627 1. Add a directory outside the web root where your file uploads will be
628 stored. Usually a command like this will work:
630 mkdir /var/www/statusnet-files
632 2. Make the file uploads directory writeable by the web server. An
633 insecure way to do this is:
635 chmod a+x /var/www/statusnet-files
637 3. Tell StatusNet to use this directory for file uploads. Add a line
638 like this to your config.php:
640 $config['attachments']['dir'] = '/var/www/statusnet-files';
645 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
646 incorrectly-stored international characters ("UTF-8"). For new
647 installations, it will now store non-ASCII characters correctly.
648 However, older installations will have the incorrect storage, and will
649 consequently show up "wrong" in browsers. See below for how to deal
652 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
653 been tracking the "git" version of the software, you will probably
654 want to upgrade and keep your existing data. There is no automated
655 upgrade procedure in StatusNet 0.9.9. Try these step-by-step
656 instructions; read to the end first before trying them.
658 0. Download StatusNet and set up all the prerequisites as if you were
660 1. Make backups of both your database and your Web directory. UNDER NO
661 CIRCUMSTANCES should you try to do an upgrade without a known-good
662 backup. You have been warned.
663 2. Shut down Web access to your site, either by turning off your Web
664 server or by redirecting all pages to a "sorry, under maintenance"
666 3. Shut down XMPP access to your site, typically by shutting down the
667 xmppdaemon.php process and all other daemons that you're running.
668 If you've got "monit" or "cron" automatically restarting your
669 daemons, make sure to turn that off, too.
670 4. Shut down SMS and email access to your site. The easy way to do
671 this is to comment out the line piping incoming email to your
672 maildaemon.php file, and running something like "newaliases".
673 5. Once all writing processes to your site are turned off, make a
674 final backup of the Web directory and database.
675 6. Move your StatusNet directory to a backup spot, like "statusnet.bak".
676 7. Unpack your StatusNet 0.9.9 tarball and move it to "statusnet" or
677 wherever your code used to be.
678 8. Copy the config.php file and the contents of the avatar/, background/,
679 file/, and local/ subdirectories from your old directory to your new
681 9. Copy htaccess.sample to .htaccess in the new directory. Change the
682 RewriteBase to use the correct path.
683 10. Rebuild the database.
685 NOTE: this step is destructive and cannot be
686 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
687 do it without a known-good backup!
689 If your database is at version 0.8.0 or higher in the 0.8.x line, you can run a
690 special upgrade script:
692 mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
694 If you are upgrading from any 0.9.x version like 0.9.6, run this script:
696 mysql -u<rootuser> -p<rootpassword> <database> db/096to097.sql
698 Despite the name, it should work for any 0.9.x branch.
700 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
701 BACKUP run the rebuilddb.sh script like this:
703 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
705 Here, rootuser and rootpassword are the username and password for a
706 user who can drop and create databases as well as tables; typically
707 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
708 your database and rebuilds it; if there is an error you have no
709 database. Make sure you have a backup.
710 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
711 which operates slightly differently. Read the documentation in that
712 script before running it.
713 11. Use mysql or psql client to log into your database and make sure that
714 the notice, user, profile, subscription etc. tables are non-empty.
715 12. Turn back on the Web server, and check that things still work.
716 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
717 bots have changed since version 0.5; see above for details.
719 If you're upgrading from very old versions, you may want to look at
720 the fixup_* scripts in the scripts directories. These will store some
721 precooked data in the DB. All upgraders should check out the inboxes
724 NOTE: the database definition file, laconica.ini, has been renamed to
725 statusnet.ini (since this is the recommended database name). If you
726 have a line in your config.php pointing to the old name, you'll need
732 Notice inboxes are now required. If you don't have inboxes enabled,
733 StatusNet will no longer run.
738 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
739 international characters ("UTF-8"). This fix is not
740 backwards-compatible; installations from before 0.7.4 will show
741 non-ASCII characters of old notices incorrectly. This section explains
744 0. You can disable the new behaviour by setting the 'db''utf8' config
745 option to "false". You should only do this until you're ready to
746 convert your DB to the new format.
747 1. When you're ready to convert, you can run the fixup_utf8.php script
748 in the scripts/ subdirectory. If you've had the "new behaviour"
749 enabled (probably a good idea), you can give the ID of the first
750 "new" notice as a parameter, and only notices before that one will
751 be converted. Notices are converted in reverse chronological order,
752 so the most recent (and visible) ones will be converted first. The
753 script should work whether or not you have the 'db''utf8' config
755 2. When you're ready, set $config['db']['utf8'] to true, so that
756 new notices will be stored correctly.
758 Configuration options
759 =====================
761 The main configuration file for StatusNet (excepting configurations for
762 dependency software) is config.php in your StatusNet directory. If you
763 edit any other file in the directory, like lib/default.php (where most
764 of the defaults are defined), you will lose your configuration options
765 in any upgrade, and you will wish that you had been more careful.
767 Starting with version 0.9.0, a Web based configuration panel has been
768 added to StatusNet. The preferred method for changing config options is
771 A command-line script, setconfig.php, can be used to set individual
772 configuration options. It's in the scripts/ directory.
774 Starting with version 0.7.1, you can put config files in the
775 /etc/statusnet/ directory on your server, if it exists. Config files
776 will be included in this order:
778 * /etc/statusnet/statusnet.php - server-wide config
779 * /etc/statusnet/<servername>.php - for a virtual host
780 * /etc/statusnet/<servername>_<pathname>.php - for a path
781 * INSTALLDIR/config.php - for a particular implementation
783 Almost all configuration options are made through a two-dimensional
784 associative array, cleverly named $config. A typical configuration
787 $config['section']['option'] = value;
789 For brevity, the following documentation describes each section and
795 This section is a catch-all for site-wide variables.
797 name: the name of your site, like 'YourCompany Microblog'.
798 server: the server part of your site's URLs, like 'example.net'.
799 path: The path part of your site's URLs, like 'statusnet' or ''
801 fancy: whether or not your site uses fancy URLs (see Fancy URLs
802 section above). Default is false.
803 logfile: full path to a file for StatusNet to save logging
804 information to. You may want to use this if you don't have
806 logdebug: whether to log additional debug info like backtraces on
807 hard errors. Default false.
808 locale_path: full path to the directory for locale data. Unless you
809 store all your locale data in one place, you probably
810 don't need to use this.
811 language: default language for your site. Defaults to US English.
812 Note that this is overridden if a user is logged in and has
813 selected a different language. It is also overridden if the
814 user is NOT logged in, but their browser requests a different
815 langauge. Since pretty much everybody's browser requests a
816 language, that means that changing this setting has little or
817 no effect in practice.
818 languages: A list of languages supported on your site. Typically you'd
819 only change this if you wanted to disable support for one
821 "unset($config['site']['languages']['de'])" will disable
823 theme: Theme for your site (see Theme section). Two themes are
824 provided by default: 'default' and 'stoica' (the one used by
825 Identi.ca). It's appreciated if you don't use the 'stoica' theme
826 except as the basis for your own.
827 email: contact email address for your site. By default, it's extracted
828 from your Web server environment; you may want to customize it.
829 broughtbyurl: name of an organization or individual who provides the
830 service. Each page will include a link to this name in the
831 footer. A good way to link to the blog, forum, wiki,
832 corporate portal, or whoever is making the service available.
833 broughtby: text used for the "brought by" link.
834 timezone: default timezone for message display. Users can set their
835 own time zone. Defaults to 'UTC', which is a pretty good default.
836 closed: If set to 'true', will disallow registration on your site.
837 This is a cheap way to restrict accounts to only one
838 individual or group; just register the accounts you want on
839 the service, *then* set this variable to 'true'.
840 inviteonly: If set to 'true', will only allow registration if the user
841 was invited by an existing user.
842 private: If set to 'true', anonymous users will be redirected to the
843 'login' page. Also, API methods that normally require no
844 authentication will require it. Note that this does not turn
845 off registration; use 'closed' or 'inviteonly' for the
847 notice: A plain string that will appear on every page. A good place
848 to put introductory information about your service, or info about
849 upgrades and outages, or other community info. Any HTML will
851 logo: URL of an image file to use as the logo for the site. Overrides
852 the logo in the theme, if any.
853 ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
854 theme logo is used instead.
855 ssl: Whether to use SSL and https:// URLs for some or all pages.
856 Possible values are 'always' (use it for all pages), 'never'
857 (don't use it for any pages), or 'sometimes' (use it for
858 sensitive pages that include passwords like login and registration,
859 but not for regular pages). Default to 'never'.
860 sslserver: use an alternate server name for SSL URLs, like
861 'secure.example.org'. You should be careful to set cookie
862 parameters correctly so that both the SSL server and the
863 "normal" server can access the session cookie and
864 preferably other cookies as well.
865 shorturllength: Length of URL at which URLs in a message exceeding 140
866 characters will be sent to the user's chosen
868 dupelimit: minimum time allowed for one person to say the same thing
869 twice. Default 60s. Anything lower is considered a user
871 textlimit: default max size for texts in the site. Defaults to 140.
872 0 means no limit. Can be fine-tuned for notices, messages,
873 profile bios and group descriptions.
878 This section is a reference to the configuration options for
879 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
880 set are listed below for clarity.
882 database: a DSN (Data Source Name) for your StatusNet database. This is
883 in the format 'protocol://username:password@hostname/databasename',
884 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
885 really know what you're doing), 'username' is the username,
886 'password' is the password, and etc.
887 ini_yourdbname: if your database is not named 'statusnet', you'll need
888 to set this to point to the location of the
889 statusnet.ini file. Note that the real name of your database
890 should go in there, not literally 'yourdbname'.
891 db_driver: You can try changing this to 'MDB2' to use the other driver
892 type for DB_DataObject, but note that it breaks the OpenID
893 libraries, which only support PEAR::DB.
894 debug: On a database error, you may get a message saying to set this
895 value to 5 to see debug messages in the browser. This breaks
896 just about all pages, and will also expose the username and
898 quote_identifiers: Set this to true if you're using postgresql.
899 type: either 'mysql' or 'postgresql' (used for some bits of
900 database-type-specific SQL in the code). Defaults to mysql.
901 mirror: you can set this to an array of DSNs, like the above
902 'database' value. If it's set, certain read-only actions will
903 use a random value out of this array for the database, rather
904 than the one in 'database' (actually, 'database' is overwritten).
905 You can offload a busy DB server by setting up MySQL replication
906 and adding the slaves to this array. Note that if you want some
907 requests to go to the 'database' (master) server, you'll need
908 to include it in this array, too.
909 utf8: whether to talk to the database in UTF-8 mode. This is the default
910 with new installations, but older sites may want to turn it off
911 until they get their databases fixed up. See "UTF-8 database"
913 schemacheck: when to let plugins check the database schema to add
914 tables or update them. Values can be 'runtime' (default)
915 or 'script'. 'runtime' can be costly (plugins check the
916 schema on every hit, adding potentially several db
917 queries, some quite long), but not everyone knows how to
918 run a script. If you can, set this to 'script' and run
919 scripts/checkschema.php whenever you install or upgrade a
925 By default, StatusNet sites log error messages to the syslog facility.
926 (You can override this using the 'logfile' parameter described above).
928 appname: The name that StatusNet uses to log messages. By default it's
929 "statusnet", but if you have more than one installation on the
930 server, you may want to change the name for each instance so
931 you can track log messages more easily.
932 priority: level to log at. Currently ignored.
933 facility: what syslog facility to used. Defaults to LOG_USER, only
934 reset if you know what syslog is and have a good reason
940 You can configure the software to queue time-consuming tasks, like
941 sending out SMS email or XMPP messages, for off-line processing. See
942 'Queues and daemons' above for how to set this up.
944 enabled: Whether to uses queues. Defaults to false.
945 subsystem: Which kind of queueserver to use. Values include "db" for
946 our hacked-together database queuing (no other server
947 required) and "stomp" for a stomp server.
948 stomp_server: "broker URI" for stomp server. Something like
949 "tcp://hostname:61613". More complicated ones are
950 possible; see your stomp server's documentation for
952 queue_basename: a root name to use for queues (stomp only). Typically
953 something like '/queue/sitename/' makes sense. If running
954 multiple instances on the same server, make sure that
955 either this setting or $config['site']['nickname'] are
956 unique for each site to keep them separate.
958 stomp_username: username for connecting to the stomp server; defaults
960 stomp_password: password for connecting to the stomp server; defaults
963 stomp_persistent: keep items across queue server restart, if enabled.
964 Under ActiveMQ, the server configuration determines if and how
965 persistent storage is actually saved.
967 If using a message queue server other than ActiveMQ, you may
968 need to disable this if it does not support persistence.
970 stomp_transactions: use transactions to aid in error detection.
971 A broken transaction will be seen quickly, allowing a message
972 to be redelivered immediately if a daemon crashes.
974 If using a message queue server other than ActiveMQ, you may
975 need to disable this if it does not support transactions.
977 stomp_acks: send acknowledgements to aid in flow control.
978 An acknowledgement of successful processing tells the server
979 we're ready for more and can help keep things moving smoothly.
981 This should *not* be turned off when running with ActiveMQ, but
982 if using another message queue server that does not support
983 acknowledgements you might need to disable this.
985 softlimit: an absolute or relative "soft memory limit"; daemons will
986 restart themselves gracefully when they find they've hit
987 this amount of memory usage. Defaults to 90% of PHP's global
988 memory_limit setting.
990 inboxes: delivery of messages to receiver's inboxes can be delayed to
991 queue time for best interactive performance on the sender.
992 This may however be annoyingly slow when using the DB queues,
993 so you can set this to false if it's causing trouble.
995 breakout: for stomp, individual queues are by default grouped up for
996 best scalability. If some need to be run by separate daemons,
997 etc they can be manually adjusted here.
999 Default will share all queues for all sites within each group.
1000 Specify as <group>/<queue> or <group>/<queue>/<site>,
1001 using nickname identifier as site.
1003 'main/distrib' separate "distrib" queue covering all sites
1004 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
1006 max_retries: for stomp, drop messages after N failed attempts to process.
1009 dead_letter_dir: for stomp, optional directory to dump data on failed
1010 queue processing events after discarding them.
1012 stomp_no_transactions: for stomp, the server does not support transactions,
1013 so do not try to user them. This is needed for http://www.morbidq.com/.
1015 stomp_no_acks: for stomp, the server does not support acknowledgements.
1016 so do not try to user them. This is needed for http://www.morbidq.com/.
1021 The default license to use for your users notices. The default is the
1022 Creative Commons Attribution 3.0 license, which is probably the right
1023 choice for any public site. Note that some other servers will not
1024 accept notices if you apply a stricter license than this.
1026 type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
1027 (default copyright), or 'private' (for private and confidential
1029 owner: for 'allrightsreserved' or 'private', an assigned copyright
1030 holder (for example, an employer for a private site). If
1031 not specified, will be attributed to 'contributors'.
1032 url: URL of the license, used for links.
1033 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1034 image: A button shown on each page for the license.
1039 This is for configuring out-going email. We use PEAR's Mail module,
1040 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
1042 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1043 'smtp'. Defaults to PEAR's default, 'mail'.
1044 params: if the mail backend requires any parameters, you can provide
1045 them in an associative array.
1050 This is for configuring nicknames in the service.
1052 blacklist: an array of strings for usernames that may not be
1053 registered. A default array exists for strings that are
1054 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
1055 but you may want to add others if you have other software
1056 installed in a subdirectory of StatusNet or if you just
1057 don't want certain words used as usernames.
1058 featured: an array of nicknames of 'featured' users of the site.
1059 Can be useful to draw attention to well-known users, or
1060 interesting people, or whatever.
1065 For configuring avatar access.
1067 dir: Directory to look for avatar files and to put them into.
1068 Defaults to avatar subdirectory of install directory; if
1069 you change it, make sure to change path, too.
1070 path: Path to avatars. Defaults to path for avatar subdirectory,
1071 but you can change it if you wish. Note that this will
1072 be included with the avatar server, too.
1073 server: If set, defines another server where avatars are stored in the
1074 root directory. Note that the 'avatar' subdir still has to be
1075 writeable. You'd typically use this to split HTTP requests on
1076 the client to speed up page loading, either with another
1077 virtual server or with an NFS or SAMBA share. Clients
1078 typically only make 2 connections to a single server at a
1079 time <http://ur1.ca/6ih>, so this can parallelize the job.
1081 ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
1082 to guess based on site-wide SSL settings.
1087 For configuring the public stream.
1089 localonly: If set to true, only messages posted by users of this
1090 service (rather than other services, filtered through OMB)
1091 are shown in the public stream. Default true.
1092 blacklist: An array of IDs of users to hide from the public stream.
1093 Useful if you have someone making excessive Twitterfeed posts
1094 to the site, other kinds of automated posts, testing bots, etc.
1095 autosource: Sources of notices that are from automatic posters, and thus
1096 should be kept off the public timeline. Default empty.
1101 server: Like avatars, 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 dir: Directory where theme files are stored. Used to determine
1105 whether to show parts of a theme file. Defaults to the theme
1106 subdirectory of the install directory.
1107 path: Path part of theme URLs, before the theme name. Relative to the
1108 theme server. It may make sense to change this path when upgrading,
1109 (using version numbers as the path) to make sure that all files are
1110 reloaded by caching clients or proxies. Defaults to null,
1111 which means to use the site path + '/theme'.
1112 ssl: Whether to use SSL for theme elements. Default is null, which means
1113 guess based on site SSL settings.
1114 sslserver: SSL server to use when page is HTTPS-encrypted. If
1115 unspecified, site ssl server and so on will be used.
1116 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1121 server: You can speed up page loading by pointing the
1122 theme file lookup to another server (virtual or real).
1123 Defaults to NULL, meaning to use the site server.
1124 path: Path part of Javascript URLs. Defaults to null,
1125 which means to use the site path + '/js/'.
1126 ssl: Whether to use SSL for JavaScript files. Default is null, which means
1127 guess based on site SSL settings.
1128 sslserver: SSL server to use when page is HTTPS-encrypted. If
1129 unspecified, site ssl server and so on will be used.
1130 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1131 bustframes: If true, all web pages will break out of framesets. If false,
1132 can comfortably live in a frame or iframe... probably. Default
1138 For configuring the XMPP sub-system.
1140 enabled: Whether to accept and send messages by XMPP. Default false.
1141 server: server part of XMPP ID for update user.
1142 port: connection port for clients. Default 5222, which you probably
1143 shouldn't need to change.
1144 user: username for the client connection. Users will receive messages
1145 from 'user'@'server'.
1146 resource: a unique identifier for the connection to the server. This
1147 is actually used as a prefix for each XMPP component in the system.
1148 password: password for the user account.
1149 host: some XMPP domains are served by machines with a different
1150 hostname. (For example, @gmail.com GTalk users connect to
1151 talk.google.com). Set this to the correct hostname if that's the
1152 case with your server.
1153 encryption: Whether to encrypt the connection between StatusNet and the
1154 XMPP server. Defaults to true, but you can get
1155 considerably better performance turning it off if you're
1156 connecting to a server on the same machine or on a
1158 debug: if turned on, this will make the XMPP library blurt out all of
1159 the incoming and outgoing messages as XML stanzas. Use as a
1160 last resort, and never turn it on if you don't have queues
1161 enabled, since it will spit out sensitive data to the browser.
1162 public: an array of JIDs to send _all_ notices to. This is useful for
1163 participating in third-party search and archiving services.
1168 For configuring invites.
1170 enabled: Whether to allow users to send invites. Default true.
1175 Miscellaneous tagging stuff.
1177 dropoff: Decay factor for tag listing, in seconds.
1178 Defaults to exponential decay over ten days; you can twiddle
1179 with it to try and get better results for your site.
1184 Settings for the "popular" section of the site.
1186 dropoff: Decay factor for popularity listing, in seconds.
1187 Defaults to exponential decay over ten days; you can twiddle
1188 with it to try and get better results for your site.
1193 For daemon processes.
1195 piddir: directory that daemon processes should write their PID file
1196 (process ID) to. Defaults to /var/run/, which is where this
1197 stuff should usually go on Unix-ish systems.
1198 user: If set, the daemons will try to change their effective user ID
1199 to this user before running. Probably a good idea, especially if
1200 you start the daemons as root. Note: user name, like 'daemon',
1202 group: If set, the daemons will try to change their effective group ID
1203 to this named group. Again, a name, not a numerical ID.
1208 You can get a significant boost in performance by caching some
1209 database data in memcached <http://www.danga.com/memcached/>.
1211 enabled: Set to true to enable. Default false.
1212 server: a string with the hostname of the memcached server. Can also
1213 be an array of hostnames, if you've got more than one server.
1214 base: memcached uses key-value pairs to store data. We build long,
1215 funny-looking keys to make sure we don't have any conflicts. The
1216 base of the key is usually a simplified version of the site name
1217 (like "Identi.ca" => "identica"), but you can overwrite this if
1218 you need to. You can safely ignore it if you only have one
1219 StatusNet site using your memcached server.
1220 port: Port to connect to; defaults to 11211.
1227 enabled: Whether to enable post-by-email. Defaults to true. You will
1228 also need to set up maildaemon.php.
1233 For SMS integration.
1235 enabled: Whether to enable SMS integration. Defaults to true. Queues
1236 should also be enabled.
1241 A catch-all for integration with other systems.
1243 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
1250 enabled: No longer used. If you set this to something other than true,
1251 StatusNet will no longer run.
1256 For notice-posting throttles.
1258 enabled: Whether to throttle posting. Defaults to false.
1259 count: Each user can make this many posts in 'timespan' seconds. So, if count
1260 is 100 and timespan is 3600, then there can be only 100 posts
1261 from a user every hour.
1262 timespan: see 'count'.
1269 biolimit: max character length of bio; 0 means no limit; null means to use
1270 the site text limit default.
1271 backup: whether users can backup their own profiles. Defaults to true.
1272 restore: whether users can restore their profiles from backup files. Defaults
1274 delete: whether users can delete their own accounts. Defaults to false.
1275 move: whether users can move their accounts to another server. Defaults
1281 Options with new users.
1283 default: nickname of a user account to automatically subscribe new
1284 users to. Typically this would be system account for e.g.
1285 service updates or announcements. Users are able to unsub
1286 if they want. Default is null; no auto subscribe.
1287 welcome: nickname of a user account that sends welcome messages to new
1288 users. Can be the same as 'default' account, although on
1289 busy servers it may be a good idea to keep that one just for
1290 'urgent' messages. Default is null; no message.
1292 If either of these special user accounts are specified, the users should
1293 be created before the configuration is updated.
1298 The software will, by default, send statistical snapshots about the
1299 local installation to a stats server on the status.net Web site. This
1300 data is used by the developers to prioritize development decisions. No
1301 identifying data about users or organizations is collected. The data
1302 is available to the public for review. Participating in this survey
1303 helps StatusNet developers take your needs into account when updating
1306 run: string indicating when to run the statistics. Values can be 'web'
1307 (run occasionally at Web time), 'cron' (run from a cron script),
1308 or 'never' (don't ever run). If you set it to 'cron', remember to
1309 schedule the script to run on a regular basis.
1310 frequency: if run value is 'web', how often to report statistics.
1311 Measured in Web hits; depends on how active your site is.
1312 Default is 10000 -- that is, one report every 10000 Web hits,
1314 reporturl: URL to post statistics to. Defaults to StatusNet developers'
1315 report system, but if they go evil or disappear you may
1316 need to update this to another value. Note: if you
1317 don't want to report stats, it's much better to
1318 set 'run' to 'never' than to set this value to something
1324 The software lets users upload files with their notices. You can configure
1325 the types of accepted files by mime types and a trio of quota options:
1326 per file, per user (total), per user per month.
1328 We suggest the use of the pecl file_info extension to handle mime type
1331 supported: an array of mime types you accept to store and distribute,
1332 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
1333 setup your server to properly recognize the types you want to
1335 uploads: false to disable uploading files with notices (true by default).
1336 filecommand: The required MIME_Type library may need to use the 'file'
1337 command. It tries the one in the Web server's path, but if
1338 you're having problems with uploads, try setting this to the
1339 correct value. Note: 'file' must accept '-b' and '-i' options.
1341 For quotas, be sure you've set the upload_max_filesize and post_max_size
1342 in php.ini to be large enough to handle your upload. In httpd.conf
1343 (if you're using apache), check that the LimitRequestBody directive isn't
1344 set too low (it's optional, so it may not be there at all).
1346 file_quota: maximum size for a single file upload in bytes. A user can send
1347 any amount of notices with attachments as long as each attachment
1348 is smaller than file_quota.
1349 user_quota: total size in bytes a user can store on this server. Each user
1350 can store any number of files as long as their total size does
1351 not exceed the user_quota.
1352 monthly_quota: total size permitted in the current month. This is the total
1353 size in bytes that a user can upload each month.
1354 dir: directory accessible to the Web process where uploads should go.
1355 Defaults to the 'file' subdirectory of the install directory, which
1356 should be writeable by the Web user.
1357 server: server name to use when creating URLs for uploaded files.
1358 Defaults to null, meaning to use the default Web server. Using
1359 a virtual server here can speed up Web performance.
1360 path: URL path, relative to the server, to find files. Defaults to
1361 main path + '/file/'.
1362 ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
1363 guess based on other SSL settings.
1364 filecommand: command to use for determining the type of a file. May be
1365 skipped if fileinfo extension is installed. Defaults to
1367 sslserver: if specified, this server will be used when creating HTTPS
1368 URLs. Otherwise, the site SSL server will be used, with /file/ path.
1369 sslpath: if this and the sslserver are specified, this path will be used
1370 when creating HTTPS URLs. Otherwise, the attachments|path value
1376 Options for group functionality.
1378 maxaliases: maximum number of aliases a group can have. Default 3. Set
1379 to 0 or less to prevent aliases in a group.
1380 desclimit: maximum number of characters to allow in group descriptions.
1381 null (default) means to use the site-wide text limits. 0
1387 oEmbed endpoint for multimedia attachments (links in posts).
1389 endpoint: oohembed endpoint using http://oohembed.com/ software.
1394 Some stuff for search.
1396 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1397 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1398 but requires the lame old MyISAM engine for MySQL. The latter
1399 will work with InnoDB but could be miserably slow on large
1400 systems. We'll probably add another type sometime in the future,
1401 with our own indexing system (maybe like MediaWiki's).
1408 handle: boolean. Whether we should register our own PHP session-handling
1409 code (using the database and memcache if enabled). Defaults to false.
1410 Setting this to true makes some sense on large or multi-server
1411 sites, but it probably won't hurt for smaller ones, either.
1412 debug: whether to output debugging info for session storage. Can help
1413 with weird session bugs, sometimes. Default false.
1418 Users can upload backgrounds for their pages; this section defines
1421 server: the server to use for background. Using a separate (even
1422 virtual) server for this can speed up load times. Default is
1423 null; same as site server.
1424 dir: directory to write backgrounds too. Default is '/background/'
1425 subdir of install dir.
1426 path: path to backgrounds. Default is sub-path of install path; note
1427 that you may need to change this if you change site-path too.
1428 sslserver: SSL server to use when page is HTTPS-encrypted. If
1429 unspecified, site ssl server and so on will be used.
1430 sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
1435 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1436 notify third-party servers of updates.
1438 notify: an array of URLs for ping endpoints. Default is the empty
1439 array (no notification).
1444 Default design (colors and background) for the site. Actual appearance
1445 depends on the theme. Null values mean to use the theme defaults.
1447 backgroundcolor: Hex color of the site background.
1448 contentcolor: Hex color of the content area background.
1449 sidebarcolor: Hex color of the sidebar background.
1450 textcolor: Hex color of all non-link text.
1451 linkcolor: Hex color of all links.
1452 backgroundimage: Image to use for the background.
1453 disposition: Flags for whether or not to tile the background image.
1458 Configuration options specific to notices.
1460 contentlimit: max length of the plain-text content of a notice.
1461 Default is null, meaning to use the site-wide text limit.
1467 Configuration options specific to messages.
1469 contentlimit: max length of the plain-text content of a message.
1470 Default is null, meaning to use the site-wide text limit.
1476 Configuration options for the login command.
1478 disabled: whether to enable this command. If enabled, users who send
1479 the text 'login' to the site through any channel will
1480 receive a link to login to the site automatically in return.
1481 Possibly useful for users who primarily use an XMPP or SMS
1482 interface and can't be bothered to remember their site
1483 password. Note that the security implications of this are
1484 pretty serious and have not been thoroughly tested. You
1485 should enable it only after you've convinced yourself that
1486 it is safe. Default is 'false'.
1491 If an installation has only one user, this can simplify a lot of the
1492 interface. It also makes the user's profile the root URL.
1494 enabled: Whether to run in "single user mode". Default false.
1495 nickname: nickname of the single user. If no nickname is specified,
1496 the site owner account will be used (if present).
1501 We put out a default robots.txt file to guide the processing of
1502 Web crawlers. See http://www.robotstxt.org/ for more information
1503 on the format of this file.
1505 crawldelay: if non-empty, this value is provided as the Crawl-Delay:
1506 for the robots.txt file. see http://ur1.ca/l5a0
1507 for more information. Default is zero, no explicit delay.
1508 disallow: Array of (virtual) directories to disallow. Default is 'main',
1509 'search', 'message', 'settings', 'admin'. Ignored when site
1510 is private, in which case the entire site ('/') is disallowed.
1515 Options for the Twitter-like API.
1517 realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
1518 for details). Some third-party tools like ping.fm want this to be
1519 'Identi.ca API', so set it to that if you want to. default = null,
1520 meaning 'something based on the site name'.
1525 We optionally put 'rel="nofollow"' on some links in some pages. The
1526 following configuration settings let you fine-tune how or when things
1527 are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
1528 information on what 'nofollow' means.
1530 subscribers: whether to nofollow links to subscribers on the profile
1531 and personal pages. Default is true.
1532 members: links to members on the group page. Default true.
1533 peopletag: links to people listed in the peopletag page. Default true.
1534 external: external links in notices. One of three values: 'sometimes',
1535 'always', 'never'. If 'sometimes', then external links are not
1536 nofollowed on profile, notice, and favorites page. Default is
1542 We use a router class for mapping URLs to code. This section controls
1543 how that router works.
1545 cache: whether to cache the router in memcache (or another caching
1546 mechanism). Defaults to true, but may be set to false for
1547 developers (who might be actively adding pages, so won't want the
1548 router cached) or others who see strange behavior. You're unlikely
1549 to need this unless you're a developer.
1554 Settings for the HTTP client.
1556 ssl_cafile: location of the CA file for SSL. If not set, won't verify
1557 SSL peers. Default unset.
1558 curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
1559 have the PHP curl extension installed for this to work.
1560 proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
1561 do any HTTP proxy stuff. Default unset.
1562 proxy_port: Port to use to connect to HTTP proxy host. Default null.
1563 proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
1564 proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
1565 proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
1570 default: associative array mapping plugin name to array of arguments. To disable
1571 a default plugin, unset its value in this array.
1572 locale_path: path for finding plugin locale files. In the plugin's directory
1574 server: Server to find static files for a plugin when the page is plain old HTTP.
1575 Defaults to site/server (same as pages). Use this to move plugin CSS and
1577 sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
1578 to site/server (same as pages). Use this to move plugin CSS and JS files
1580 path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
1581 each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
1582 if you're using a CDN.
1583 sslpath: Path to use on the SSL server. Same as plugins/path.
1588 Beginning with the 0.7.x branch, StatusNet has supported a simple but
1589 powerful plugin architecture. Important events in the code are named,
1590 like 'StartNoticeSave', and other software can register interest
1591 in those events. When the events happen, the other software is called
1592 and has a choice of accepting or rejecting the events.
1594 In the simplest case, you can add a function to config.php and use the
1595 Event::addHandler() function to hook an event:
1597 function AddGoogleLink($action)
1599 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1603 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1605 This adds a menu item to the end of the main navigation menu. You can
1606 see the list of existing events, and parameters that handlers must
1607 implement, in EVENTS.txt.
1609 The Plugin class in lib/plugin.php makes it easier to write more
1610 complex plugins. Sub-classes can just create methods named
1611 'onEventName', where 'EventName' is the name of the event (case
1612 matters!). These methods will be automatically registered as event
1613 handlers by the Plugin constructor (which you must call from your own
1614 class's constructor).
1616 Several example plugins are included in the plugins/ directory. You
1617 can enable a plugin with the following line in config.php:
1619 addPlugin('Example', array('param1' => 'value1',
1620 'param2' => 'value2'));
1622 This will look for and load files named 'ExamplePlugin.php' or
1623 'Example/ExamplePlugin.php' either in the plugins/ directory (for
1624 plugins that ship with StatusNet) or in the local/ directory (for
1625 plugins you write yourself or that you get from somewhere else) or
1628 Plugins are documented in their own directories.
1633 The primary output for StatusNet is syslog, unless you configured a
1634 separate logfile. This is probably the first place to look if you're
1635 getting weird behaviour from StatusNet.
1637 If you're tracking the unstable version of StatusNet in the git
1638 repository (see below), and you get a compilation error ("unexpected
1639 T_STRING") in the browser, check to see that you don't have any
1640 conflicts in your code.
1642 If you upgraded to StatusNet 0.9.x without reading the "Notice
1643 inboxes" section above, and all your users' 'Personal' tabs are empty,
1644 read the "Notice inboxes" section above.
1649 These are some myths you may see on the Web about StatusNet.
1650 Documentation from the core team about StatusNet has been pretty
1651 sparse, so some backtracking and guesswork resulted in some incorrect
1654 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1655 extremely bad idea. It's a tool built into DB_DataObject that will
1656 emit oodles of print lines directly to the browser of your users.
1657 Among these lines will be your database username and password. Do
1658 not enable this option on a production Web site for any reason.
1660 - "Edit dataobject.ini with the following settings..." dataobject.ini
1661 is a development file for the DB_DataObject framework and is not
1662 used by the running software. It was removed from the StatusNet
1663 distribution because its presence was confusing. Do not bother
1664 configuring dataobject.ini, and do not put your database username
1665 and password into the file on a production Web server; unscrupulous
1666 persons may try to read it to get your passwords.
1671 If you're adventurous or impatient, you may want to install the
1672 development version of StatusNet. To get it, use the git version
1673 control tool <http://git-scm.com/> like so:
1675 git clone git@gitorious.org:statusnet/mainline.git
1677 This is the version of the software that runs on Identi.ca and the
1678 status.net hosted service. Using it is a mixed bag. On the positive
1679 side, it usually includes the latest security and bug fix patches. On
1680 the downside, it may also include changes that require admin
1681 intervention (like running a script or even raw SQL!) that may not be
1682 documented yet. It may be a good idea to test this version before
1683 installing it on your production machines.
1685 To keep it up-to-date, use 'git pull'. Watch for conflicts!
1690 There are several ways to get more information about StatusNet.
1692 * There is a mailing list for StatusNet developers and admins at
1693 http://mail.status.net/mailman/listinfo/statusnet-dev
1694 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
1695 * The StatusNet wiki, http://status.net/wiki/
1696 * The StatusNet blog, http://status.net/blog/
1697 * The StatusNet status update, <http://status.status.net/> (!)
1702 * Microblogging messages to http://support.status.net/ are very welcome.
1703 * The microblogging group http://identi.ca/group/statusnet is a good
1704 place to discuss the software.
1705 * StatusNet has a bug tracker for any defects you may find, or ideas for
1706 making things better. http://status.net/bugs
1711 The following is an incomplete list of developers who've worked on
1712 StatusNet. Apologies for any oversight; please let evan@status.net know
1713 if anyone's been overlooked in error.
1715 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1716 * Zach Copley, StatusNet, Inc.
1717 * Earle Martin, StatusNet, Inc.
1718 * Marie-Claude Doyon, designer, StatusNet, Inc.
1719 * Sarven Capadisli, StatusNet, Inc.
1720 * Robin Millette, StatusNet, Inc.
1731 * Tryggvi Björgvinsson
1735 * Ken Sheppardson (Trac server, man-about-town)
1736 * Tiago 'gouki' Faria (i18n manager)
1738 * Leslie Michael Orchard
1742 * Tobias Diekershoff
1753 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
1754 * Brion Vibber, StatusNet, Inc.
1755 * James Walker, StatusNet, Inc.
1756 * Samantha Doherty, designer, StatusNet, Inc.
1758 Thanks also to the developers of our upstream library code and to the
1759 thousands of people who have tried out Identi.ca, installed StatusNet,
1760 told their friends, and built the Open Microblogging network to what